Mixins / foldkit-mixins-ui

CascadeSelectView

interface · packages/mixins-ui/src/cascadeSelect.ts:455

interface CascadeSelectView<ParentMessage> {
  readonly model: Model
  readonly config: Config
  readonly onMessage: (message: Message) => NoInfer<ParentMessage>
  readonly label: string
  readonly placeholder?: string | undefined
  readonly separator?: string | undefined
  readonly layout?: 'columns' | 'drill' | undefined
  readonly expandOn?: 'click' | 'hover' | undefined
  readonly levels?: ReadonlyArray<string> | undefined
  readonly clearable?: boolean | undefined
  readonly clearLabel?: string | undefined
  readonly backLabel?: string | undefined
  readonly name?: string | undefined
  readonly disabled?: boolean | undefined
  readonly invalid?: boolean | undefined
  readonly direction?: 'ltr' | 'rtl' | undefined
  readonly anchor?: AnchorConfig | undefined
  readonly style?: NamedStyle<typeof CascadeSelectSlots> | undefined
  readonly mixins?: MixinList<ParentMessage> | undefined
}

Members

CascadeSelectView.model

property · packages/mixins-ui/src/cascadeSelect.ts:456

readonly model: Model

CascadeSelectView.config

property · packages/mixins-ui/src/cascadeSelect.ts:458

readonly config: Config

The options; the same as update's, with its parents when set.

CascadeSelectView.onMessage

property · packages/mixins-ui/src/cascadeSelect.ts:459

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

CascadeSelectView.label

property · packages/mixins-ui/src/cascadeSelect.ts:461

readonly label: string

What is chosen, the trigger's and the panel's accessible name.

CascadeSelectView.placeholder

property · packages/mixins-ui/src/cascadeSelect.ts:463

readonly placeholder?: string | undefined

Shown while nothing is chosen; default Select….

CascadeSelectView.separator

property · packages/mixins-ui/src/cascadeSelect.ts:465

readonly separator?: string | undefined

Between the labels of the chosen path on the trigger; default /.

CascadeSelectView.layout

property · packages/mixins-ui/src/cascadeSelect.ts:470

readonly layout?: 'columns' | 'drill' | undefined

One column per level (default), or one level at a time with a way back. Columns drill in by themselves when the window is too narrow for them.

CascadeSelectView.expandOn

property · packages/mixins-ui/src/cascadeSelect.ts:472

readonly expandOn?: 'click' | 'hover' | undefined

Whether the pointer resting on a row opens its children, or only a press; default click.

CascadeSelectView.levels

property · packages/mixins-ui/src/cascadeSelect.ts:474

readonly levels?: ReadonlyArray<string> | undefined

A name per level, such as ['Country', 'Region', 'City'], heading each column.

CascadeSelectView.clearable

property · packages/mixins-ui/src/cascadeSelect.ts:476

readonly clearable?: boolean | undefined

Draws a button that clears the value while there is one.

CascadeSelectView.clearLabel

property · packages/mixins-ui/src/cascadeSelect.ts:478

readonly clearLabel?: string | undefined

Default Clear.

CascadeSelectView.backLabel

property · packages/mixins-ui/src/cascadeSelect.ts:480

readonly backLabel?: string | undefined

Drilled in, the back row's words before the level above's option; default Back to.

CascadeSelectView.name

property · packages/mixins-ui/src/cascadeSelect.ts:482

readonly name?: string | undefined

Submits the value with a form under this name, its ids joined by /.

CascadeSelectView.disabled

property · packages/mixins-ui/src/cascadeSelect.ts:483

readonly disabled?: boolean | undefined

CascadeSelectView.invalid

property · packages/mixins-ui/src/cascadeSelect.ts:484

readonly invalid?: boolean | undefined

CascadeSelectView.direction

property · packages/mixins-ui/src/cascadeSelect.ts:486

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

Default 'ltr'; under 'rtl' ArrowLeft goes into a row's children.

CascadeSelectView.anchor

property · packages/mixins-ui/src/cascadeSelect.ts:488

readonly anchor?: AnchorConfig | undefined

Where the panel opens against the trigger; default below it, at its start.

CascadeSelectView.style

property · packages/mixins-ui/src/cascadeSelect.ts:490

readonly style?: NamedStyle<typeof CascadeSelectSlots> | undefined

A style of CascadeSelectSlots, for the look.

CascadeSelectView.mixins

property · packages/mixins-ui/src/cascadeSelect.ts:492

readonly mixins?: MixinList<ParentMessage> | undefined

Mixins beside the style.