diff --git a/packages/web/src/scss/components/Drawer/README.md b/packages/web/src/scss/components/Drawer/README.md new file mode 100644 index 0000000000..0d52d3e255 --- /dev/null +++ b/packages/web/src/scss/components/Drawer/README.md @@ -0,0 +1,87 @@ +# Drawer + +The Drawer component is a container that slides in from side of the screen. It can be used to display additional content or actions that are not part of the main view. + +The Drawer is a composition of several subcomponents: + +- [Drawer](#drawer) + - [DrawerCloseButton](#drawerclosebutton) + - [DrawerPanel](#drawerpanel) + +👉 The animation effect of this component is dependent on the +`prefers-reduced-motion` media query. + +## Drawer + +```html + +``` + +### Alignment + +The `Drawer` component allows aligning the content panel horizontally to the left or right side of the screen using `--left` or `--right` modifier. The default alignment of the drawer content panel is to the right. + +```html + +``` + +## DrawerCloseButton + +The `DrawerCloseButton` component is a button that closes the drawer when clicked. + +```html + +``` + +## DrawerPanel + +The `DrawerPanel` component is a container for the content that will be displayed in the drawer. + +```html +