Mixins / foldkit-mixins-ui

RangeSliderView

interface · packages/mixins-ui/src/rangeSlider.ts:50

interface RangeSliderView<Message> extends Bounds {
  readonly id: string
  readonly label: string
  readonly value: Range
  readonly onChange: (value: Range) => NoInfer<Message>
  readonly format?: ((value: number) => string) | undefined
  readonly thumbLabels?:
    | {
        readonly low: string
        readonly high: string
      }
    | undefined
  readonly name?: string | undefined
  readonly disabled?: boolean | undefined
  readonly style?: NamedStyle<typeof RangeSliderSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

RangeSliderView.id

property · packages/mixins-ui/src/rangeSlider.ts:52

readonly id: string

Prefixes the ids the slider draws, unique on the page.

RangeSliderView.label

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

readonly label: string

What the range chooses, shown and naming the group.

RangeSliderView.value

property · packages/mixins-ui/src/rangeSlider.ts:56

readonly value: Range

low at most high, both within the bounds and on the step.

RangeSliderView.onChange

property · packages/mixins-ui/src/rangeSlider.ts:58

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

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

RangeSliderView.format

property · packages/mixins-ui/src/rangeSlider.ts:60

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

How a value reads aloud, as each thumb's aria-valuetext; default String.

RangeSliderView.thumbLabels

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

readonly thumbLabels?:
  | {
      readonly low: string
      readonly high: string
    }
  | undefined

The thumbs' names; default Minimum and Maximum.

RangeSliderView.name

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

readonly name?: string | undefined

Submits both values under this name, low first.

RangeSliderView.disabled

property · packages/mixins-ui/src/rangeSlider.ts:65

readonly disabled?: boolean | undefined

RangeSliderView.style

property · packages/mixins-ui/src/rangeSlider.ts:67

readonly style?: NamedStyle<typeof RangeSliderSlots> | undefined

A style of RangeSliderSlots, for the look.

RangeSliderView.mixins

property · packages/mixins-ui/src/rangeSlider.ts:69

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.