Interface ISearchBoxProps<T>

Search Box Properties

Type Parameters

Hierarchy

  • ISearchBoxProps

Properties

assignTo? className? disabled? el? items? label? maxResults? minCharSearch? multi? onChange? onItemAdded? onItemsLoaded? onItemsLoading? onSearchItems? placeholder? readOnly? value?

Properties

Optional assignTo

assignTo?: ((obj) => void)

Type declaration

Optional className

className?: string

The class name to apply to the element.

Optional disabled

disabled?: boolean

True to disable the component.

Optional el

el?: HTMLElement

The element to render the form to.

Optional items

items?: T[]

The items for the search box.

Optional label

label?: string

The label.

Optional maxResults

maxResults?: number

Limits the results to a maximum number.

Optional minCharSearch

minCharSearch?: number

The minimum number of characters to enter before search occurs.

Optional multi

multi?: boolean

True to allow multiple users to be selected.

Optional onChange

onChange?: ((obj) => void)

Type declaration

    • (obj): void

    • The change event.

      Parameters

      • obj: T[]

      Returns void

Optional onItemAdded

onItemAdded?: ((el, item) => void)

Type declaration

    • (el, item): void

    • The render event when an item is added.

      Parameters

      • el: HTMLElement
      • item: T

      Returns void

Optional onItemsLoaded

onItemsLoaded?: ((items?) => void)

Type declaration

    • (items?): void

    • The event called after the items are loaded.

      Parameters

      • Optional items: T[]

      Returns void

Optional onItemsLoading

onItemsLoading?: (() => T[] | PromiseLike<T[]>)

Type declaration

    • (): T[] | PromiseLike<T[]>

    • Use this event to set the items dynamically.

      Returns T[] | PromiseLike<T[]>

Optional onSearchItems

onSearchItems?: ((filter?) => T[] | PromiseLike<T[]>)

Type declaration

    • (filter?): T[] | PromiseLike<T[]>

    • The search event.

      Parameters

      • Optional filter: string

      Returns T[] | PromiseLike<T[]>

Optional placeholder

placeholder?: string

The placeholder text. (Default value is "Search")

Optional readOnly

readOnly?: boolean

True to make the component read-only.

Optional value

value?: string | number | (string | number)[]

The selected users.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc