Interface CompanionInputFieldDropdown

A dropdown input field

Available for actions/feedbacks/config

Example

{
	id: 'val',
	type: 'dropdown',
	label: 'Select name',
	choices: [
		{ id: 'bob', label: 'Bob' },
		{ id: 'sally', label: 'Sally' },
	],
	default: 'bob'
}
interface CompanionInputFieldDropdown {
    allowCustom?: boolean;
    choices: DropdownChoice[];
    default: DropdownChoiceId;
    id: string;
    isVisible?: ((options: CompanionOptionValues, data: any) => boolean);
    isVisibleData?: any;
    label: string;
    minChoicesForSearch?: number;
    regex?: string;
    tooltip?: string;
    type: "dropdown";
}

Hierarchy (view full)

Properties

allowCustom? choices default id isVisible? isVisibleData? label minChoicesForSearch? regex? tooltip? type

Properties

OptionalallowCustom

allowCustom?: boolean

Allow custom values to be defined by the user

choices

choices: DropdownChoice[]

The possible choices

default

default: DropdownChoiceId

The default selected 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

OptionalminChoicesForSearch

minChoicesForSearch?: number

The minimum number of entries the dropdown must have before it allows searching

Optionalregex

regex?: string

Check custom value against regex

Optionaltooltip

tooltip?: string

A hover tooltip for this field

type

type: "dropdown"

The type of this input field

Settings

Member Visibility

On This Page

Example
Properties