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

    Interface CompanionInputFieldSecret

    A text input field for secret values

    Available for config. Note: the value for this will be in the secrets store, not the config store.

    {
    	id: 'val',
    	type: 'secret-text',
    	label: 'Provide name',
    	default: 'Bob'
    }
    interface CompanionInputFieldSecret {
        default?: string;
        description?: string;
        id: string;
        isVisible?: (options: CompanionOptionValues, data: any) => boolean;
        isVisibleData?: Record<string, any>;
        isVisibleExpression?: string;
        label: string;
        regex?: string;
        required?: boolean;
        tooltip?: string;
        type: "secret-text";
    }

    Hierarchy (View Summary)

    Index

    Properties

    default? description? id isVisible? isVisibleData? isVisibleExpression? label regex? required? tooltip? type

    Properties

    default?: string

    The default text value

    description?: string

    A longer description/summary/notes for this field

    id: string

    The unique id of this input field within the input group

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

    This will be removed in 2.0.0 of this api. Use isVisibleExpression instead.

    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.

    Note: If both this and isVisibleExpression are provided, isVisibleExpression will take precedence.

    isVisibleData?: Record<string, any>

    This will be removed in 2.0.0 of this api. Use isVisibleExpression instead.

    A JSON serializable object to provide as extra input to isVisible

    If you think you need this with isVisibleExpression, we want to hear why.

    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.

    Note: If both this and isVisible are provided, this will take precedence.

    label: string

    The label of the field

    regex?: string

    A regex to use to inform the user if the current input is valid. Note: values may not conform to this, it is a visual hint only

    required?: boolean

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

    tooltip?: string

    A hover tooltip for this field

    type: "secret-text"

    The type of this input field

    Settings

    Member Visibility

    On This Page

    Example
    Properties