Create ConfirmButton.mdx (#26113)

add docs to ConfirmButton element
This commit is contained in:
Jess 2020-07-08 17:29:33 +02:00 committed by GitHub
parent ea33668014
commit f242840275
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,11 @@
<Meta title="MDX|ConfirmButton" component={ConfirmButton} />
# ConfirmButton
The ConfirmButton is an interactive component that adds a double-confirm option to a clickable action. When clicked, the action is replaced by an inline confirmation with the option to cancel. In Grafana, this is used for example for editing values in settings tables.
## Variants
There are four variants of the `ConfirmButton`: primary, secondary, destructive, and link. The primary and secondary variants include a primary or secondary `Button` component. The primary and secondary variant should be used to confirm actions like saving or adding data. The destructive variant includes a destructive `Button` component. The destructive variant should be used to double-confirm a deletion or removal of an element. The link variant doesn't include any button and double-confirms as links instead.
Apart from the button variant, you can also modify the button size and the button text.