Skip to content

Latest commit

 

History

History
168 lines (92 loc) · 2.93 KB

ControlProps.md

File metadata and controls

168 lines (92 loc) · 2.93 KB

solid-knobs / ControlProps

Interface: ControlProps

Hierarchy

  • Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange">

    ControlProps

Table of contents

Properties

Methods

Properties

label

Optional label: string

The label that should be used for the aria label (for accessibility).

Defined in

Control.tsx:12


defaultValue

Optional defaultValue: number

The default value.

Defined in

Control.tsx:17


value

value: number

The un-normalised value.

Defined in

Control.tsx:32


range

range: Range

The range of the value.

Defined in

Control.tsx:44


speed

Optional speed: number

The relative speed of the change gesture. The default is 1.

Defined in

Control.tsx:49


hideCursor

Optional hideCursor: boolean

Whether the cursor should be hidden while changing the value. Note! This might result in constant annoying pop-ups in certain browsers.

Defined in

Control.tsx:55


children

children: any

Overrides

Omit.children

Defined in

Control.tsx:57

Methods

onGestureStart

Optional onGestureStart(e): void

Called when starting the change gesture.

Parameters

Name Type
e MouseEvent | TouchEvent

Returns

void


onGestureEnd

Optional onGestureEnd(e): void

Called when ending the change gesture.

Parameters

Name Type
e MouseEvent | TouchEvent

Returns

void


onChange

onChange(value): void

Called with the un-normalised value when it changes.

Parameters

Name Type Description
value number The un-normalised value.

Returns

void