Select | zent

Type parameters

Key: string | number = string | number
Item: ISelectItem<Key> = ISelectItem<Key>

Hierarchy

Component<ISelectProps<Key, Item>, ISelectState<Key, Item>>
- Select

Index

Constructors

constructor

Properties

Accessors

disabled

Methods

Constructors

constructor

new Select<Key, Item>(props: ISelectProps<Key, Item>): Select<Key, Item>

Overrides Component<ISelectProps<Key, Item>, ISelectState<Key, Item>>.constructor
- Defined in packages/zent/src/select/Select.tsx:283
Type parameters
- Key: string | number = string | number
- Item: ISelectItem<Key, Item> = ISelectItem<Key>
Parameters
- props: ISelectProps<Key, Item>
Returns Select<Key, Item>

Properties

context

context: IDisabledContext

filterOptions

filterOptions: (keyword: string, options?: Item[], filter: false | ((keyword: string, item: Item) => boolean), creatable: boolean, isValidNewOption: (keyword: string, options: Item[]) => boolean, value: Item | Item[]) => Item[] = ...

Type declaration

- (keyword: string, options?: Item[], filter: false | ((keyword: string, item: Item) => boolean), creatable: boolean, isValidNewOption: (keyword: string, options: Item[]) => boolean, value: Item | Item[]): Item[]
- Parameters
  - keyword: string
  - options: Item[] = []
  - filter: false | ((keyword: string, item: Item) => boolean)
  - creatable: boolean
  - isValidNewOption: (keyword: string, options: Item[]) => boolean
    - - (keyword: string, options: Item[]): boolean
      - Parameters
        
        keyword: string
        
        options: Item[]
        
        Returns boolean
  - value: Item | Item[]
  Returns Item[]

inputRef

inputRef: RefObject<HTMLInputElement> = ...

onKeywordChange

onKeywordChange: ChangeEventHandler<HTMLInputElement> = ...

popoverRef

popoverRef: RefObject<Popover> = ...

Readonly props

props: Readonly<ISelectMultiProps<Key, Item>> & Readonly<{ children?: ReactNode }> & Readonly<ISelectSingleProps<Key, Item>> & Readonly<{ children?: ReactNode }>

refs

refs: {}

deprecated: https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration

[key: string]: ReactInstance

renderOption

renderOption: IOptionRenderer<Key, Item> = ...

state

state: Readonly<ISelectState<Key, Item>>

triggerRef

triggerRef: RefObject<HTMLDivElement> = ...

Static contextType

contextType: Context<IDisabledContext> = ...

Static defaultProps

defaultProps: { clearable: boolean; creatable: boolean; filter: <Key, Item>(keyword: string, option: Item) => boolean; highlight: <Key, Item>(keyword: string, option: Item) => React.ReactNode; isEqual: <Key, Item>(a: Item, b: Item) => boolean; isValidNewOption: <Key>(keyword: string, options: ISelectItem<Key>[]) => boolean; loading: boolean; multiple: boolean; renderOptionList: <Key, Item>(options: Item[], renderOption: IOptionRenderer<Key, Item>) => ReactNode[]; size: string } = ...

Type declaration

clearable: boolean
creatable: boolean
filter: <Key, Item>(keyword: string, option: Item) => boolean
- - <Key, Item>(keyword: string, option: Item): boolean
  - Type parameters
    - Key: string | number = string | number
    - Item: ISelectItem<Key, Item> = ISelectItem<Key>
    Parameters
    - keyword: string
    - option: Item
    Returns boolean
highlight: <Key, Item>(keyword: string, option: Item) => React.ReactNode
- - <Key, Item>(keyword: string, option: Item): React.ReactNode
  - Type parameters
    - Key: string | number = string | number
    - Item: ISelectItem<Key, Item> = ISelectItem<Key>
    Parameters
    - keyword: string
    - option: Item
    Returns React.ReactNode
