components/Knob

Interfaces

KnobMethods

Defined in: components/Knob/index.tsx:95

Properties

blur

blur: () => void;

Defined in: components/Knob/index.tsx:97

Returns

void

focus

focus: () => void;

Defined in: components/Knob/index.tsx:96

Returns

void

---

KnobProps

Defined in: components/Knob/index.tsx:40

Properties

angleRange?

optional angleRange?: number;

Defined in: components/Knob/index.tsx:90

angle range [degree]

defaultValue?

optional defaultValue?: number;

Defined in: components/Knob/index.tsx:55

value set when double-clicking restriction: enableDoubleClickDefault = true

Default

min

See

enableDoubleClickDefault

disabled?

optional disabled?: boolean;

Defined in: components/Knob/index.tsx:86

enableDoubleClickDefault?

optional enableDoubleClickDefault?: boolean;

Defined in: components/Knob/index.tsx:84

externalStyles?

optional externalStyles?: object;

Defined in: components/Knob/index.tsx:70

Global style to apply when dragged

cursor?

optional cursor?: "none" | "move" | "grabbing" | "grab" | "pointer";

userSelectNone?

optional userSelectNone?: boolean;

Default

defaultExternalStyles

keyboard?

optional keyboard?: InputEventOption | null;

Defined in: components/Knob/index.tsx:83

keyboard control option If null, no event will be triggered

max

max: number;

Defined in: components/Knob/index.tsx:44

min

min: number;

Defined in: components/Knob/index.tsx:43

onChange?

optional onChange?: (value) => void;

Defined in: components/Knob/index.tsx:92

Parameters

Parameter	Type
value	number

Returns

void

readonly?

optional readonly?: boolean;

Defined in: components/Knob/index.tsx:87

size?

optional size?: string | number;

Defined in: components/Knob/index.tsx:64

width and height

skew?

optional skew?: number;

Defined in: components/Knob/index.tsx:48

startValue?

optional startValue?: number;

Defined in: components/Knob/index.tsx:61

Value to be used as the starting point of the line when drawing.

Default

min

step?

optional step?: number;

Defined in: components/Knob/index.tsx:47

value

value: number;

Defined in: components/Knob/index.tsx:42

wheel?

optional wheel?: InputEventOption | null;

Defined in: components/Knob/index.tsx:78

wheel control option If null, no event will be triggered

Variables

Knob

const Knob: object;

Defined in: components/Knob/index.tsx:274

Interactive rotary knob component implemented in SVG.

Type Declaration

ActiveLine

ActiveLine: (__namedParameters) => Element;

Parameters

Parameter	Type
__namedParameters	Omit<SVGProps<SVGPathElement>, "d">

Returns

Element

InactiveLine

InactiveLine: (__namedParameters) => Element;

Parameters

Parameter	Type
__namedParameters	Omit<SVGProps<SVGPathElement>, "d">

Returns

Element

Root

Root: ForwardRefExoticComponent<KnobProps & Omit<Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof KnobProps> & RefAttributes<KnobMethods>>;

SVGRoot

SVGRoot: (__namedParameters) => Element;

Parameters

Parameter	Type
__namedParameters	Override<SVGRoot, SVGProps<SVGSVGElement>>

Returns

Element

Thumb

Thumb: (__namedParameters) => Element;

Parameters

Parameter	Type
__namedParameters	Props & Omit<SVGProps<SVGSVGElement>, "d" | keyof Props>

Returns

Element

Functions

useKnobContext()

function useKnobContext<T>(selector): T;

Defined in: components/Knob/context.tsx:114

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
selector	(state) => T

Returns

T