GitHub

Reference headless

slider

interface 3 type 6 function 1
interface Interfaces 3
interface slider/index.ts · L66

# CreateSliderOptions

Members

defaultValue?
optional defaultValue?: number

###### Inherited from

CreateSliderInput.defaultValue

direction?
optional direction?: SliderDirection
disabled?
optional disabled?: boolean

###### Inherited from

CreateSliderInput.disabled

id?
optional id?: string
max?
optional max?: number

###### Inherited from

CreateSliderInput.max

min?
optional min?: number

###### Inherited from

CreateSliderInput.min

onValueChange?
optional onValueChange?: (value) => void

###### Parameters

###### value

number

###### Returns

void

orientation?
optional orientation?: SliderOrientation

###### Inherited from

CreateSliderInput.orientation

pageStep?
optional pageStep?: number

PageUp/PageDown step. Default = step * 10.

###### Inherited from

CreateSliderInput.pageStep

step?
optional step?: number

###### Inherited from

CreateSliderInput.step

interface

# SliderContext

Members

max
max: number
min
min: number
orientation
orientation: SliderOrientation
pageStep
pageStep: number
step
step: number
value
value: number
interface slider/index.ts · L37

# SliderController

Members

context
readonly context: Readonly<SliderContext>
disabled
readonly disabled: boolean
id
readonly id: string
machine
readonly machine: SliderMachine
root
readonly root: Attachment
state
readonly state: SliderState
thumb
readonly thumb: Attachment
thumbId
readonly thumbId: string
trackId
readonly trackId: string
value
readonly value: number
setDirection()
setDirection(value): void

###### Parameters

###### value

SliderDirection

###### Returns

void

setDisabled()
setDisabled(value): void

###### Parameters

###### value

boolean

###### Returns

void

setMax()
setMax(value): void

###### Parameters

###### value

number

###### Returns

void

setMin()
setMin(value): void

###### Parameters

###### value

number

###### Returns

void

setOrientation()
setOrientation(value): void

###### Parameters

###### value

SliderOrientation

###### Returns

void

setPageStep()
setPageStep(value): void

###### Parameters

###### value

number

###### Returns

void

setStep()
setStep(value): void

###### Parameters

###### value

number

###### Returns

void

setValue()
setValue(value): void

###### Parameters

###### value

number

###### Returns

void

subscribe()
subscribe(listener): () => void

###### Parameters

###### listener

(snapshot) => void

###### Returns

() => void

type Type Aliases 6
type slider/index.ts · L33

# Attachment

Attachment = (node) => void | (() => void)

Parameters

node
HTMLElement

Returns

void | (() => void)
type

# SliderEvent

SliderEvent = { type: "INCREMENT"; } | { type: "DECREMENT"; } | { type: "PAGE_INCREMENT"; } | { type: "PAGE_DECREMENT"; } | { type: "TO_MIN"; } | { type: "TO_MAX"; } | { type: "SET.VALUE"; value: number; } | { type: "SET.MIN"; value: number; } | { type: "SET.MAX"; value: number; } | { type: "SET.STEP"; value: number; } | { type: "SET.PAGE_STEP"; value: number; } | { type: "SET.ORIENTATION"; value: SliderOrientation; } | { type: "DISABLE"; } | { type: "ENABLE"; }
type

# SliderOrientation

SliderOrientation = "horizontal" | "vertical"
type

# SliderState

SliderState = "idle" | "disabled"
function Functions 1