@companion-module/base
    Preparing search index...

    Interface CompanionInputFieldCheckbox<TKey>

    A checkbox input field

    Available for actions/feedbacks/config

    {
    	id: 'doit',
    	type: 'checkbox',
    	label: 'Do the thing',
    	default: true
    }
    interface CompanionInputFieldCheckbox<TKey extends string = string> {
        allowInvalidValues?: boolean;
        default: boolean;
        description?: string;
        disableAutoExpression?: boolean;
        expressionDescription?: string;
        id: TKey;
        isVisibleExpression?: string;
        label: string;
        tooltip?: string;
        type: "checkbox";
    }

    Type Parameters

    • TKey extends string = string

    Hierarchy (View Summary)

    Index

    Properties

    allowInvalidValues? default description? disableAutoExpression? expressionDescription? id isVisibleExpression? label tooltip? type

    Properties

    allowInvalidValues?: boolean

    Enabling this will tell companion to validate the value of this field against the definition of the field. If the computed value for this option does not match the validation rules, it will be passed through unchanged. If this is not set, then any invalid value will result in the action/feedback being skipped entirely. Note: This only applies when in expression mode.

    default: boolean

    The default value

    description?: string

    A longer description/summary/notes for this field

    disableAutoExpression?: boolean

    Whether to disable support for toggling this field to be an expression Danger: Be careful if setting this to true for an existing option, if the user has already defined an expression for this, it will no longer be parsed and will break their configuration.

    expressionDescription?: string

    An alternate description to show when the field is in expression mode. This will replace the normal description

    id: TKey

    The unique id of this input field within the input group

    isVisibleExpression?: string

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

    This is the same syntax as other expressions written inside of Companion. You can access a value of the current options using $(options:some_field_id). Note: you can only reference fields which are set to disableAutoExpression here, as other fields can be expressions and frequently changing values

    label: string

    The label of the field

    tooltip?: string

    A hover tooltip for this field

    type: "checkbox"

    The type of this input field

    Settings

    Member Visibility

    On This Page

    Example
    Properties