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

Components: update Button readme to add design guidelines #14194

Merged
merged 2 commits into from
Mar 13, 2019
Merged
Changes from 1 commit
Commits
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
123 changes: 110 additions & 13 deletions packages/components/src/button/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,126 @@
# Button
Buttons let users take actions and make choices with a single click or tap.

Buttons express what action will occur when the user clicks or taps it. Buttons are used to trigger an action, and they can be used for any type of action, including navigation.
![Button components](https://make.wordpress.org/design/files/2019/03/button.png)

The presence of a `href` prop determines whether an `anchor` element is rendered instead of a `button`.
## Table of contents

1. [Design guidelines](http://#design-guidelines)
kjellr marked this conversation as resolved.
Show resolved Hide resolved
2. [Development guidelines](http://#development-guidelines)
kjellr marked this conversation as resolved.
Show resolved Hide resolved
3. [Related components](http://#related-components)
kjellr marked this conversation as resolved.
Show resolved Hide resolved

## Design guidelines

### Usage

Buttons tell users what actions they can take and give them a way to interact with the interface. You’ll find them throughout a UI, particularly in places like:

- Modals
- Forms
- Toolbars

### Best practices
Copy link
Contributor

Choose a reason for hiding this comment

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

Just noting that this information is here too, not sure if it's a problem that they're duplicated.

https://wordpress.org/gutenberg/handbook/designers-developers/developers/components/button-group/#best-practices

Copy link
Contributor

Choose a reason for hiding this comment

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

That link is for a different component, a ButtonGroup. It shares similarities with many of the rules here, but it's a bit different.


Buttons should:

- **Be clearly and accurately labeled.**
- **Clearly communicate that clicking or tapping will trigger an action.**
- **Use established colors appropriately.** For example, only use red buttons for actions that are difficult or impossible to undo.
- **Prioritize the most important actions.** This helps users focus. Too many calls to action on one screen can be confusing, making users unsure what to do next.
- **Have consistent locations in the interface.**

### Content guidelines

Buttons should be clear and predictable—users should be able to anticipate what will happen when they click a button. Never deceive a user by mislabeling a button.

Buttons text should lead with a strong verb that encourages action, and add a noun that clarifies what will actually change. The only exceptions are common actions like Save, Close, Cancel, or OK. Otherwise, use the {verb}+{noun} format to ensure that your button gives the user enough information.

Button text should also be quickly scannable — avoid unnecessary words and articles like the, an, or a.

### Types

#### Link button

Link buttons have low emphasis. They don’t stand out much on the page, so they’re used for less-important actions. What’s less important can vary based on context, but it’s usually a supplementary action to the main action we want someone to take. Link buttons are also useful when you don’t want to distract from the content.

![Link button](https://make.wordpress.org/design/files/2019/03/link-button.png)

#### Default button

Default buttons have medium emphasis. The button appearance helps differentiate them from the page background, so they’re useful when you want more emphasis than a link button offers.

![Default button](https://make.wordpress.org/design/files/2019/03/default-button.png)

#### Primary button

Primary buttons have high emphasis. Their color fill and shadow means they pop off the background.

Since a high-emphasis button commands the most attention, a layout should contain a single primary button. This makes it clear that other buttons have less importance and helps users understand when an action requires their attention.

Note that this component may sometimes be confused with the Button block, which has semantically different use cases and functionality.
![Primary button](https://make.wordpress.org/design/files/2019/03/primary-button.png)

## Usage
#### Text label

All button types use text labels to describe the action that happens when a user taps a button. If there’s no text label, there should be an icon to signify what the button does (e.g. an IconButton component).

![](https://make.wordpress.org/design/files/2019/03/do-link-button.png)

**Do**
Use color to distinguish link button labels from other text.

![](https://make.wordpress.org/design/files/2019/03/dont-wrap-button-text.png)

**Don’t**
Don’t wrap button text. For maximum legibility, keep text labels on a single line.

### Hierarchy

![A layout with a single prominent button](https://make.wordpress.org/design/files/2019/03/button.png)

A layout should contain a single prominently-located button. If multiple buttons are required, a single high-emphasis button can be joined by medium- and low-emphasis buttons mapped to less-important actions. When using multiple buttons, make sure the available state of one button doesn’t look like the disabled state of another.

![A diagram showing high emphasis at the top, medium emphasis in the middle, and low emphasis at the bottom](https://make.wordpress.org/design/files/2019/03/button-hierarchy.png)

A button’s level of emphasis helps determine its appearance, typography, and placement.

#### Placement

Use button types to express different emphasis levels for all the actions a user can perform.

![A link, default, and primary button](https://make.wordpress.org/design/files/2019/03/button-layout.png)

This screen layout uses:

1. A primary button for high emphasis.
2. A default button for medium emphasis.
3. A link button for low emphasis.

Placement best practices:

- **Do**: When using multiple buttons in a row, show users which action is more important by placing it next to a button with a lower emphasis (e.g. a primary button next to a default button, or a default button next to a link button).
- **Don’t**: Don’t place two primary buttons next to one another — they compete for focus. Only use one primary button per view.
- **Don’t**: Don’t place a button below another button if there is space to place them side by side.
- **Caution**: Avoid using too many buttons on a single page. When designing pages in the app or website, think about the most important actions for users to take. Too many calls to action can cause confusion and make users unsure what to do next — we always want users to feel confident and capable.

## Development guidelines

### Usage

Renders a button with default style.

{% codetabs %}
{% ESNext %}
```jsx
import { Button } from "@wordpress/components";

const MyButton = () => (
<Button isDefault>
Click me!
</Button>

Click me!
Copy link
Contributor

Choose a reason for hiding this comment

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

why was <Button> ... </Button> removed? Should it be left in for proper react component usage?

Copy link
Contributor

Choose a reason for hiding this comment

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

Whoops. Thanks for noticing that! I've opened #14964 to restore them.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good! Thanks for the speedy response.


);
```
{% end %}

## Props
### Props

The presence of a `href` prop determines whether an `anchor` element is rendered instead of a `button`.

Name | Type | Default | Description
--- | --- | --- | ---
Expand All @@ -39,5 +136,5 @@ Name | Type | Default | Description

## Related components

* To group buttons together, use the `ButtonGroup` component.
* To display an icon inside the button, use the `IconButton` component.
- To group buttons together, use the `ButtonGroup` component.
- To display an icon inside the button, use the `IconButton` component.