Mixins / foldkit-mixins-ui

OtpFieldView

interface · packages/mixins-ui/src/otpField.ts:29

interface OtpFieldView<Message> {
  readonly label: string
  readonly length?: number | undefined
  readonly value: string
  readonly onChange: (value: string) => NoInfer<Message>
  readonly pattern?: keyof typeof PATTERNS | undefined
  readonly groups?: ReadonlyArray<number> | undefined
  readonly disabled?: boolean | undefined
  readonly style?: NamedStyle<typeof OtpFieldSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

OtpFieldView.label

property · packages/mixins-ui/src/otpField.ts:31

readonly label: string

The field's accessible name: what the code is for.

OtpFieldView.length

property · packages/mixins-ui/src/otpField.ts:33

readonly length?: number | undefined

How many characters the code has. Default 6.

OtpFieldView.value

property · packages/mixins-ui/src/otpField.ts:34

readonly value: string

OtpFieldView.onChange

property · packages/mixins-ui/src/otpField.ts:36

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

The Message for what was typed, already kept to the pattern and length.

OtpFieldView.pattern

property · packages/mixins-ui/src/otpField.ts:38

readonly pattern?: keyof typeof PATTERNS | undefined

Which characters a cell takes; default digits.

OtpFieldView.groups

property · packages/mixins-ui/src/otpField.ts:40

readonly groups?: ReadonlyArray<number> | undefined

The cells in runs, a separator between them: [3, 3]. Default one run.

OtpFieldView.disabled

property · packages/mixins-ui/src/otpField.ts:41

readonly disabled?: boolean | undefined

OtpFieldView.style

property · packages/mixins-ui/src/otpField.ts:43

readonly style?: NamedStyle<typeof OtpFieldSlots> | undefined

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

OtpFieldView.mixins

property · packages/mixins-ui/src/otpField.ts:45

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.