Function useListSelection

A custom hook that manages the selection of rows in a list.

  • useListSelection(__namedParameters?): {
        deselectAll: (() => void);
        listProps: {
            onSelectedRows: ((rowIds: RowId[]) => void);
            selectedRows: RowId[];
        };
        selectedRows: RowId[];
        setSelectedRows: Dispatch<SetStateAction<RowId[]>>;
    }

  • Parameters

    • __namedParameters: Partial<IParams> = {}

    Returns {
        deselectAll: (() => void);
        listProps: {
            onSelectedRows: ((rowIds: RowId[]) => void);
            selectedRows: RowId[];
        };
        selectedRows: RowId[];
        setSelectedRows: Dispatch<SetStateAction<RowId[]>>;
    }

    • An object containing the selected rows, list props, and a function to deselect all rows.
    • deselectAll: (() => void)
        • (): void

        • Returns void

    • ReadonlylistProps: {
          onSelectedRows: ((rowIds: RowId[]) => void);
          selectedRows: RowId[];
      }
      • ReadonlyonSelectedRows: ((rowIds: RowId[]) => void)
          • (rowIds): void

          • Parameters

            Returns void

      • selectedRows: RowId[]
    • selectedRows: RowId[]
    • setSelectedRows: Dispatch<SetStateAction<RowId[]>>

Settings

Member Visibility