Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

try to get display columns to go in and out on state change #193

Merged
merged 3 commits into from
Dec 5, 2023
Merged

try to get display columns to go in and out on state change #193

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57e6492
try to get display columns to go in and out on state change
naughton Nov 21, 2023
2e5a286
Merge branch 'v2' into late-bound-enables
KevinVandy Dec 5, 2023
5a29bb0
fix column order and create dynamic editing example
KevinVandy Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
310 changes: 173 additions & 137 deletions packages/mantine-react-table/src/hooks/useMRT_DisplayColumns.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ import { MRT_ExpandAllButton } from '../buttons/MRT_ExpandAllButton';
import { MRT_ExpandButton } from '../buttons/MRT_ExpandButton';
import { MRT_ToggleRowActionMenuButton } from '../buttons/MRT_ToggleRowActionMenuButton';
import { MRT_SelectCheckbox } from '../inputs/MRT_SelectCheckbox';
import {
type MRT_ColumnDef,
type MRT_ColumnOrderState,
type MRT_GroupingState,
type MRT_DefinedTableOptions,
type MRT_Row,
import type {
MRT_ColumnDef,
MRT_ColumnOrderState,
MRT_DefinedTableOptions,
MRT_DisplayColumnIds,
MRT_GroupingState,
MRT_Localization,
MRT_Row,
} from '../types';

interface Params<TData extends Record<string, any> = {}> {
Expand All @@ -21,135 +23,169 @@ interface Params<TData extends Record<string, any> = {}> {
tableOptions: MRT_DefinedTableOptions<TData>;
}

export const useMRT_DisplayColumns = <TData extends Record<string, any> = {}>({
creatingRow,
columnOrder,
grouping,
tableOptions,
}: Params<TData>) => {
return useMemo(
() =>
(
[
(tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-pin',
) && {
Cell: ({ row, table }) => (
<MRT_TableBodyRowPinButton row={row} table={table} />
),
header: tableOptions.localization.pin,
size: 60,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-pin'],
id: 'mrt-row-pin',
},
(tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-drag',
) && {
Cell: ({ row, rowRef, table }) => (
<MRT_TableBodyRowGrabHandle
row={row}
rowRef={rowRef as RefObject<HTMLTableRowElement>}
table={table}
/>
),
header: tableOptions.localization.move,
size: 60,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-drag'],
id: 'mrt-row-drag',
},
((tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-actions',
) ||
(creatingRow && tableOptions.createDisplayMode === 'row')) && {
Cell: ({ cell, row, table }) => (
<MRT_ToggleRowActionMenuButton
cell={cell}
row={row}
table={table}
/>
),
header: tableOptions.localization.actions,
size: 70,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-actions'],
id: 'mrt-row-actions',
},
(tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-expand',
) &&
showExpandColumn(
tableOptions,
tableOptions.state?.grouping ?? grouping,
) && {
Cell: ({ row, table }) => (
<MRT_ExpandButton row={row} table={table} />
),
Header: tableOptions.enableExpandAll
? ({ table }) => <MRT_ExpandAllButton table={table} />
: null,
header: tableOptions.localization.expand,
size: 60,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-expand'],
id: 'mrt-row-expand',
},
(tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-select',
) && {
Cell: ({ row, table }) => (
<MRT_SelectCheckbox row={row} table={table} />
),
Header:
tableOptions.enableSelectAll &&
tableOptions.enableMultiRowSelection
? ({ table }) => <MRT_SelectCheckbox selectAll table={table} />
: null,
header: tableOptions.localization.select,
size: 60,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-select'],
id: 'mrt-row-select',
},
(tableOptions.state?.columnOrder ?? columnOrder).includes(
'mrt-row-numbers',
) && {
Cell: ({ row }) => row.index + 1,
Header: () => tableOptions.localization.rowNumber,
header: tableOptions.localization.rowNumbers,
size: 60,
...tableOptions.defaultDisplayColumn,
...tableOptions.displayColumnDefOptions?.['mrt-row-numbers'],
id: 'mrt-row-numbers',
},
] as MRT_ColumnDef<TData>[]
).filter(Boolean),
[
columnOrder,
grouping,
tableOptions.displayColumnDefOptions,
tableOptions.editDisplayMode,
tableOptions.enableColumnDragging,
tableOptions.enableColumnFilterModes,
tableOptions.enableColumnOrdering,
tableOptions.enableEditing,
tableOptions.enableExpandAll,
tableOptions.enableExpanding,
tableOptions.enableGrouping,
tableOptions.enableRowActions,
tableOptions.enableRowDragging,
tableOptions.enableRowNumbers,
tableOptions.enableRowOrdering,
tableOptions.enableRowSelection,
tableOptions.enableSelectAll,
tableOptions.localization,
tableOptions.positionActionsColumn,
tableOptions.renderDetailPanel,
tableOptions.renderRowActionMenuItems,
tableOptions.renderRowActions,
tableOptions.state?.columnOrder,
tableOptions.state?.grouping,
],
);
export const useMRT_DisplayColumns = <TData extends Record<string, any> = {}>(
KevinVandy marked this conversation as resolved.
Show resolved Hide resolved
params: Params<TData>,
) => {
const { creatingRow, columnOrder, grouping, tableOptions } = params;
return useMemo(() => {
const order = tableOptions.state?.columnOrder ?? columnOrder;
const ret = [
makePinColumn(params, order),
makeDragColumn(params, order),
makeRowActionsColumn(params, order),
makeExpandColumn(params, order),
makeRowSelectColumn(params, order),
makeRowNumbersColumn(params, order),
].filter((x) => x) as MRT_ColumnDef<TData>[];
console.log('displayColumns', ret);
return ret;
}, [
creatingRow,
columnOrder,
grouping,
tableOptions.displayColumnDefOptions,
tableOptions.editDisplayMode,
tableOptions.enableColumnDragging,
tableOptions.enableColumnFilterModes,
tableOptions.enableColumnOrdering,
tableOptions.enableEditing,
tableOptions.enableExpandAll,
tableOptions.enableExpanding,
tableOptions.enableGrouping,
tableOptions.enableRowActions,
tableOptions.enableRowDragging,
tableOptions.enableRowNumbers,
tableOptions.enableRowOrdering,
tableOptions.enableRowSelection,
tableOptions.enableSelectAll,
tableOptions.localization,
tableOptions.positionActionsColumn,
tableOptions.renderDetailPanel,
tableOptions.renderRowActionMenuItems,
tableOptions.renderRowActions,
tableOptions.state?.columnOrder,
tableOptions.state?.grouping,
]);
};

function makePinColumn<TData extends Record<string, any> = {}>(
{ tableOptions }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-pin';
if (order.includes(id))
return {
Cell: ({ row, table }) => (
<MRT_TableBodyRowPinButton row={row} table={table} />
),
...defaultDisplayColumnProps(tableOptions, id, 'pin'),
};
return undefined;
}

function makeDragColumn<TData extends Record<string, any> = {}>(
{ tableOptions }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-drag';
if (order.includes(id))
return {
Cell: ({ row, rowRef, table }) => (
<MRT_TableBodyRowGrabHandle
row={row}
rowRef={rowRef as RefObject<HTMLTableRowElement>}
table={table}
/>
),
...defaultDisplayColumnProps(tableOptions, id, 'move'),
};
return undefined;
}

function makeRowActionsColumn<TData extends Record<string, any> = {}>(
{ tableOptions, creatingRow }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-actions';
if (
order.includes(id) ||
(creatingRow && tableOptions.createDisplayMode === 'row') ||
tableOptions.enableEditing
)
return {
Cell: ({ cell, row, table }) => (
<MRT_ToggleRowActionMenuButton cell={cell} row={row} table={table} />
),
...defaultDisplayColumnProps(tableOptions, id, 'actions', 70),
};
return undefined;
}

function makeExpandColumn<TData extends Record<string, any> = {}>(
{ tableOptions, grouping }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-expand';
if (
order.includes(id) &&
showExpandColumn(tableOptions, tableOptions.state?.grouping ?? grouping)
)
return {
Cell: ({ row, table }) => <MRT_ExpandButton row={row} table={table} />,
Header: tableOptions.enableExpandAll
? ({ table }) => <MRT_ExpandAllButton table={table} />
: null,
...defaultDisplayColumnProps(tableOptions, id, 'expand'),
};
return undefined;
}

function makeRowSelectColumn<TData extends Record<string, any> = {}>(
{ tableOptions }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-select';
if (order.includes(id))
return {
Cell: ({ row, table }) => <MRT_SelectCheckbox row={row} table={table} />,
Header:
tableOptions.enableSelectAll && tableOptions.enableMultiRowSelection
? ({ table }) => <MRT_SelectCheckbox selectAll table={table} />
: null,
...defaultDisplayColumnProps(tableOptions, id, 'select'),
};
return undefined;
}

function makeRowNumbersColumn<TData extends Record<string, any> = {}>(
{ tableOptions }: Params<TData>,
order: MRT_ColumnOrderState,
): MRT_ColumnDef<TData> | undefined {
const id: MRT_DisplayColumnIds = 'mrt-row-numbers';
if (order.includes(id) || tableOptions.enableRowNumbers)
return {
Cell: ({ row }) => row.index + 1,
Header: () => tableOptions.localization.rowNumber,
...defaultDisplayColumnProps(tableOptions, id, 'rowNumbers'),
};
return undefined;
}

function defaultDisplayColumnProps<TData extends Record<string, any> = {}>(
{
defaultDisplayColumn,
displayColumnDefOptions,
localization,
}: MRT_DefinedTableOptions<TData>,
id: MRT_DisplayColumnIds,
header: keyof MRT_Localization,
size = 60,
) {
return {
size,
header: localization[header]!,
...defaultDisplayColumn,
...displayColumnDefOptions?.[id],
id,
};
}
4 changes: 2 additions & 2 deletions packages/mantine-react-table/src/hooks/useMRT_TableInstance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ export const useMRT_TableInstance: <TData extends Record<string, any> = {}>(

const initialState: Partial<MRT_TableState<TData>> = useMemo(() => {
const initState = tableOptions.initialState ?? {};
initState.columnOrder =
initState.columnOrder ?? getDefaultColumnOrderIds(tableOptions);
// initState.columnOrder =
// initState.columnOrder ?? getDefaultColumnOrderIds(tableOptions);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but a bit concerned about what's going on here

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem introduced here is that this is simply turning off the column ordering feature entirely within MRT. That's why dynamic columns seem to start working. This means though that when column ordering is turned on by the developer, everything breaks again.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I knew I was out over my skis here, which is where I stopped and solved it another way in my app.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just got stuff working. Check out the new dynamic editing and row number example @naughton

initState.globalFilterFn = tableOptions.globalFilterFn ?? 'fuzzy';
return initState;
}, []);
Expand Down
Loading
Loading