Mixins / foldkit-mixins-ui

NavView

interface · packages/mixins-ui/src/nav.ts:363

interface NavView<Message> {
  readonly model: Model
  readonly entries: ReadonlyArray<NavEntry>
  readonly label: string
  readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>
  readonly orientation?: 'horizontal' | 'vertical' | undefined
  readonly direction?: 'ltr' | 'rtl' | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

NavView.model

property · packages/mixins-ui/src/nav.ts:364

readonly model: Model

NavView.entries

property · packages/mixins-ui/src/nav.ts:365

readonly entries: ReadonlyArray<NavEntry>

NavView.label

property · packages/mixins-ui/src/nav.ts:367

readonly label: string

The navigation landmark's name.

NavView.onMessage

property · packages/mixins-ui/src/nav.ts:368

readonly onMessage: (message: typeof Message.Type) => NoInfer<Message>

NavView.orientation

property · packages/mixins-ui/src/nav.ts:370

readonly orientation?: 'horizontal' | 'vertical' | undefined

A row (default) or a column; a column's panels open beside it.

NavView.direction

property · packages/mixins-ui/src/nav.ts:375

readonly direction?: 'ltr' | 'rtl' | undefined

Under 'rtl' the arrows that move along a row swap, and a column's panels open on its left. Given, it is drawn as the nav's dir.

NavView.mixins

property · packages/mixins-ui/src/nav.ts:377

readonly mixins?: MixinList<Message> | undefined

A style of NavSlots (Recipes.Nav) and mixins beside it; Nav.fluid glides the indicator.