Type Alias AutoCompleteElement

AutoCompleteElement: FormElementWithOptionsBase & {
    autocompleteAttributes?: string[];
    defaultValue?: string;
    placeholderValue?: string;
    searchQuerystringParameter?: string;
    searchUrl?: string;
    type: "autocomplete";
}

An element to display multiple options to a user and only allowing them to choose one.

The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

Type declaration

  • OptionalautocompleteAttributes?: string[]

    Custom autocomplete attributes that will be added to the element during rendering

  • OptionaldefaultValue?: string

    While this property is called defaultValue, it should actually be called defaultId because it should not be set with a value from one of the options in the options array. It must be set to the id of the option from the options array to be chosen by default.

  • OptionalplaceholderValue?: string
  • OptionalsearchQuerystringParameter?: string

    If specified, a request will be made to the "searchUrl" with this querystring parameter assigned the value typed into the input, otherwise the querystring parameter will be "value" .

  • OptionalsearchUrl?: string

    If specified, a request will be made to the "searchUrl" allowing the options to be filtered on the server.

  • type: "autocomplete"

Settings

Member Visibility