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

add comment about persisting sidebar state (fix #390) #733

Merged
merged 1 commit into from
Jan 6, 2025
Merged

add comment about persisting sidebar state (fix #390) #733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion packages/ui/src/lib/sidebar/Sidebar.svelte
View file
Open in desktop
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
Loading