Interface CompanionInputFieldCheckbox

A checkbox input field

Available for actions/feedbacks/config

Example

{
	id: 'doit',
	type: 'checkbox',
	label: 'Do the thing',
	default: true
}
interface CompanionInputFieldCheckbox {
    default: boolean;
    id: string;
    isVisible?: ((options: CompanionOptionValues, data: any) => boolean);
    isVisibleData?: any;
    label: string;
    tooltip?: string;
    type: "checkbox";
}

Hierarchy (view full)

Properties

default id isVisible? isVisibleData? label tooltip? type

Properties

default

default: boolean

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

Optionaltooltip

tooltip?: string

A hover tooltip for this field

type

type: "checkbox"

The type of this input field

Settings

Member Visibility

On This Page

Example
Properties