isEqual: <Key, Item>(a: Item, b: Item) => boolean
- - <Key, Item>(a: Item, b: Item): boolean
  - Type parameters
    - Key: string | number = string | number
    - Item: ISelectItem<Key, Item> = ISelectItem<Key>
    Parameters
    - a: Item
    - b: Item
    Returns boolean
isValidNewOption: <Key>(keyword: string, options: ISelectItem<Key>[]) => boolean
- - <Key>(keyword: string, options: ISelectItem<Key>[]): boolean
  - Type parameters
    - Key: string | number = string | number
    Parameters
    - keyword: string
    - options: ISelectItem<Key>[]
    Returns boolean
loading: boolean
multiple: boolean
renderOptionList: <Key, Item>(options: Item[], renderOption: IOptionRenderer<Key, Item>) => ReactNode[]
- - <Key, Item>(options: Item[], renderOption: IOptionRenderer<Key, Item>): ReactNode[]
  - Type parameters
    - Key: string | number = string | number
    - Item: ISelectItem<Key, Item> = ISelectItem<Key>
    Parameters
    - options: Item[]
    - renderOption: IOptionRenderer<Key, Item>
    Returns ReactNode[]
size: string

Static reviveValue

reviveValue: <K>(reviver: K | { key: K } | ISelectItem<K>["reviver"]) => ISelectItem<K> = ...

Type declaration

- <K>(reviver: K | { key: K } | ISelectItem<K>["reviver"]): ISelectItem<K>
- Type parameters
  - K: string | number = string | number
  Parameters
  - reviver: K | { key: K } | ISelectItem<K>["reviver"]
  Returns ISelectItem<K>

Accessors

disabled

get disabled(): boolean

- Defined in packages/zent/src/select/Select.tsx:372
Returns boolean

Methods

Optional UNSAFE_componentWillMount

UNSAFE_componentWillMount(): void

Inherited from Component.UNSAFE_componentWillMount
- Defined in node_modules/@types/react/index.d.ts:711
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional UNSAFE_componentWillReceiveProps

UNSAFE_componentWillReceiveProps(nextProps: Readonly<ISelectProps<Key, Item>>, nextContext: any): void

Inherited from Component.UNSAFE_componentWillReceiveProps
- Defined in node_modules/@types/react/index.d.ts:743
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<ISelectProps<Key, Item>>
- nextContext: any
Returns void

Optional UNSAFE_componentWillUpdate

UNSAFE_componentWillUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): void

Inherited from Component.UNSAFE_componentWillUpdate
- Defined in node_modules/@types/react/index.d.ts:771
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<ISelectProps<Key, Item>>
- nextState: Readonly<ISelectState<Key, Item>>
- nextContext: any
Returns void

Optional componentDidCatch

componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from Component.componentDidCatch
- Defined in node_modules/@types/react/index.d.ts:640
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters
- error: Error
- errorInfo: ErrorInfo
Returns void

componentDidMount

componentDidMount(): void

Overrides Component.componentDidMount
- Defined in packages/zent/src/select/Select.tsx:348
Returns void

componentDidUpdate

componentDidUpdate(prevProps: ISelectProps<Key, Item>): void

Overrides Component.componentDidUpdate
- Defined in packages/zent/src/select/Select.tsx:363
Parameters
- prevProps: ISelectProps<Key, Item>
Returns void

Optional componentWillMount

componentWillMount(): void

Inherited from Component.componentWillMount
- Defined in node_modules/@types/react/index.d.ts:697
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use componentDidMount or the constructor instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns void

Optional componentWillReceiveProps

componentWillReceiveProps(nextProps: Readonly<ISelectProps<Key, Item>>, nextContext: any): void

Inherited from Component.componentWillReceiveProps
- Defined in node_modules/@types/react/index.d.ts:726
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<ISelectProps<Key, Item>>
- nextContext: any
Returns void

Optional componentWillUnmount

componentWillUnmount(): void

Inherited from Component.componentWillUnmount
- Defined in node_modules/@types/react/index.d.ts:635
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

componentWillUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): void

Inherited from Component.componentWillUpdate
- Defined in node_modules/@types/react/index.d.ts:756
Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see

