Mixins / foldkit-mixins-ui

SidebarView

interface · packages/mixins-ui/src/sidebar.ts:49

interface SidebarView<Message> {
  readonly id: string
  readonly label: string
  readonly sections: ReadonlyArray<SidebarSection>
  readonly open: ReadonlyArray<string>
  readonly onToggleSection: (id: string) => NoInfer<Message>
  readonly collapsed: boolean
  readonly onToggleCollapsed: NoInfer<Message>
  readonly style?: NamedStyle<typeof SidebarSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

SidebarView.id

property · packages/mixins-ui/src/sidebar.ts:51

readonly id: string

Prefixes every id the sidebar draws, unique on the page.

SidebarView.label

property · packages/mixins-ui/src/sidebar.ts:53

readonly label: string

The navigation landmark's name.

SidebarView.sections

property · packages/mixins-ui/src/sidebar.ts:54

readonly sections: ReadonlyArray<SidebarSection>

SidebarView.open

property · packages/mixins-ui/src/sidebar.ts:56

readonly open: ReadonlyArray<string>

The ids of the open sections.

SidebarView.onToggleSection

property · packages/mixins-ui/src/sidebar.ts:57

readonly onToggleSection: (id: string) => NoInfer<Message>

SidebarView.collapsed

property · packages/mixins-ui/src/sidebar.ts:58

readonly collapsed: boolean

SidebarView.onToggleCollapsed

property · packages/mixins-ui/src/sidebar.ts:59

readonly onToggleCollapsed: NoInfer<Message>

SidebarView.style

property · packages/mixins-ui/src/sidebar.ts:61

readonly style?: NamedStyle<typeof SidebarSlots> | undefined

A style of SidebarSlots, for the sidebar's look.

SidebarView.mixins

property · packages/mixins-ui/src/sidebar.ts:63

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.