Skip to content
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

Add Field level tooltip to Combobox / Deprecate Input assistiveText.fieldLevelHelpButton #1689

Merged

Conversation

davidlygagnon
Copy link
Contributor

@davidlygagnon davidlygagnon commented Dec 14, 2018

Fixes #1681

Additional description

  • Adding fieldLevelHelpTooltip to combobox component. Inspired by fieldLevelHelpTooltip prop on input component :)

Work by @interactivellama

  • Deprecate Input’s assistiveText.fieldLevelHelpButton prop and add a checkProp warning to use fieldLevelHelpTooltip's assistiveText.triggerLearnMoreIcon.
  • Centralizes the default Tooltip props into it’s own module, so that code can be re-used across Combobox and Input.
  • Combobox/Input: Use Tooltip's learnMore variant
  • Documents triggerStyle: { position: 'static' } usage and removes overflowBoundaryElement from example
  • Remove default for Input’s assistiveText.fieldLevelHelpButton so that Tooltip has the default “Help” text and not the Input component. Having defaults in two locations causing problems when merging objects, since defaults mean that default props are defined.
  • Revert to use of ButtonIcon within a Button component in order to make the info icon slightly smaller due to the removal of a span tag that wraps <Button><Icon/></Button but not if Button's icon props are used.

Console warning
screen shot 2019-01-04 at 3 29 22 pm

screen shot 2018-12-13 at 10 50 14 pm


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.
Required only if there are markup / UX changes
  • 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.

@davidlygagnon davidlygagnon self-assigned this Dec 14, 2018
@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 December 14, 2018 06:57 Inactive
@hajiz
Copy link
Contributor

hajiz commented Jan 3, 2019

Hi @interactivellama , what is the latest status on this PR? Any plan to merge this in? Thanks.

Please let me know if any work is required before this PR can be submitted.

@interactivellama
Copy link
Contributor

@hajiz No, it's just been the Christmas/New Year holiday delay. I took a quick glance. I think I can merge this into master tomorrow.

@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 January 4, 2019 21:35 Inactive
@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 January 4, 2019 22:44 Inactive
@interactivellama interactivellama added this to In progress in 2018-12 (December) via automation Jan 4, 2019
@interactivellama interactivellama changed the title Field level tooltip to combobox Add Field level tooltip to Combobox Jan 4, 2019
@interactivellama interactivellama changed the title Add Field level tooltip to Combobox Add Field level tooltip to Combobox / Deprecate Input assistiveText.fieldLevelHelpButton Jan 4, 2019
@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 January 5, 2019 07:27 Inactive
@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 January 5, 2019 07:46 Inactive
@interactivellama interactivellama temporarily deployed to design-system-react-co-pr-1689 January 5, 2019 07:52 Inactive
* Deprecate Input’s `assistiveText.fieldLevelHelpButton` prop and add a checkProp warning to use fieldLevelHelpTooltip.
* Centralizes the default Tooltip props into it’s own module, so that code can be re-used across Combobox and Input.
* Combobox/Tooltip: Use learnMore variant and remove custom Button/children props
* Documents triggerStyle: { position: 'static' } usage and removes overflowBoundaryElement from example
* Remove default for Input’s assistiveText.fieldLevelHelpButton so that Tooltip has the default “Help” text and not the Input component. Having defaults in two locations causing problems when merging objects.
* Adds removeUndefined helper function
@interactivellama
Copy link
Contributor

@hajiz It is now merged. Would you like a release next week?

@hajiz
Copy link
Contributor

hajiz commented Jan 7, 2019

Hi @interactivellama , thanks for merging the PR. We would ultimately love to have a release, but please let me figure out some dependencies and will get back to you shortly.

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

Successfully merging this pull request may close these issues.

Add fieldLevelHelpTooltip prop on combobox
3 participants