https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters
- nextProps: Readonly<ISelectProps<Key, Item>>
- nextState: Readonly<ISelectState<Key, Item>>
- nextContext: any
Returns void

focusSearchInput

focusSearchInput(): void

- Defined in packages/zent/src/select/Select.tsx:906
Returns void

forceUpdate

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

Inherited from Component.forceUpdate
- Defined in node_modules/@types/react/index.d.ts:490
Parameters
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

getSearchPlaceholder

getSearchPlaceholder(): string

- Defined in packages/zent/src/select/Select.tsx:805
Returns string

Optional getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(prevProps: Readonly<ISelectProps<Key, Item>>, prevState: Readonly<ISelectState<Key, Item>>): any

Inherited from Component.getSnapshotBeforeUpdate
- Defined in node_modules/@types/react/index.d.ts:676
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
- prevProps: Readonly<ISelectProps<Key, Item>>
- prevState: Readonly<ISelectState<Key, Item>>
Returns any

globalClick

globalClick(e: MouseEvent): void

- Defined in packages/zent/src/select/Select.tsx:630
Parameters
- e: MouseEvent
Returns void

onClear

onClear(e: MouseEvent<Element, MouseEvent>): void

- Defined in packages/zent/src/select/Select.tsx:820
Parameters
- e: MouseEvent<Element, MouseEvent>
Returns void

onCreateClick

onCreateClick(): void

- Defined in packages/zent/src/select/Select.tsx:853
Returns void

onIndexChange

onIndexChange(delta: 1 | -1): void

- Defined in packages/zent/src/select/Select.tsx:647
Parameters
- delta: 1 | -1
Returns void

onOptionMouseEnter

onOptionMouseEnter(index: number): void

- Defined in packages/zent/src/select/Select.tsx:526
Parameters
- index: number
Returns void

onOptionMouseLeave

onOptionMouseLeave(index: number): void

- Defined in packages/zent/src/select/Select.tsx:535
Parameters
- index: number
Returns void

onRemove

onRemove(item: Item): void

- Defined in packages/zent/src/select/Select.tsx:508
Parameters
- item: Item
Returns void

onSelect

onSelect(item: Item): void

- Defined in packages/zent/src/select/Select.tsx:447
Parameters
- item: Item
Returns void

onVisibleChange

onVisibleChange(open: boolean): void

- Defined in packages/zent/src/select/Select.tsx:426
Parameters
- open: boolean
Returns void

render

render(): Element

Overrides Component.render
- Defined in packages/zent/src/select/Select.tsx:945
Returns Element

renderPopoverContent

renderPopoverContent(i18n: II18nLocaleSelect): ReactNode

- Defined in packages/zent/src/select/Select.tsx:911
Parameters
- i18n: II18nLocaleSelect
Returns ReactNode

renderTagCollapsedTrigger

renderTagCollapsedTrigger(value: Item[]): Element

- Defined in packages/zent/src/select/Select.tsx:736
Parameters
- value: Item[]
Returns Element

renderTagList

renderTagList(value: Item[], i18n: II18nLocaleSelect): Element

- Defined in packages/zent/src/select/Select.tsx:744
Parameters
- value: Item[]
- i18n: II18nLocaleSelect
Returns Element

renderValue

renderValue(i18n: II18nLocaleSelect): ReactNode

- Defined in packages/zent/src/select/Select.tsx:700
Parameters
- i18n: II18nLocaleSelect
Returns ReactNode

resetKeyword

resetKeyword(source: "user-clear" | "user-change" | "popup-close" | "option-create"): void

- Defined in packages/zent/src/select/Select.tsx:493
Parameters
- source: "user-clear" | "user-change" | "popup-close" | "option-create"
Returns void

selectCurrentIndex

selectCurrentIndex(): void

- Defined in packages/zent/src/select/Select.tsx:548
Returns void

setKeyword

setKeyword(keyword: string, source: "user-clear" | "user-change" | "popup-close" | "option-create"): void

