Skip to content

Adds basic documentation for the ToolbarButton component. #23909

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Jul 14, 2020
Merged

Adds basic documentation for the ToolbarButton component. #23909

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a92b509
Adds basic documentation for the ToolbarButton component.
mateuswetah Jul 13, 2020
9d84af4
Updates compiled version of docs with ToolbarButton docs.
mateuswetah Jul 13, 2020
381e18a
Update packages/components/src/toolbar-button/README.md
mateuswetah Jul 14, 2020
f5bccad
Fixes typo 'control do select' on ToolbarButton documentation.
mateuswetah Jul 14, 2020
ba3762c
Update packages/components/src/toolbar-button/README.md
mateuswetah Jul 14, 2020
a659fd5
Update packages/components/src/toolbar-button/README.md
mateuswetah Jul 14, 2020
c95452b
Update packages/components/src/toolbar-button/README.md
mateuswetah Jul 14, 2020
8347d9f
Update packages/components/src/toolbar-button/README.md
mateuswetah Jul 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update packages/components/src/toolbar-button/README.md 
Elaborates more on ToolbarComponent information, mentioning its accessibility features.

Co-authored-by: Daniel Richards <daniel.p.richards@gmail.com>
  • Loading branch information
@mateuswetah @talldan
mateuswetah and talldan authored Jul 14, 2020
commit 381e18a004896b394cc1ed92f1a20b8232dfbecf
4 changes: 2 additions & 2 deletions packages/components/src/toolbar-button/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ToolbarButton

A ToolbarButton can be used to add actions to your block control, usually inside a ToolbarGroup. It has the same features of the [Button](https://developer.wordpress.org/block-editor/components/button/) component, only its style is more appropriate for a Toolbar.
A ToolbarButton can be used to add actions to your block control, usually inside a ToolbarGroup. It has similar features to the [Button](https://developer.wordpress.org/block-editor/components/button/) component. Using `ToolbarButton` will ensure the correct styling for a button in a toolbar, and also that keyboard interactions in a toolbar are consistent with the [WAI ARIA toolbar pattern](https://www.w3.org/TR/wai-aria-practices/#toolbar).

## Usage

Expand All @@ -23,4 +23,4 @@ This component accepts [the same API of the Button](https://developer.wordpress.
## Related components

* If you wish to implement a control do select options grouped as icon buttons you can use the [Toolbar](https://developer.wordpress.org/block-editor/components/toolbar/) component, which already handles this strategy.
* The ToolbarButton may be used with other elements such as [Dropdown](https://developer.wordpress.org/block-editor/components/dropdown/) to display options in a popover.
* The ToolbarButton may be used with other elements such as [Dropdown](https://developer.wordpress.org/block-editor/components/dropdown/) to display options in a popover.