Function useList

Creates a ListPicker modal with default or custom configurations and returns a promise that resolves with the selected rows.

useList<RowData extends IRowData = any>(
    options: IParams<RowData>,
): (
    __namedParameters?: Partial<IParams<RowData>>,
) => {
    then: (onData: Fn) => void;
    toPromise: () => Promise<null | RowData[]>;
}
Type Parameters
- RowData extends IRowData = any
  The type of the row data.
Parameters
- options: IParams<RowData>
  The options object.
  - handler
    The handler function to be called when a row is selected.
  - columns
    The columns to be displayed in the ListPicker.
  - rowActions
    The actions to be displayed for each row in the ListPicker.
  - payload
    The payload to be passed to the ListPicker component.
  - features
    The features to be enabled in the ListPicker.
  - selectionMode
    The selection mode for the ListPicker.
  - title
    The title of the ListPicker modal.
  - minWidth
    The minimum width of the ListPicker modal.
  - minHeight
    The minimum height of the ListPicker modal.
  - selectedRows
    The initially selected rows in the ListPicker.
Returns (
    __namedParameters?: Partial<IParams<RowData>>,
) => {
    then: (onData: Fn) => void;
    toPromise: () => Promise<null | RowData[]>;
}
- A function that creates and opens the ListPicker modal.
- Defined in types.d.ts:6862