Mixins / foldkit-mixins-ui

FloatingPanelView

interface · packages/mixins-ui/src/floatingPanel.ts:341

interface FloatingPanelView<ParentMessage> {
  readonly model: Model
  readonly onMessage: (message: Message) => NoInfer<ParentMessage>
  readonly title: string
  readonly content: Html
  readonly order?: ReadonlyArray<string> | undefined
  readonly resizable?: boolean | undefined
  readonly draggable?: boolean | undefined
  readonly closeOnEscape?: boolean | undefined
  readonly step?: number | undefined
  readonly direction?: 'ltr' | 'rtl' | undefined
  readonly labels?:
    | {
        readonly minimize?: string
        readonly maximize?: string
        readonly restore?: string
        readonly close?: string
        readonly move?: string
        readonly resize?: string
      }
    | undefined
  readonly style?: NamedStyle<typeof FloatingPanelSlots> | undefined
  readonly mixins?: MixinList<ParentMessage> | undefined
}

Members

FloatingPanelView.model

property · packages/mixins-ui/src/floatingPanel.ts:342

readonly model: Model

FloatingPanelView.onMessage

property · packages/mixins-ui/src/floatingPanel.ts:343

readonly onMessage: (message: Message) => NoInfer<ParentMessage>

FloatingPanelView.title

property · packages/mixins-ui/src/floatingPanel.ts:345

readonly title: string

The title, naming the panel and its header.

FloatingPanelView.content

property · packages/mixins-ui/src/floatingPanel.ts:346

readonly content: Html

FloatingPanelView.order

property · packages/mixins-ui/src/floatingPanel.ts:348

readonly order?: ReadonlyArray<string> | undefined

The ids of every panel on the page, from the bottom; the last is on top.

FloatingPanelView.resizable

property · packages/mixins-ui/src/floatingPanel.ts:350

readonly resizable?: boolean | undefined

Whether it can be resized; default true.

FloatingPanelView.draggable

property · packages/mixins-ui/src/floatingPanel.ts:352

readonly draggable?: boolean | undefined

Whether its header drags it; default true.

FloatingPanelView.closeOnEscape

property · packages/mixins-ui/src/floatingPanel.ts:354

readonly closeOnEscape?: boolean | undefined

Whether Escape closes it; default true.

FloatingPanelView.step

property · packages/mixins-ui/src/floatingPanel.ts:356

readonly step?: number | undefined

Pixels an arrow moves or resizes it by; five times that with Shift. Default 10.

FloatingPanelView.direction

property · packages/mixins-ui/src/floatingPanel.ts:358

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

Default 'ltr'; under 'rtl' the corner the arrows resize from is the bottom left.

FloatingPanelView.labels

property · packages/mixins-ui/src/floatingPanel.ts:360

readonly labels?:
  | {
      readonly minimize?: string
      readonly maximize?: string
      readonly restore?: string
      readonly close?: string
      readonly move?: string
      readonly resize?: string
    }
  | undefined

The controls' words, defaults Minimize, Maximize, Restore, Close, and the header's and corner's.

FloatingPanelView.style

property · packages/mixins-ui/src/floatingPanel.ts:371

readonly style?: NamedStyle<typeof FloatingPanelSlots> | undefined

A style of FloatingPanelSlots, for the look.

FloatingPanelView.mixins

property · packages/mixins-ui/src/floatingPanel.ts:373

readonly mixins?: MixinList<ParentMessage> | undefined

Mixins beside the style.