- Defined in packages/zent/src/select/Select.tsx:497
Parameters
- keyword: string
- source: "user-clear" | "user-change" | "popup-close" | "option-create"
Returns void

setState

setState<K>(state: ISelectState<Key, Item> | ((prevState: Readonly<ISelectState<Key, Item>>, props: Readonly<ISelectProps<Key, Item>>) => ISelectState<Key, Item> | Pick<ISelectState<Key, Item>, K>) | Pick<ISelectState<Key, Item>, K>, callback?: () => void): void

Inherited from Component.setState
- Defined in node_modules/@types/react/index.d.ts:485
Type parameters
- K: keyof ISelectState<Key, Item>
Parameters
- state: ISelectState<Key, Item> | ((prevState: Readonly<ISelectState<Key, Item>>, props: Readonly<ISelectProps<Key, Item>>) => ISelectState<Key, Item> | Pick<ISelectState<Key, Item>, K>) | Pick<ISelectState<Key, Item>, K>
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

Optional shouldComponentUpdate

shouldComponentUpdate(nextProps: Readonly<ISelectProps<Key, Item>>, nextState: Readonly<ISelectState<Key, Item>>, nextContext: any): boolean

Inherited from Component.shouldComponentUpdate
- Defined in node_modules/@types/react/index.d.ts:630
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
- nextProps: Readonly<ISelectProps<Key, Item>>
- nextState: Readonly<ISelectState<Key, Item>>
- nextContext: any
Returns boolean

tryReviveOption

tryReviveOption(props: ISelectProps<Key, Item>): void

- Defined in packages/zent/src/select/Select.tsx:377
Parameters
- props: ISelectProps<Key, Item>
Returns void

Static getDerivedStateFromProps

getDerivedStateFromProps<Key, Item>(props: ISelectProps<Key, Item>, state: ISelectState<Key, Item>): Partial<ISelectState<Key, Item>>

- Defined in packages/zent/src/select/Select.tsx:307
Type parameters
- Key: string | number = string | number
- Item: ISelectItem<Key, Item> = ISelectItem<Key>
Parameters
- props: ISelectProps<Key, Item>
- state: ISelectState<Key, Item>
Returns Partial<ISelectState<Key, Item>>

Type parameters

Key: string | number = string | number

Item: ISelectItem<Key> = ISelectItem<Key>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Key: string | number = string | number

Item: ISelectItem<Key, Item> = ISelectItem<Key>

Parameters

props: ISelectProps<Key, Item>

Returns Select<Key, Item>

Properties

context

filterOptions

Type declaration

Parameters

keyword: string

options: Item[] = []

filter: false | ((keyword: string, item: Item) => boolean)

creatable: boolean

isValidNewOption: (keyword: string, options: Item[]) => boolean

Parameters

keyword: string

options: Item[]

Returns boolean

value: Item | Item[]

Returns Item[]

inputRef

onKeywordChange

popoverRef

Readonly props

refs

Type declaration

[key: string]: ReactInstance

renderOption

state

triggerRef

Static contextType

Static defaultProps

Type declaration

clearable: boolean

creatable: boolean

filter: <Key, Item>(keyword: string, option: Item) => boolean

Type parameters

Key: string | number = string | number

Item: ISelectItem<Key, Item> = ISelectItem<Key>

Parameters

keyword: string

option: Item

Returns boolean

highlight: <Key, Item>(keyword: string, option: Item) => React.ReactNode

Type parameters

Key: string | number = string | number

Item: ISelectItem<Key, Item> = ISelectItem<Key>

Parameters

keyword: string

option: Item

Returns React.ReactNode

isEqual: <Key, Item>(a: Item, b: Item) => boolean

Type parameters

Key: string | number = string | number

Item: ISelectItem<Key, Item> = ISelectItem<Key>

Parameters

a: Item

b: Item

Returns boolean

isValidNewOption: <Key>(keyword: string, options: ISelectItem<Key>[]) => boolean

Type parameters

Key: string | number = string | number

Parameters

keyword: string

options: ISelectItem<Key>[]

Returns boolean

loading: boolean