mirror of https://github.com/portainer/portainer
248 lines
6.9 KiB
TypeScript
248 lines
6.9 KiB
TypeScript
import {
|
|
useTable,
|
|
useFilters,
|
|
useGlobalFilter,
|
|
useSortBy,
|
|
usePagination,
|
|
Column,
|
|
Row,
|
|
TableInstance,
|
|
TableState,
|
|
} from 'react-table';
|
|
import { ReactNode } from 'react';
|
|
import { useRowSelectColumn } from '@lineup-lite/hooks';
|
|
|
|
import { PaginationControls } from '@@/PaginationControls';
|
|
import { IconProps } from '@@/Icon';
|
|
|
|
import { Table } from './Table';
|
|
import { multiple } from './filter-types';
|
|
import { SearchBar, useSearchBarState } from './SearchBar';
|
|
import { SelectedRowsCount } from './SelectedRowsCount';
|
|
import { TableSettingsProvider } from './useZustandTableSettings';
|
|
import { useRowSelect } from './useRowSelect';
|
|
import { PaginationTableSettings, SortableTableSettings } from './types';
|
|
|
|
interface DefaultTableSettings
|
|
extends SortableTableSettings,
|
|
PaginationTableSettings {}
|
|
|
|
interface TitleOptionsVisible {
|
|
title: string;
|
|
icon?: IconProps['icon'];
|
|
featherIcon?: IconProps['featherIcon'];
|
|
hide?: never;
|
|
}
|
|
|
|
type TitleOptions = TitleOptionsVisible | { hide: true };
|
|
|
|
interface Props<
|
|
D extends Record<string, unknown>,
|
|
TSettings extends DefaultTableSettings
|
|
> {
|
|
dataset: D[];
|
|
storageKey: string;
|
|
columns: readonly Column<D>[];
|
|
renderTableSettings?(instance: TableInstance<D>): ReactNode;
|
|
renderTableActions?(selectedRows: D[]): ReactNode;
|
|
settingsStore: TSettings;
|
|
disableSelect?: boolean;
|
|
getRowId?(row: D): string;
|
|
isRowSelectable?(row: Row<D>): boolean;
|
|
emptyContentLabel?: string;
|
|
titleOptions: TitleOptions;
|
|
initialTableState?: Partial<TableState<D>>;
|
|
isLoading?: boolean;
|
|
totalCount?: number;
|
|
description?: JSX.Element;
|
|
}
|
|
|
|
export function Datatable<
|
|
D extends Record<string, unknown>,
|
|
TSettings extends DefaultTableSettings
|
|
>({
|
|
columns,
|
|
dataset,
|
|
storageKey,
|
|
renderTableSettings,
|
|
renderTableActions,
|
|
settingsStore,
|
|
disableSelect,
|
|
getRowId = defaultGetRowId,
|
|
isRowSelectable = () => true,
|
|
titleOptions,
|
|
emptyContentLabel,
|
|
initialTableState = {},
|
|
isLoading,
|
|
totalCount = dataset.length,
|
|
description,
|
|
}: Props<D, TSettings>) {
|
|
const [searchBarValue, setSearchBarValue] = useSearchBarState(storageKey);
|
|
|
|
const tableInstance = useTable<D>(
|
|
{
|
|
defaultCanFilter: false,
|
|
columns,
|
|
data: dataset,
|
|
filterTypes: { multiple },
|
|
initialState: {
|
|
pageSize: settingsStore.pageSize || 10,
|
|
sortBy: [settingsStore.sortBy],
|
|
globalFilter: searchBarValue,
|
|
...initialTableState,
|
|
},
|
|
isRowSelectable,
|
|
autoResetSelectedRows: false,
|
|
getRowId,
|
|
stateReducer: (newState, action) => {
|
|
switch (action.type) {
|
|
case 'setGlobalFilter':
|
|
setSearchBarValue(action.filterValue);
|
|
break;
|
|
case 'toggleSortBy':
|
|
settingsStore.setSortBy(action.columnId, action.desc);
|
|
break;
|
|
case 'setPageSize':
|
|
settingsStore.setPageSize(action.pageSize);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
return newState;
|
|
},
|
|
},
|
|
useFilters,
|
|
useGlobalFilter,
|
|
useSortBy,
|
|
usePagination,
|
|
useRowSelect,
|
|
!disableSelect ? useRowSelectColumn : emptyPlugin
|
|
);
|
|
|
|
const {
|
|
selectedFlatRows,
|
|
getTableProps,
|
|
getTableBodyProps,
|
|
headerGroups,
|
|
page,
|
|
prepareRow,
|
|
gotoPage,
|
|
setPageSize,
|
|
setGlobalFilter,
|
|
state: { pageIndex, pageSize },
|
|
} = tableInstance;
|
|
|
|
const tableProps = getTableProps();
|
|
const tbodyProps = getTableBodyProps();
|
|
|
|
const selectedItems = selectedFlatRows.map((row) => row.original);
|
|
|
|
return (
|
|
<div className="row">
|
|
<div className="col-sm-12">
|
|
<TableSettingsProvider settings={settingsStore}>
|
|
<Table.Container>
|
|
{isTitleVisible(titleOptions) && (
|
|
<Table.Title
|
|
label={titleOptions.title}
|
|
icon={titleOptions.icon}
|
|
featherIcon={titleOptions.featherIcon}
|
|
description={description}
|
|
>
|
|
<SearchBar value={searchBarValue} onChange={setGlobalFilter} />
|
|
{renderTableActions && (
|
|
<Table.Actions>
|
|
{renderTableActions(selectedItems)}
|
|
</Table.Actions>
|
|
)}
|
|
<Table.TitleActions>
|
|
{!!renderTableSettings && renderTableSettings(tableInstance)}
|
|
</Table.TitleActions>
|
|
</Table.Title>
|
|
)}
|
|
<Table
|
|
className={tableProps.className}
|
|
role={tableProps.role}
|
|
style={tableProps.style}
|
|
>
|
|
<thead>
|
|
{headerGroups.map((headerGroup) => {
|
|
const { key, className, role, style } =
|
|
headerGroup.getHeaderGroupProps();
|
|
return (
|
|
<Table.HeaderRow<D>
|
|
key={key}
|
|
className={className}
|
|
role={role}
|
|
style={style}
|
|
headers={headerGroup.headers}
|
|
/>
|
|
);
|
|
})}
|
|
</thead>
|
|
<tbody
|
|
className={tbodyProps.className}
|
|
role={tbodyProps.role}
|
|
style={tbodyProps.style}
|
|
>
|
|
<Table.Content<D>
|
|
rows={page}
|
|
isLoading={isLoading}
|
|
prepareRow={prepareRow}
|
|
emptyContent={emptyContentLabel}
|
|
renderRow={(row, { key, className, role, style }) => (
|
|
<Table.Row<D>
|
|
cells={row.cells}
|
|
key={key}
|
|
className={className}
|
|
role={role}
|
|
style={style}
|
|
/>
|
|
)}
|
|
/>
|
|
</tbody>
|
|
</Table>
|
|
<Table.Footer>
|
|
<SelectedRowsCount value={selectedFlatRows.length} />
|
|
<PaginationControls
|
|
showAll
|
|
pageLimit={pageSize}
|
|
page={pageIndex + 1}
|
|
onPageChange={(p) => gotoPage(p - 1)}
|
|
totalCount={totalCount}
|
|
onPageLimitChange={setPageSize}
|
|
/>
|
|
</Table.Footer>
|
|
</Table.Container>
|
|
</TableSettingsProvider>
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function isTitleVisible(
|
|
titleSettings: TitleOptions
|
|
): titleSettings is TitleOptionsVisible {
|
|
return !titleSettings.hide;
|
|
}
|
|
|
|
function defaultGetRowId<D extends Record<string, unknown>>(row: D): string {
|
|
if (row.id && (typeof row.id === 'string' || typeof row.id === 'number')) {
|
|
return row.id.toString();
|
|
}
|
|
|
|
if (row.Id && (typeof row.Id === 'string' || typeof row.Id === 'number')) {
|
|
return row.Id.toString();
|
|
}
|
|
|
|
if (row.ID && (typeof row.ID === 'string' || typeof row.ID === 'number')) {
|
|
return row.ID.toString();
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
function emptyPlugin() {}
|
|
|
|
emptyPlugin.pluginName = 'emptyPlugin';
|