Interface CompanionInputFieldMultiDropdown

A multi-select dropdown input field

Available for actions/feedbacks/config

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

Hierarchy (view full)

Properties

choices: DropdownChoice[]

The possible choices

default: DropdownChoiceId[]

The default selected values

id: string

The unique id of this input field within the input group

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.

isVisibleData?: any

JSON serializable data to provide to isVisible

label: string

The label of the field

maxSelection?: number

The maximum number of selected values

minChoicesForSearch?: number

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

minSelection?: number

The minimum number of selected values

tooltip?: string

A hover tooltip for this field

type: "multidropdown"

The type of this input field