API Reference > ui-framework > Picker > ListPicker

ListPicker<S, SS, S> Class

Beta

List Picker that lets the user pick from a list of items to enable/disable It also provides options to enable all, disable all and invert selection

Extends

Methods

Name Description
constructor(props: ListPickerPropsExtended): ListPicker Creates a ListPicker  
isSpecialItem(item: ListItem): boolean Checks if item is a special item.  
render(): Element Renders ListPicker  

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<ListPickerPropsExtended>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<ListPickerPropsExtended>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentDidMount(): void Optional ComponentLifecycle Called immediately after a component is mounted.
componentDidUpdate(prevProps: Readonly<ListPickerPropsExtended>, prevState: Readonly<S>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<ListPickerPropsExtended>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUnmount(): void Optional ComponentLifecycle Called immediately before a component is destroyed.
componentWillUpdate(nextProps: Readonly<ListPickerPropsExtended>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component  
getSnapshotBeforeUpdate(prevProps: Readonly<ListPickerPropsExtended>, prevState: Readonly<S>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate.
setState<K extends undefined>(state: (prevState: Readonly<S>, props: Readonly<ListPickerPropsExtended>) => null | S | object | null | S | object, callback?: () => void): void Component  
shouldComponentUpdate(nextProps: Readonly<ListPickerPropsExtended>, nextState: Readonly<S>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Properties

Name Type Description
Key_All Accessor StaticReadOnly number    
Key_Invert Accessor StaticReadOnly number    
Key_None Accessor StaticReadOnly number    
Key_Separator Accessor StaticReadOnly number    

Inherited properties

Name Type Inherited from Description
context any Component If using the new style context, re-declare this in your class to be the
React.ContextType of your static contextType.
contextType Static undefined | Context<any> Component If set, this.context will be set at runtime to the current value of the given Context.
props undefined Component  
refs [key: string]: ReactInstance Component  
state Readonly<S> Component  

Defined in

Last Updated: 08 January, 2020