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.

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

feat(DataTable): add support for table row statuses #2073

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions src/components/DataTable/DataTable.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
align-items: flex-start;
font: var(--eds-theme-typography-title-md);
height: 100%;
overflow: hidden;

border-right: calc(var(--eds-border-width-sm) * 1px) solid transparent;

Expand Down Expand Up @@ -127,12 +128,28 @@
}
}

.data-table__status-cell {
height: 100%;

display: flex;
align-items: center;
justify-content: center;
}

.data-table__status-header-cell {
height: 1px;
width: 1px;
overflow: hidden;
text-indent: 9999;
}

.data-table__cell {
display: flex;
gap: calc(var(--eds-size-1) / 16 * 1rem);
align-items: flex-start;
font: var(--eds-theme-typography-body-md);
height: 100%;
overflow: hidden;

border-right: calc(var(--eds-border-width-sm) * 1px) solid transparent;

Expand Down Expand Up @@ -288,3 +305,31 @@
background-color: var(--eds-theme-color-background-utility-interactive-low-emphasis);
}
}

.data-table .data-table__status-cell {
&.data-table--status-critical {
color: var(--eds-theme-color-icon-utility-critical)
}

&.data-table--status-favorable {
color: var(--eds-theme-color-icon-utility-favorable);
}

&.data-table--status-warning {
color: var(--eds-theme-color-icon-utility-warning);
}
}

.data-table .data-table__row {
&.data-table--status-critical {
background-color: var(--eds-theme-color-background-utility-critical-low-emphasis);
}

&.data-table--status-favorable {
background-color: var(--eds-theme-color-background-utility-favorable-low-emphasis);
}

&.data-table--status-warning {
background-color: var(--eds-theme-color-background-utility-warning-low-emphasis);
}
}
96 changes: 94 additions & 2 deletions src/components/DataTable/DataTable.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
DataTableRow,
DataTableHeader,
type DataTableProps,
type DataTableWithStatus,
} from './DataTable';

// We import all of the utilities from tanstack here, and this can contain other custom utilities
Expand Down Expand Up @@ -53,13 +54,14 @@ export default {
type Args = DataTableProps;

// Specifying an example data type for the rows of a table
type Person = {
// This column is used for tables that are eligible for status
type Person = DataTableWithStatus<{
firstName: string;
lastName: string;
age: number;
visits: number;
progress: number;
};
}>;

// Specifying the example (static) data for the table to use with tanstack primitives
const defaultData: Person[] = [
Expand All @@ -76,6 +78,7 @@ const defaultData: Person[] = [
age: 40,
visits: 40,
progress: 80,
status: 'warning',
},
{
firstName: 'Tanner',
Expand All @@ -90,6 +93,7 @@ const defaultData: Person[] = [
age: 45,
visits: 20,
progress: 10,
status: 'critical',
},
{
firstName: 'Tandy',
Expand All @@ -111,6 +115,7 @@ const defaultData: Person[] = [
age: 45,
visits: 20,
progress: 10,
status: 'favorable',
},
{
firstName: 'Tandy',
Expand Down Expand Up @@ -700,6 +705,93 @@ export const Grouping: StoryObj<Args> = {
},
};

/**
* You can specify detailed statuses for each row in a table, matching a few common options.
* Extend the data type to include `status` which maps to the internal type
*
* Use `DataTableWithStatus` on your data type model to add in the column handler. this
* will add add a `status` item, to be used with a column with header name `DataTable.__StatusColumnId__`.
*/
export const StatusRows: StoryObj<Args> = {
args: {
caption: 'Test table',
subcaption: 'Additional Subcaption',
isStatusEligible: true,
tableStyle: 'border',
rowStyle: 'lined',
size: 'sm',
},
render: (args) => {
const columns = [
columnHelper.accessor(DataTable.__StatusColumnId__, {
header: () => <DataTable.StatusHeaderCell />,
cell: (info) => <DataTable.StatusCell status={info.getValue()} />,
size: 32,
Copy link
Contributor Author

@booc0mtaco booc0mtaco Oct 18, 2024

Choose a reason for hiding this comment

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

TODO add / use some token here?

}),
columnHelper.accessor('firstName', {
header: () => (
<DataTable.HeaderCell sortDirection="ascending">
First Name
</DataTable.HeaderCell>
),
cell: (info) => (
<DataTable.DataCell>{info.getValue()}</DataTable.DataCell>
),
}),
columnHelper.accessor((row) => row.lastName, {
id: 'lastName',
header: () => <DataTable.HeaderCell>Last Name</DataTable.HeaderCell>,
cell: (info) => (
<DataTable.DataCell>{info.getValue()}</DataTable.DataCell>
),
}),
columnHelper.accessor('age', {
header: () => (
<DataTable.HeaderCell alignment="trailing">Age</DataTable.HeaderCell>
),
cell: (info) => (
<DataTable.DataCell alignment="trailing">
{info.renderValue()}
</DataTable.DataCell>
),
}),
columnHelper.accessor('visits', {
header: () => (
<DataTable.HeaderCell alignment="trailing">
Visits
</DataTable.HeaderCell>
),
cell: (info) => (
<DataTable.DataCell alignment="trailing">
{info.renderValue()}
</DataTable.DataCell>
),
}),
columnHelper.accessor('progress', {
header: () => (
<DataTable.HeaderCell alignment="trailing">
Profile Progress
</DataTable.HeaderCell>
),
cell: (info) => (
<DataTable.DataCell alignment="trailing">
{info.renderValue()}
</DataTable.DataCell>
),
}),
];

// eslint-disable-next-line react-hooks/rules-of-hooks
const table = DataTableUtils.useReactTable({
data: defaultData,
columns,
getCoreRowModel: DataTableUtils.getCoreRowModel(),
});

return <DataTable {...args} table={table} />;
},
};

// TODO: Story for sticky column pinning (https://tanstack.com/table/latest/docs/framework/react/examples/column-pinning-sticky)

export const DefaultWithCustomTable: StoryObj<Args> = {
Expand Down
Loading
Loading