solid-knobs / ParameterGestureHandlerProps
• children: (ref: any) => any
▸ (ref): any
| Name | Type |
|---|---|
ref |
any |
any
• value: number
The normalised value.
ParameterGestureHandler.tsx:12
• Optional onChange: (value: number, fine: boolean) => void
▸ (value, fine): void
Called with the normalised value when it changes.
| Name | Type | Description |
|---|---|---|
value |
number |
The normalised value (ranging between 0 and 1). |
fine |
boolean |
true when the value is adjusted more finely (e.g. when shift is pressed). |
void
ParameterGestureHandler.tsx:20
• Optional onNudge: (amount: number) => void
▸ (amount): void
Called when the value is nudged forward or backward with the arrows keys.
| Name | Type | Description |
|---|---|---|
amount |
number |
The size of the nudge. Can either be -1 or 1 for a small nudge, or -10 or 10 for a big nudge. |
void
ParameterGestureHandler.tsx:27
• Optional onGestureStart: (e: MouseEvent | TouchEvent, value: number) => void
▸ (e, value): void
Called when starting the change gesture.
| Name | Type |
|---|---|
e |
MouseEvent | TouchEvent |
value |
number |
void
ParameterGestureHandler.tsx:32
• Optional onGestureEnd: (e: MouseEvent | TouchEvent, value: number) => void
▸ (e, value): void
Called when ending the change gesture.
| Name | Type |
|---|---|
e |
MouseEvent | TouchEvent |
value |
number |
void
ParameterGestureHandler.tsx:37
• Optional speed: number
The relative speed of the change gesture. The default is 1.
ParameterGestureHandler.tsx:42
• 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.