Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoComplete<Value, SS>

Type parameters

  • Value

  • SS

Hierarchy

Index

Constructors

constructor

Properties

blurHandlerPrevented

blurHandlerPrevented: boolean = false

context

Private getTransformedItemConfigs

getTransformedItemConfigs: (Anonymous function) = memoize((valueField: string,textField: string,contentField: string,items?: IAutoCompleteMenuItem[],data?: IAutoCompleteMenuItem[]): IAutoCompleteMenuObjectItem[] => {return (items || data || []).map((item: any) => {if (typeof item === 'string' || typeof item === 'number') {return {value: item,content: item,};}if (typeof item === 'object') {return {...item,value: item[valueField],content: item[contentField] || item[textField] || item[valueField],};}throw new Error('AutoComplete unresolvable option!');});})

Convert passed in data to item config list.

param
returns

Readonly props

props: Readonly<IAutoCompleteProps<Value>> & Readonly<{ children?: ReactNode }>

refMenuItemList

refMenuItemList: RefObject<SelectMenu> = React.createRef<SelectMenu>()

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IAutoCompleteState>

Static contextType

contextType: Context<IDisabledContext> = DisabledContext

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IAutoCompleteProps<Value>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

close

  • close(): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IAutoCompleteProps<Value>>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Private getDisplayText

  • getDisplayText(): string
  • Get the display text of selected value, since the value and content might be different, and content might be node.

    Use item.searchContent prior to item.content prior to item.value

    Returns string

Private getItemByValue

  • getItemByValue(value: any): any

getSelectedValueFromSearchText

  • getSelectedValueFromSearchText(searchText: string): any

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

getTransformedItemConfigsFromProps

Private iterateItems

  • iterateItems(items: any, value: any): any

moveFocusIndexDown

  • moveFocusIndexDown(): void

moveFocusIndexUp

  • moveFocusIndexUp(): void

onSearchBlur

  • onSearchBlur(): void

onSearchKeyDown

  • onSearchKeyDown(e: KeyboardEvent<HTMLInputElement>): void

onSearchTextChange

onSelect

  • onSelect(value: string): void

open

  • open(): void

render

  • render(): Element

selectCurrentFocusIndex

  • selectCurrentFocusIndex(e: any): void

setState

Optional shouldComponentUpdate

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

togglePopoverOpen

  • togglePopoverOpen(): void

Static getDerivedStateFromProps

Object literals

Static defaultProps

defaultProps: object

contentField

contentField: string = "content"

filterOption

filterOption: caselessMatchFilterOption = caselessMatchFilterOption

prefix

prefix: string = "zent"

textField

textField: string = "text"

valueField

valueField: string = "value"

valueFromOptions

valueFromOptions: boolean = false

Generated using TypeDoc