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

chore(docs): update dropdown docs #6710

Merged

Conversation

tw15egan
Copy link
Collaborator

@tw15egan tw15egan commented Aug 21, 2020

Closes #6709

Updates Dropdown to new CSF format and adds in prop documentation

Done

  • Update to CSF
  • Create Dropdown.mdx and fill out with template
  • Document any discrepancies for v11

Changelog

New

Removed

  • inline was listed in PropTypes but didn't seem to do anything. We use type="inline to render the inline variant

Questions for v11

  • titleText should probably be changed to something closer to labelText
  • label refers to the placeholder text before you make a selection, might be better to use placeholder
  • I've gone ahead and deprecated the inline prop, as it was not doing anything.

Testing / Reviewing

Check updated docs for grammar usage and that the examples look correct

@netlify
Copy link

netlify bot commented Aug 21, 2020

Deploy preview for carbon-elements ready!

Built with commit 06688da

https://deploy-preview-6710--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Aug 21, 2020

Deploy preview for carbon-components-react ready!

Built with commit 06688da

https://deploy-preview-6710--carbon-components-react.netlify.app

@tw15egan tw15egan force-pushed the docs/update-dropdown-docs branch from ed2b49d to ebecda5 Compare August 21, 2020 19:33
@tw15egan tw15egan force-pushed the docs/update-dropdown-docs branch from ebecda5 to 850e6f6 Compare August 25, 2020 20:00
@tw15egan tw15egan marked this pull request as ready for review August 25, 2020 20:45
@tw15egan tw15egan requested review from a team as code owners August 25, 2020 20:45
@tw15egan tw15egan requested review from joshblack and emyarod August 25, 2020 20:45
@tw15egan tw15egan changed the title chore(docs): begin dropdown docs work chore(docs): update dropdown docs Aug 25, 2020
Copy link
Member

@emyarod emyarod left a comment

Choose a reason for hiding this comment

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

looks good to me

@kodiakhq kodiakhq bot merged commit ff96a17 into carbon-design-system:master Aug 26, 2020
@tw15egan tw15egan deleted the docs/update-dropdown-docs branch April 28, 2021 18:16
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.

Update docs for Dropdown
3 participants