Mixins / foldkit-mixins/theme/knob-data

KnobData

interface · packages/mixins/src/theme/knobDataType.ts:6

interface KnobData<Name extends string = string> {
  readonly name: Name
  readonly title: string
  readonly variable: string
  readonly unit: string
  readonly min: number
  readonly max: number
  readonly step: number
  readonly default: number
}

A knob drawn as a range: the variable it writes and the bounds of its control.

Members

KnobData.name

property · packages/mixins/src/theme/knobDataType.ts:7

readonly name: Name

KnobData.title

property · packages/mixins/src/theme/knobDataType.ts:8

readonly title: string

KnobData.variable

property · packages/mixins/src/theme/knobDataType.ts:10

readonly variable: string

The variable it writes, the name after --fk-knob-.

KnobData.unit

property · packages/mixins/src/theme/knobDataType.ts:11

readonly unit: string

KnobData.min

property · packages/mixins/src/theme/knobDataType.ts:12

readonly min: number

KnobData.max

property · packages/mixins/src/theme/knobDataType.ts:13

readonly max: number

KnobData.step

property · packages/mixins/src/theme/knobDataType.ts:14

readonly step: number

KnobData.default

property · packages/mixins/src/theme/knobDataType.ts:15

readonly default: number