Interface SelectInputArgs

The arguments for the SelectInput constructor.

interface SelectInputArgs {
    allowCreate?: boolean;
    allowInput?: boolean;
    allowNull?: boolean;
    binding?: BindingBase;
    class?: string | string[];
    createFn?: ((value) => void);
    createLabelText?: string;
    defaultValue?: any;
    disabledOptions?: Record<string, string>;
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    fallbackOrder?: string[];
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    invalidOptions?: any[];
    isRoot?: boolean;
    link?: {
        observer: Observer | Observer[];
        path: string | string[];
    };
    multiSelect?: boolean;
    onChange?: ((value) => void);
    onClick?: (() => void);
    onRemove?: (() => void);
    onSelect?: ((value) => void);
    options?: {
        t: string;
        v: string | number | boolean;
    }[];
    optionsFn?: any;
    parent?: Element;
    placeholder?: string;
    prefix?: string;
    readOnly?: boolean;
    renderChanges?: boolean;
    style?: string;
    tabIndex?: number;
    type?: "string" | "number" | "boolean";
    value?: any;
    values?: any[];
    width?: number;
}

Hierarchy (view full)

  • ElementArgs
  • IBindableArgs
  • IPlaceholderArgs
    • SelectInputArgs

Properties

allowCreate? allowInput? allowNull? binding? class? createFn? createLabelText? defaultValue? disabledOptions? dom? enabled? error? fallbackOrder? height? hidden? id? ignoreParent? invalidOptions? isRoot? link? multiSelect? onChange? onClick? onRemove? onSelect? options? optionsFn? parent? placeholder? prefix? readOnly? renderChanges? style? tabIndex? type? value? values? width?

Properties

Optional allowCreate

allowCreate?: boolean

If true then the input allows creating new values from the text field. Only used when allowInput is true. Defaults to false.

Optional allowInput

allowInput?: boolean

If true then a text field is shown for the user to search for values or enter new ones. Defaults to false.

Optional allowNull

allowNull?: boolean

If true then null is a valid input value. Defaults to false.

Optional binding

binding?: BindingBase

A binding to use with this Element.

Optional class

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optional createFn

createFn?: ((value) => void)

A function to be executed when the user selects to create a new value. The function takes the new value as a parameter.

Type declaration

    • (value): void

    • Parameters

      • value: string

      Returns void

Optional createLabelText

createLabelText?: string

The placeholder text to show when creating a new value. Used when allowInput and allowCreate are both true.

Optional defaultValue

defaultValue?: any

Default value for the input.

Optional disabledOptions

disabledOptions?: Record<string, string>

All the option values that should be disabled. The keys of the object are the values of the options and the values are the text to show when the option is disabled.

Optional dom

dom?: string | HTMLElement

The HTMLElement to create this Element with. If not provided this Element will create one.

Optional enabled

enabled?: boolean

Sets whether it is possible to interact with this Element and its children.

Optional error

error?: boolean

Sets whether the Element is in an error state.

Optional fallbackOrder

fallbackOrder?: string[]

The order that the options should be checked in to find a valid fallback option that isn't included in the disabledOptions object.

Optional height

height?: number

Sets the initial height of the Element.

Optional hidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optional id

id?: string

The id attribute of this Element's HTMLElement.

Optional ignoreParent

ignoreParent?: boolean

If true, this Element will ignore its parent's enabled value when determining whether this element is enabled. Defaults to false.

Optional invalidOptions

invalidOptions?: any[]

An array of values against which new values are checked before they are created. If a value is in the array it will not be created.

Optional isRoot

isRoot?: boolean

Sets whether this Element is at the root of the hierarchy.

Optional link

link?: {
    observer: Observer | Observer[];
    path: string | string[];
}

Links the observer attribute at the path location in the given observer to this Element.

Type declaration

  • observer: Observer | Observer[]
  • path: string | string[]

Optional multiSelect

multiSelect?: boolean

If true then the input value becomes an array allowing the selection of multiple options. Defaults to false.

Optional onChange

onChange?: ((value) => void)

If provided and the Element is changeable, this function will be called each time the element value is changed.

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Optional onClick

onClick?: (() => void)

If provided and the Element is clickable, this function will be called each time the element is clicked.

Type declaration

    • (): void

    • Returns void

Optional onRemove

onRemove?: (() => void)

If provided and the Element is removable, this function will be called each time the element is removed.

Type declaration

    • (): void

    • Returns void

Optional onSelect

onSelect?: ((value) => void)

If provided, this function will be called each time an option is selected.

Type declaration

    • (value): void

    • Parameters

      • value: string

      Returns void

Optional options

options?: {
    t: string;
    v: string | number | boolean;
}[]

The dropdown options of the input. Contains an array of objects with the following format {v: Any, t: String} where v is the value and t is the text of the option.

Type declaration

  • t: string
  • v: string | number | boolean

Optional optionsFn

optionsFn?: any

Used to map the options.

Optional parent

parent?: Element

Sets the parent Element.

Optional placeholder

placeholder?: string

Sets the placeholder label that appears on the right of the input.

Optional prefix

prefix?: string

Text to display in the SelectInput before the selected option.

Optional readOnly

readOnly?: boolean

Whether this Element is read only or not. Defaults to false.

Optional renderChanges

renderChanges?: boolean

If true each input will flash on changes.

Optional style

style?: string

Sets an initial value for Element.dom.style.

Optional tabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optional type

type?: "string" | "number" | "boolean"

The type of each value. Can be one of 'string', 'number' or 'boolean'. Defaults to 'string'.

Optional value

value?: any

Sets the value of the Element.

Optional values

values?: any[]

Sets multiple values to the Element. It is up to the Element to determine how to display them.

Optional width

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

Theme

On This Page

allowCreateallowInputallowNullbindingclasscreateFncreateLabelTextdefaultValuedisabledOptionsdomenablederrorfallbackOrderheighthiddenidignoreParentinvalidOptionsisRootlinkmultiSelectonChangeonClickonRemoveonSelectoptionsoptionsFnparentplaceholderprefixreadOnlyrenderChangesstyletabIndextypevaluevalueswidth