Skip to content

Latest commit

 

History

History
228 lines (123 loc) · 4.03 KB

File metadata and controls

228 lines (123 loc) · 4.03 KB

solid-knobs / ImageStripControlProps

Interface: ImageStripControlProps

Hierarchy

Table of contents

Properties

Methods

Properties

label

Optional label: string

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

Inherited from

Omit.label

Defined in

Control.tsx:12


defaultValue

Optional defaultValue: number

The default value.

Inherited from

Omit.defaultValue

Defined in

Control.tsx:17


value

value: number

The un-normalised value.

Inherited from

Omit.value

Defined in

Control.tsx:32


range

range: Range

The range of the value.

Inherited from

Omit.range

Defined in

Control.tsx:44


speed

Optional speed: number

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

Inherited from

Omit.speed

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.

Inherited from

Omit.hideCursor

Defined in

Control.tsx:55


imageSrc

imageSrc: string

The path to the image strip to use.

Defined in

ImageStripControl.tsx:12


numFrames

numFrames: number

The number of frames in the image strip.

Defined in

ImageStripControl.tsx:17


horizontal

Optional horizontal: boolean

Set to true if the image strip is laid out horizontally. Will be interpreted as vertical otherwise.

Defined in

ImageStripControl.tsx:22

Methods

onGestureStart

Optional onGestureStart(e): void

Called when starting the change gesture.

Parameters

Name Type
e MouseEvent | TouchEvent

Returns

void

Inherited from

Omit.onGestureStart


onGestureEnd

Optional onGestureEnd(e): void

Called when ending the change gesture.

Parameters

Name Type
e MouseEvent | TouchEvent

Returns

void

Inherited from

Omit.onGestureEnd


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

Inherited from

Omit.onChange