x4js - v2.3.17
    Preparing search index...

    Interface AutoCompleteProps

    interface AutoCompleteProps {
        attrs?: Record<string, string | number | boolean>;
        autofocus?: boolean;
        change?: EventCallback<EvAutoCompleteChange>;
        cls?: string;
        content?: ComponentContent;
        delay?: number;
        disabled?: boolean;
        dom_events?: GlobalDOMEvents;
        existingDOM?: HTMLElement;
        flex?: number | boolean;
        focus?: EventCallback<EvFocus>;
        height?: string | number;
        hidden?: boolean;
        id?: string;
        inputAttrs?: any;
        inputGadgets?: Component<ComponentProps, ComponentEvents>[];
        inputId?: string;
        inputWidth?: number;
        itemValue?: "id" | "text";
        label: string | UnsafeHtml;
        labelWidth?: number;
        maxlength?: number;
        minChars?: number;
        minlength?: number;
        name?: string;
        ns?: string;
        pattern?: string;
        placeholder?: string;
        readonly?: boolean;
        renderer?: (item: ListItem) => Component;
        required?: boolean;
        search: EventCallback<EvSearch>;
        spellcheck?: boolean;
        stretch?: boolean;
        strict?: boolean;
        style?: StyleProps;
        tag?: string;
        tooltip?: string;
        trim?: boolean;
        value?: string | number;
        width?: string | number;
    }

    Hierarchy (View Summary)

    Index
    attrs? autofocus? change? cls? content? delay? disabled? dom_events? existingDOM? flex? focus? height? hidden? id? inputAttrs? inputGadgets? inputId? inputWidth? itemValue? label labelWidth? maxlength? minChars? minlength? name? ns? pattern? placeholder? readonly? renderer? required? search spellcheck? stretch? strict? style? tag? tooltip? trim? value? width?
    attrs?: Record<string, string | number | boolean>

    HTML attributes.

    autofocus?: boolean

    Automatically focus the input on page load.

    change?: EventCallback<EvAutoCompleteChange>
    cls?: string

    Additional CSS classes.

    Optionalcontent

    content?: ComponentContent

    Child content (components, strings, or HTML).

    delay?: number

    delay between the last key and the search, in ms (default 250)

    disabled?: boolean

    Component is initialy disabled.

    dom_events?: GlobalDOMEvents

    DOM event listeners.

    existingDOM?: HTMLElement

    Existing DOM element to wrap.

    flex?: number | boolean

    Enables flex layout (boolean) or sets flex-grow (number).

    focus?: EventCallback<EvFocus>

    Fired when the input receives/loses focus.

    height?: string | number

    Height (px or string like "50%").

    hidden?: boolean

    Component is initialy hidden.

    id?: string

    Element ID.

    inputAttrs?: any
    inputGadgets?: Component<ComponentProps, ComponentEvents>[]
    inputId?: string
    inputWidth?: number
    itemValue?: "id" | "text"

    what is written in the field when an item is picked (default "text")

    label: string | UnsafeHtml
    labelWidth?: number
    maxlength?: number

    Maximum input length.

    minChars?: number

    number of chars needed to start a search (default 1)

    minlength?: number

    Minimum input length.

    name?: string

    Input field name. required if you want to use form getValues/setValues

    ns?: string

    Namespace for SVG/MathML elements.

    pattern?: string

    Regex pattern for validation.

    placeholder?: string

    Placeholder text displayed when empty.

    readonly?: boolean

    Makes the input read-only.

    renderer?: (item: ListItem) => Component

    custom renderer for the suggestions

    required?: boolean

    Marks the input as required.

    search: EventCallback<EvSearch>
    spellcheck?: boolean

    Enables/disables spellcheck.

    stretch?: boolean
    strict?: boolean

    only a picked item (or nothing) is accepted, default false: free text is kept

    style?: StyleProps

    Inline CSS styles.

    tag?: string

    HTML tag name (default: "div").

    tooltip?: string

    Tooltip text.

    trim?: boolean
    value?: string | number

    Input value.

    width?: string | number

    Width (px or string like "50%" or "3em").

    Settings
    Member Visibility

    On This Page
    Properties