Skip to content

add "offset" prop to combobox and update doc #1452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

qyiming
Copy link
Contributor

@qyiming qyiming commented Jul 11, 2018

Fixes #1451

Additional description

Same as menu-dropdown and any other component that uses dialog component, I would like to pass an "offset" prop down to dialog. This fix is needed to fix an SFX internal bug related to combobox.

CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

  • First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
  • npm run lint:fix has been run and linting passes.
  • Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

  • TravisCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.
  • Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
  • Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
  • Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
  • While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

@qyiming
Copy link
Contributor Author

qyiming commented Jul 11, 2018

The new "offset" is passed down to and handled by the dialog cmp, seems unnecessary to add a new test for it.

also re-generated the component doc for this change.

@interactivellama please review and I will at mention you on the internal duplicate bug. Thanks.

@interactivellama
Copy link
Contributor

The offset prop is kind of a hack i dropdown. I'll follow up offline to see if there's an alternative way.

@@ -189,6 +189,7 @@ const propTypes = {
multiple: PropTypes.bool,
/**
* Offset adds pixels to the absolutely positioned dropdown menu in the format: ([vertical]px [horizontal]px).
* This is an undocumented prop and its usage is discouraged.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please completely remove propType and place this comment in the source code above the line passing it into Dialog component.

@interactivellama
Copy link
Contributor

Closing. Will re-open if #1454 doesn't work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow Combobox menu to flip if it overflows its parent
2 participants