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

    Interface CompanionInputFieldCheckbox

    A checkbox input field

    {
    	id: 'doit',
    	type: 'checkbox',
    	label: 'Do the thing',
    	default: true
    }
    interface CompanionInputFieldCheckbox {
        default: boolean;
        description?: string;
        id: string;
        isVisibleExpression?: string;
        label: string;
        tooltip?: string;
        type: "checkbox";
    }

    Hierarchy (View Summary)

    Index

    Properties

    default description? id isVisibleExpression? label tooltip? type

    Properties

    default: boolean

    The default value

    description?: string

    A longer description/summary/notes for this field

    id: string

    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 Comapnion. You can access a value of the current options using $(options:some_field_id). This does not support the isVisibleData property, let us know if you need this.

    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