Mixins / foldkit-mixins-ui

NumberFieldView

interface · packages/mixins-ui/src/numberField.ts:46

interface NumberFieldView<Message> {
  readonly id: string
  readonly label: string
  readonly description?: string | undefined
  readonly value: number
  readonly onChange: (value: number) => NoInfer<Message>
  readonly min?: number | undefined
  readonly max?: number | undefined
  readonly step?: number | undefined
  readonly page?: number | undefined
  readonly format?: ((value: number) => string) | undefined
  readonly disabled?: boolean | undefined
  readonly style?: NamedStyle<typeof NumberFieldSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

NumberFieldView.id

property · packages/mixins-ui/src/numberField.ts:48

readonly id: string

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

NumberFieldView.label

property · packages/mixins-ui/src/numberField.ts:49

readonly label: string

NumberFieldView.description

property · packages/mixins-ui/src/numberField.ts:50

readonly description?: string | undefined

NumberFieldView.value

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

readonly value: number

NumberFieldView.onChange

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

readonly onChange: (value: number) => NoInfer<Message>

The Message for the next value; its type comes from h.

NumberFieldView.min

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

readonly min?: number | undefined

NumberFieldView.max

property · packages/mixins-ui/src/numberField.ts:55

readonly max?: number | undefined

NumberFieldView.step

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

readonly step?: number | undefined

Default 1.

NumberFieldView.page

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

readonly page?: number | undefined

PageUp and PageDown move by this; default ten steps.

NumberFieldView.format

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

readonly format?: ((value: number) => string) | undefined

How the value reads in the field and to a screen reader; default String.

NumberFieldView.disabled

property · packages/mixins-ui/src/numberField.ts:62

readonly disabled?: boolean | undefined

NumberFieldView.style

property · packages/mixins-ui/src/numberField.ts:64

readonly style?: NamedStyle<typeof NumberFieldSlots> | undefined

A style of NumberFieldSlots, for the field's look.

NumberFieldView.mixins

property · packages/mixins-ui/src/numberField.ts:66

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.