Skip to content

Commit

Permalink
add comment about persisting sidebar state (fix #390) (#733)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesscottbrown authored Jan 6, 2025
1 parent 05adc37 commit cd5dc5e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion packages/ui/src/lib/sidebar/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
/**
* The `<Sidebar>` component renders a sidebar that is typically used to display controls and textual explanation.
*
* It should generally be used inside an [AppShell](.//?path=/docs/app-appshell--documentation)
* It should generally be used inside an [AppShell](.//?path=/docs/app-appshell--documentation).
*
* Note that when the sidebar is collapsed, it is removed by the `AppShell` (rather than merely being hidden).
* Any state that should be restored when it is re-opened should be persisted in a Svelte Store.
*
* @component
*/
Expand Down

0 comments on commit cd5dc5e

Please sign in to comment.