context.svelte
Documentation / lib/components/ui/sidebar/context.svelte
SidebarStateProps​
type SidebarStateProps = object;
Defined in: web-app/src/lib/components/ui/sidebar/context.svelte.ts:8
Properties​
open​
open: Getter<boolean>;
Defined in: web-app/src/lib/components/ui/sidebar/context.svelte.ts:14
A getter function that returns the current open state of the sidebar.
We use a getter function here to support bind:open on the Sidebar.Provider
component.
setOpen()​
setOpen: (open: boolean) => void;
Defined in: web-app/src/lib/components/ui/sidebar/context.svelte.ts:21
A function that sets the open state of the sidebar. To support bind:open, we need
a source of truth for changing the open state to ensure it will be synced throughout
the sub-components and any bind: references.
Parameters​
| Parameter | Type |
|---|---|
|
|
Returns​
void
setSidebar()​
function setSidebar(props: SidebarStateProps): SidebarState;
Defined in: web-app/src/lib/components/ui/sidebar/context.svelte.ts:71
Instantiates a new SidebarState instance and sets it in the context.
Parameters​
| Parameter | Type | Description |
|---|---|---|
| The constructor props for the |
Returns​
SidebarState
The SidebarState instance.
useSidebar()​
function useSidebar(): SidebarState;
Defined in: web-app/src/lib/components/ui/sidebar/context.svelte.ts:80
Retrieves the SidebarState instance from the context. This is a class instance,
so you cannot destructure it.
Returns​
SidebarState
The SidebarState instance.