Skip to content

ActionButton documentation#275

Merged
ross-pfahler merged 5 commits into
masterfrom
actionbutton-docs
Mar 17, 2020
Merged

ActionButton documentation#275
ross-pfahler merged 5 commits into
masterfrom
actionbutton-docs

Conversation

@ross-pfahler
Copy link
Copy Markdown
Collaborator

Closes RSP-1601

✅ Pull Request Checklist:

  • Included link to corresponding Issue.
  • Added/updated unit tests and storybook for this change (for new code or code which already has tests).
  • Filled out test instructions.
  • Updated documentation (if it already exists for this component).
  • Looked at the Accessibility Practices for this feature - Aria Practices

📝 Test Instructions:

🧢 Your Team:

@adobe-bot
Copy link
Copy Markdown

Build successful! 🎉

Copy link
Copy Markdown
Member

@LFDanLu LFDanLu left a comment

Choose a reason for hiding this comment

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

just some small changes but otherwise looks good

Comment on lines +42 to +50
/** An icon to display in the ActionButton */
icon?: ReactElement,
/** Whether the ActionButton should be displayed with a [quiet style](https://spectrum.adobe.com/page/action-button/#Quiet) */
isQuiet?: boolean,
/** Whether the ActionButton should be displayed with a [selected state](https://spectrum.adobe.com/page/action-button/#Selected) */
isSelected?: boolean,
/** Whether the ActionButton should be displayed with a [emphasized style](https://spectrum.adobe.com/page/action-button/#Emphasis) */
isEmphasized?: boolean,
/** Whether the ActionButton should be displayed with a [hold icon](https://spectrum.adobe.com/page/action-button/#Hold-icon) */
Copy link
Copy Markdown
Member

@LFDanLu LFDanLu Mar 13, 2020

Choose a reason for hiding this comment

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

Missing periods at the end of these descriptions.
I personally like how you added the links to the spectrum docs in the prop types themselves, should we do this for the same types in other component docs? Open to discussion, we should decide as a group to stay consistent

Comment thread packages/@react-spectrum/button/docs/ActionButton.mdx Outdated
@adobe-bot
Copy link
Copy Markdown

Build successful! 🎉

Copy link
Copy Markdown
Member

@LFDanLu LFDanLu left a comment

Choose a reason for hiding this comment

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

LGTM

@adobe-bot
Copy link
Copy Markdown

Build successful! 🎉

@adobe-bot
Copy link
Copy Markdown

Build successful! 🎉

@ross-pfahler ross-pfahler merged commit bc7202b into master Mar 17, 2020
@ross-pfahler ross-pfahler deleted the actionbutton-docs branch March 17, 2020 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants