Skip to content

Commit

Permalink
add more detail to buttondismiss
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-at-jobber committed Nov 29, 2024
1 parent e36561e commit 64711d7
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs/components/ButtonDismiss/ButtonDismiss.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,23 @@ import { Meta } from "@storybook/addon-docs";
<Meta title="Components/Private/ButtonDismiss" />

This private component is used as a dismissal button for public components, such
as the modal component for example.
as Modal and Popover.

## Design & usage guidelines

When contributing to, or consuming the ButtonDismiss component, consider the
following:
Use ButtonDismiss when you need a dismiss or close action that matches the design
patterns of Atlantis.

- When using the ButtonDismiss component always consider it is used as a dismiss
action.
- The ButtonDismiss component should never be used inside another component.
## Related components

ButtonDismiss is built with [Button](../?path=/docs/components-actions-button--docs).

## Accessibility

ButtonDismiss is an icon-only button, so you must provide an aria-label that describes
its' function to assistive technology.

| **✅ Do** | **❌ Don't** |
| --------------- | ---------------- |
| "Close modal" | "X button" |
| "Close popover" | "text-btn-cross" |

0 comments on commit 64711d7

Please sign in to comment.