Interface CompanionInputFieldNumber

A number input field

Available for actions/feedbacks/config

Example

{
	id: 'size',
	type: 'number',
	label: 'Target size',
	default: 50,
	min: 0,
	max: 100
}
interface CompanionInputFieldNumber {
    default: number;
    id: string;
    isVisible?: ((options: CompanionOptionValues, data: any) => boolean);
    isVisibleData?: any;
    label: string;
    max: number;
    min: number;
    range?: boolean;
    required?: boolean;
    step?: number;
    tooltip?: string;
    type: "number";
}

Hierarchy (view full)

Properties

default id isVisible? isVisibleData? label max min range? required? step? tooltip? type

Properties

default

default: number

The default value

id

id: string

The unique id of this input field within the input group

OptionalisVisible

isVisible?: ((options: CompanionOptionValues, data: any) => boolean)

A function called to check whether this input should be visible, based on the current options selections within the input group

Note: This function must not depend on anything outside of its scope. If it does it will fail to compile and will be skipped.

OptionalisVisibleData

isVisibleData?: any

JSON serializable data to provide to isVisible

label

label: string

The label of the field

max

max: number

The maximum value to allow Note: values may not conform to this, it is a visual hint only

min

min: number

The minimum value to allow Note: values may not conform to this, it is a visual hint only

Optionalrange

range?: boolean

Whether to show a slider for the input

Optionalrequired

required?: boolean

Whether a value is required Note: values may not conform to this, it is a visual hint only

Optionalstep

step?: number

The stepping of the arrows

Optionaltooltip

tooltip?: string

A hover tooltip for this field

type

type: "number"

The type of this input field

Settings

Member Visibility

On This Page

Example
Properties