Skip to content

Commit

Permalink
@grafana/ui: Buttons documentation (#23144)
Browse files Browse the repository at this point in the history
* Add info: when to use which and how to mix buttons

* Update description for Button.mdx

- add note about scenario without primary action
- add note about secondary button being the default

* Refine docs info for secondary and destructive

Co-authored-by: Tobias Skarhed <tobias.skarhed@gmail.com>
  • Loading branch information
jessover9000 and tskarhed committed May 14, 2020
1 parent e323f7b commit 54a9016
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions packages/grafana-ui/src/components/Button/Button.mdx
Expand Up @@ -7,7 +7,9 @@ import { Button } from './Button';

## Primary

Used for "call to action".
Used for "call to action", i.e. triggering the main action. There should never be more than one on a page. If you need multiple buttons for different actions, decide which action is the most important and make that the primary `Button`. All other `Button` components should be secondary.

If there is no primary action, all `Button` components should be secondary.

<Preview>
<div>
Expand All @@ -25,7 +27,10 @@ Used for "call to action".

## Secondary

The secondary button, used for "cancel" or aborting.
The secondary `Button` is the default button style and can trigger various actions. How it is used depends on its surroundings:

1. When next to the primary `Button`, the Secondary style can for example be used for "Cancel" or "Abort" actions.
2. When there is no main important action on a given page, all `Button` components should use the secondary style.

<Preview>
<div>
Expand All @@ -43,7 +48,7 @@ The secondary button, used for "cancel" or aborting.

## Destructive

Used for removing or deleting entities.
Used for triggering a removing or deleting action. Because of its dominant coloring, it should be used sparingly. If you need multiple Destructive `Button` components in one view, we recommend using a secondary `Button` or Link variant instead and only use the Destructive variant to double confirm.

<Preview>
<div>
Expand Down

0 comments on commit 54a9016

Please sign in to comment.