Skip to content

Commit f4e78c0

Browse files
committed
Clarify 'always on' sidebar by default in. Closes #165
1 parent b56b789 commit f4e78c0

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/content/components/sidebar.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description = "Responsive admin dashboard layout with sticky sidebar, optional t
55
+++
66

77
- Use `data-sidebar-layout` on a container (typically `<body>`) with `<aside data-sidebar>` for the sidebar and `<main>` for content. The sidebar stays sticky while the main content scrolls.
8-
- On mobile, the sidebar becomes a slide-out overlay toggled by a `[data-sidebar-toggle]` button. To make the sidebar collapsible at all widths, set `data-sidebar-layout="always"`.
8+
- On mobile, the sidebar becomes a slide-out overlay toggled by a `[data-sidebar-toggle]` button. To show the toggle and make it collapse the sidebar at all widths, set `data-sidebar-layout="always"`.
99
- Set the `--sidebar-width` variable to adjust its width globally.
1010

1111
<div class="sidebar-example">
@@ -43,7 +43,7 @@ description = "Responsive admin dashboard layout with sticky sidebar, optional t
4343

4444
### Always-collapsible
4545

46-
Set `data-sidebar-layout="always"` to keep the toggle visible on all screen sizes.
46+
Set `data-sidebar-layout="always"` to keep the toggle visible and make it collapse the sidebar on all screen sizes.
4747

4848
```html
4949
<body data-sidebar-layout="always">
@@ -76,11 +76,11 @@ Add `data-topnav` to a header element for a full-width top navigation bar. The s
7676

7777
#### Structure
7878

79-
| Attribute | Element | |
80-
| --------------------- | ---------- | -------------------------------------------------------- |
81-
| `data-sidebar-layout` | Container | Grid layout wrapper (sidebar + main), typically `<body>` |
82-
| `data-sidebar-layout="always"` | Container | Always-collapsible sidebar (toggle visible on screen sizes) |
83-
| `data-topnav` | `<header>` | Full-width top nav (optional, spans full width) |
84-
| `data-sidebar` | `<aside>` | Sticky sidebar element |
85-
| `data-sidebar-toggle` | `<button>` | Toggles sidebar (mobile) and collapse (always mode) |
86-
| `data-sidebar-open` | Layout | Applied to layout when sidebar is open |
79+
| Attribute | Element | |
80+
| ------------------------------ | ---------- | ------------------------------------------------------------------------------ |
81+
| `data-sidebar-layout` | Container | Grid layout wrapper (sidebar + main), typically `<body>` |
82+
| `data-sidebar-layout="always"` | Container | Always-collapsible sidebar (toggle visible and functional on all screen sizes) |
83+
| `data-topnav` | `<header>` | Full-width top nav (optional, spans full width) |
84+
| `data-sidebar` | `<aside>` | Sticky sidebar element |
85+
| `data-sidebar-toggle` | `<button>` | Toggles sidebar (mobile) and collapse (always mode) |
86+
| `data-sidebar-open` | Layout | Applied to layout when sidebar is open |

0 commit comments

Comments
 (0)