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.

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

Update drawer site docs #4014

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Update drawer site docs #4014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1937f3c
Update drawer site docs
joshwooding Aug 20, 2024
a11b2fa
Update site/docs/components/drawer/usage.mdx
joshwooding Aug 20, 2024
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
2 changes: 1 addition & 1 deletion site/docs/components/drawer/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ data:
package:
name: "@salt-ds/core"
initialVersion: "1.19.0"
alsoKnownAs: ["Flyout", "Sheet", "Side panel"]
alsoKnownAs: ["Flyout", "Sheet"]
relatedComponents:
[
{ name: "Overlay", relationship: "similarTo" },
Expand Down
6 changes: 5 additions & 1 deletion site/docs/components/drawer/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ data:

## Using the component

Drawers are always modal. When open, the drawer displays a visual overlay, a [scrim](/salt/components/scrim) component, over the underlying content.
Drawers cover the entire height of the viewport and are always modal. This means that the content behind them is inert and can't be interacted with. A [`Scrim`](../scrim) is used to visually obscure the content behind the drawer.

Always set a logical width suitable for the content inside the drawer. Refer to Salt's [Forms](/salt/patterns/forms) pattern for information on logical forms width, and the [typography foundation](/salt/foundations/typography) for guidance on paragraph text width.

Expand Down Expand Up @@ -42,3 +42,7 @@ import { Drawer, DrawerCloseButton } from "@salt-ds/core";
### `DrawerCloseButton`

<PropsTable packageName="core" componentName="DrawerCloseButton" />

## References

- [Dialog (Modal) Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/)
Loading