@purpurds/table 0.0.1

package/src/table-toolbar.test.tsx

@@ -0,0 +1,95 @@
+import React from "react";
+import { render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { axe } from "vitest-axe";
+
+import { TableToolbar } from "./table-toolbar";
+import { copy, Selectors } from "./test-utils/helpers";
+
+const setDrawerIsOpenMock = vi.fn();
+const resetColumnFiltersMock = vi.fn();
+const toggleExpandMock = vi.fn();
+const exportDataMock = vi.fn();
+
+describe("Data table - Tool bar", () => {
+  let container: HTMLElement;
+
+  beforeEach(() => {
+    container = render(
+      // Needs an element with id purpur-table for the ally tests to not fail with "ARIA attributes must conform to valid values (aria-valid-attr-value)" rule
+      <div id="purpur-table">
+        <TableToolbar
+          onResetColumnFilters={resetColumnFiltersMock}
+          onSetDrawerIsOpen={setDrawerIsOpenMock}
+          onToggleExpand={toggleExpandMock}
+          onExportData={exportDataMock}
+          visibleRowCount={10}
+          totalRowCount={14}
+          toolbarCopy={copy.toolbar}
+          isSettingsDrawerOpen={false}
+          isExportDrawerOpen={false}
+          hasExportsDrawer={true}
+          showFilters={true}
+          disableClearFilters={false}
+        />
+      </div>
+    ).container;
+  });
+
+  it("should display 'Showing 10 of 14 rows'", () => {
+    const tableRowsCount = screen.getByTestId(Selectors.TOOLBAR.TABLE_ROWS_COUNT);
+    expect(tableRowsCount).toHaveTextContent("Showing 10 of 14 rows");
+  });
+
+  it("should have a clear filters button", () => {
+    const clearFiltersButton = screen.getByTestId(Selectors.TOOLBAR.CLEAR_FILTERS_BUTTON);
+    expect(clearFiltersButton).toHaveTextContent("Clear filters");
+  });
+
+  it("should have export button", () => {
+    const exportButton = screen.getByTestId(Selectors.TOOLBAR.EXPORT_BUTTON);
+    expect(exportButton).toHaveTextContent("Export");
+  });
+
+  it("should have settings button", () => {
+    const settingsButton = screen.getByTestId(Selectors.TOOLBAR.SETTINGS_BUTTON);
+    expect(settingsButton).toHaveTextContent("Settings");
+  });
+
+  it("should have expand button", () => {
+    const expandButton = screen.getByTestId(Selectors.TOOLBAR.EXPAND_BUTTON);
+    expect(expandButton).toHaveTextContent("Expand");
+  });
+
+  it("should send 'resetColumnFilters' event when clicking on 'Clear filters' button", async () => {
+    const clearFiltersButton = screen.getByTestId(Selectors.TOOLBAR.CLEAR_FILTERS_BUTTON);
+    await userEvent.click(clearFiltersButton);
+    expect(resetColumnFiltersMock).toHaveBeenCalled();
+  });
+
+  it("should send 'setDrawerIsOpen' event when clicking on 'Settings' button", async () => {
+    const settingsButton = screen.getByTestId(Selectors.TOOLBAR.SETTINGS_BUTTON);
+    await userEvent.click(settingsButton);
+    expect(setDrawerIsOpenMock).toHaveBeenCalled();
+  });
+
+  it("should send 'exportData' event when clicking on export", async () => {
+    const exportButton = screen.getByTestId(Selectors.TOOLBAR.EXPORT_BUTTON);
+    await userEvent.click(exportButton);
+    expect(exportDataMock).toHaveBeenCalled();
+  });
+
+  it("should send an event when clicking on expand", async () => {
+    const expandButton = screen.getByTestId(Selectors.TOOLBAR.EXPAND_BUTTON);
+    await userEvent.click(expandButton);
+    expect(toggleExpandMock).toHaveBeenCalled();
+  });
+
+  it("should be accessible", async () => {
+    const results = await axe(container);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(results).toHaveNoViolations();
+  });
+});

package/src/table-toolbar.tsx

@@ -0,0 +1,136 @@
+import React from "react";
+import { Button } from "@purpurds/button";
+import { IconDownload } from "@purpurds/icon/download";
+import { IconMaximize } from "@purpurds/icon/maximize";
+import { IconSettings } from "@purpurds/icon/settings";
+import { Paragraph } from "@purpurds/paragraph";
+import c from "classnames/bind";
+
+import styles from "./table-toolbar.module.scss";
+
+export type TableToolbarCopyProps = {
+  buttons?: {
+    export?: string;
+    settings?: string;
+    expand?: string;
+    clearFilters?: string;
+  };
+  ariaLabels?: {
+    export?: string;
+    settings?: string;
+    expand?: string;
+    clearFilters?: string;
+  };
+  rowCount?: {
+    showing: string;
+    of: string;
+    rows: string;
+  };
+};
+
+export type TableToolbarProps = {
+  onSetDrawerIsOpen: React.Dispatch<React.SetStateAction<boolean>>;
+  onResetColumnFilters: () => void;
+  onToggleExpand?: () => void;
+  onExportData?: () => void;
+  visibleRowCount: number;
+  totalRowCount: number;
+  toolbarCopy?: TableToolbarCopyProps;
+  isSettingsDrawerOpen: boolean;
+  isExportDrawerOpen: boolean;
+  hasExportsDrawer: boolean;
+  showFilters: boolean;
+  disableClearFilters: boolean;
+};
+
+const rootClassName = "purpur-table-toolbar";
+const cx = c.bind(styles);
+const rootTestId = "purpur-table-toolbar";
+
+export const TableToolbar = ({
+  onExportData,
+  onResetColumnFilters,
+  onSetDrawerIsOpen,
+  onToggleExpand,
+  disableClearFilters,
+  hasExportsDrawer,
+  isExportDrawerOpen,
+  isSettingsDrawerOpen,
+  showFilters,
+  toolbarCopy: copy,
+  totalRowCount,
+  visibleRowCount,
+}: TableToolbarProps) => {
+  return (
+    <div data-testid={rootTestId} className={cx(rootClassName)}>
+      <div className={cx(`${rootClassName}__content`)}>
+        {copy?.rowCount && (
+          <Paragraph data-testid={`${rootTestId}-table-rows-count`}>
+            {`${copy.rowCount.showing} ${visibleRowCount} ${copy.rowCount.of} ${totalRowCount} ${copy.rowCount.rows}`}
+          </Paragraph>
+        )}
+        {copy?.buttons?.clearFilters && showFilters && (
+          <Button
+            data-testid={`${rootTestId}-clear-filters-button`}
+            variant="text"
+            onClick={onResetColumnFilters}
+            type="button"
+            aria-label={copy?.ariaLabels?.clearFilters}
+            aria-controls="purpur-table"
+            disabled={disableClearFilters}
+          >
+            {copy.buttons.clearFilters}
+          </Button>
+        )}
+      </div>
+
+      <div className={cx(`${rootClassName}__content`)}>
+        {copy?.buttons?.export && (
+          <Button
+            data-testid={`${rootTestId}-export-button`}
+            variant="text"
+            type="button"
+            onClick={onExportData}
+            aria-label={copy?.ariaLabels?.export}
+            {...(hasExportsDrawer && {
+              "aria-expanded": isExportDrawerOpen,
+              "aria-controls": "purpur-table-export-drawer",
+              "aria-haspopup": "dialog",
+            })}
+          >
+            <IconDownload size="xs" />
+            {copy.buttons.export}
+          </Button>
+        )}
+        {copy?.buttons?.settings && (
+          <Button
+            data-testid={`${rootTestId}-settings-button`}
+            variant="text"
+            onClick={() => onSetDrawerIsOpen(true)}
+            type="button"
+            aria-label={copy?.ariaLabels?.settings}
+            aria-expanded={isSettingsDrawerOpen}
+            aria-controls="purpur-table-settings-drawer"
+            aria-haspopup="dialog"
+          >
+            <IconSettings size="xs" />
+            {copy.buttons.settings}
+          </Button>
+        )}
+        {onToggleExpand && copy?.buttons?.expand && (
+          <Button
+            data-testid={`${rootTestId}-expand-button`}
+            variant="text"
+            onClick={() => onToggleExpand()}
+            type="button"
+            aria-label={copy?.ariaLabels?.expand}
+            aria-controls="purpur-table"
+          >
+            <IconMaximize size="xs" />
+            {copy.buttons.expand}
+          </Button>
+        )}
+      </div>
+    </div>
+  );
+};

package/src/table.module.scss

@@ -0,0 +1,367 @@
+@use "@purpurds/tokens/breakpoint/variables" as *;
+
+.purpur-table {
+  --table-border: var(--purpur-border-width-xs) solid var(--purpur-color-border-weak);
+  --table-border-radius: var(--purpur-border-radius-lg);
+  display: flex;
+  overflow: hidden;
+  flex-direction: column;
+  gap: var(--purpur-spacing-200);
+  z-index: 1;
+  max-width: fit-content;
+  background-color: inherit;
+}
+
+.purpur-table__container {
+  overflow-x: scroll;
+  overflow-y: auto;
+
+  &:has(.purpur-table-column-header-cell__first-header-visible) {
+    border-top-left-radius: var(--table-border-radius);
+  }
+
+  &:has(.purpur-table-column-header-cell__last-header-visible) {
+    border-top-right-radius: var(--table-border-radius);
+  }
+
+  &:has(.purpur-table-row-cell__last-row-first-cell-visible) {
+    border-bottom-left-radius: var(--table-border-radius);
+  }
+
+  &:has(.purpur-table-row-cell__last-row-last-cell-visible) {
+    border-bottom-right-radius: var(--table-border-radius);
+  }
+}
+
+.purpur-table__table {
+  table-layout: auto;
+  border-collapse: separate;
+  border-spacing: 0;
+  position: relative;
+}
+
+.purpur-table-header {
+  .purpur-table-column-header-cell {
+    border-top: var(--table-border);
+
+    &:first-of-type {
+      border-left: var(--table-border);
+    }
+
+    &:last-of-type {
+      border-right: var(--table-border);
+    }
+
+    &__sticky-header {
+      position: sticky;
+      top: 0;
+      z-index: 4;
+      background-color: inherit;
+    }
+
+    &__sticky-column {
+      z-index: 5;
+    }
+  }
+
+  &--has-filters {
+    .purpur-table-row {
+      vertical-align: baseline;
+    }
+  }
+}
+
+.purpur-table-column-header-cell {
+  padding: var(--purpur-spacing-150) var(--purpur-spacing-150) var(--purpur-spacing-150)
+    var(--purpur-spacing-300);
+  border-bottom: var(--table-border);
+  text-align: left;
+
+  &__checkbox {
+    vertical-align: middle;
+  }
+
+  &__border-radius-first-cell {
+    border-top-left-radius: var(--table-border-radius);
+  }
+
+  &__border-radius-last-cell {
+    border-top-right-radius: var(--table-border-radius);
+  }
+
+  &__content {
+    display: flex;
+    flex-direction: column;
+    align-items: flex-start;
+    gap: var(--purpur-spacing-100);
+  }
+
+  &__title {
+    display: flex;
+    align-items: center;
+    gap: var(--purpur-spacing-50);
+    align-self: stretch;
+  }
+
+  &__sortable-title {
+    padding-left: 0;
+  }
+
+  &__filter-wrapper {
+    display: flex;
+    padding-right: var(--purpur-spacing-150);
+    flex-direction: column;
+    align-items: flex-start;
+    gap: var(--purpur-spacing-100);
+    align-self: stretch;
+  }
+}
+
+.purpur-table-row {
+  .purpur-table-row-cell {
+    &:first-of-type {
+      border-left: var(--table-border);
+    }
+
+    &:last-of-type {
+      border-right: var(--table-border);
+    }
+
+    &.purpur-table-row-cell__border-radius-first-cell {
+      border-bottom-left-radius: var(--table-border-radius);
+    }
+
+    &.purpur-table-row-cell__border-radius-last-cell {
+      border-bottom-right-radius: var(--table-border-radius);
+    }
+  }
+
+  &:last-of-type {
+    .purpur-table-row-cell {
+      border-bottom: var(--table-border);
+    }
+  }
+
+  &:has(.purpur-table-row-cell__row-selection),
+  &:has(.purpur-table-row-cell__row-toggle) {
+    .purpur-table-row-cell:hover {
+      &:first-of-type {
+        &::before {
+          content: "";
+          position: absolute;
+          left: calc(-1 * var(--purpur-border-width-xs));
+          top: 0;
+          bottom: 0;
+          width: var(--purpur-border-width-md);
+          background-color: var(--purpur-color-border-weak);
+        }
+      }
+    }
+  }
+
+  &--selected td:first-of-type {
+    &::before {
+      content: "";
+      position: absolute;
+      left: calc(-1 * var(--purpur-border-width-xs));
+      top: 0;
+      bottom: 0;
+      width: var(--purpur-border-width-md);
+      background-color: var(--purpur-color-border-interactive-primary);
+    }
+  }
+}
+
+.purpur-table-column-header-cell,
+.purpur-table-row-cell {
+  &__sticky-column {
+    position: sticky;
+    left: 0;
+    z-index: 3;
+    background-color: inherit;
+
+    & + .purpur-table-column-header-cell__sticky-column,
+    & + .purpur-table-row-cell__sticky-column {
+      left: 73px; // 73px is the width of the first column when row selection/toggle is enabled. This rule is only applied when the row selection/toggle is enabled.
+    }
+
+    &__with-sticky-border {
+      border-right: var(--purpur-border-width-sm) solid var(--purpur-color-border-base);
+      box-shadow: var(--purpur-border-width-sm) 0 calc(2 * var(--purpur-border-width-sm))
+        rgba(0, 0, 0, 0.05);
+    }
+  }
+}
+
+.purpur-table-row-cell {
+  height: var(--purpur-spacing-1200);
+  padding: var(--purpur-spacing-0) var(--purpur-spacing-300);
+  align-items: center;
+  align-self: stretch;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+
+  &__date {
+    display: flex;
+    align-items: center;
+    gap: var(--purpur-spacing-100);
+    flex: 1 0 0;
+  }
+
+  &__icon-text {
+    display: flex;
+    padding: var(--purpur-spacing-0) var(--purpur-spacing-300);
+    align-items: center;
+    gap: var(--purpur-spacing-100);
+    flex-shrink: 0;
+  }
+
+  &__error-message,
+  &__warning-message {
+    display: flex;
+    padding: var(--purpur-spacing-0) var(--purpur-spacing-300);
+    align-items: center;
+    gap: var(--purpur-spacing-100);
+    flex-shrink: 0;
+  }
+
+  &__row-toggle {
+    $target-area-size: calc(var(--purpur-spacing-400) + var(--purpur-spacing-150));
+    $radio-size: var(--purpur-spacing-300);
+
+    display: inline-flex;
+    padding: calc(calc($target-area-size - $radio-size) / 2);
+    margin: 0;
+    align-items: center;
+    background: var(--purpur-color-background-primary);
+    width: var(--purpur-spacing-300);
+    height: var(--purpur-spacing-300);
+    aspect-ratio: 1/1;
+    accent-color: var(--purpur-color-background-interactive-primary);
+
+    &:hover {
+      border-left: var(--purpur-border-width-md) solid var(--purpur-color-border-weak);
+      accent-color: var(--purpur-color-background-interactive-primary);
+      cursor: pointer;
+
+      &:disabled,
+      &[aria-checked="true"] {
+        cursor: default;
+      }
+    }
+
+    &:active {
+      outline: none;
+    }
+
+    &:focus {
+      outline: none;
+    }
+  }
+
+  &__right-align {
+    text-align: right;
+  }
+
+  &__truncate {
+    position: relative;
+    max-width: 100%;
+    width: 100%;
+
+    a,
+    p,
+    span,
+    div {
+      display: block;
+      overflow: hidden;
+      white-space: nowrap;
+      text-overflow: ellipsis;
+      max-width: 100%;
+      width: inherit;
+    }
+  }
+
+  &__skeleton {
+    height: 30%;
+    width: 100%;
+  }
+
+  &__tooltip-content {
+    z-index: 10;
+  }
+}
+
+.purpur-table--primary {
+  .purpur-table-header {
+    .purpur-table-row {
+      background: var(--purpur-color-background-primary);
+    }
+  }
+
+  .purpur-table-body {
+    .purpur-table-row {
+      background: var(--purpur-color-background-primary);
+
+      &:nth-of-type(odd) {
+        background: var(--purpur-color-background-secondary);
+      }
+    }
+  }
+}
+
+.purpur-table--secondary {
+  .purpur-table-header {
+    .purpur-table-row {
+      background: var(--purpur-color-background-secondary);
+    }
+  }
+
+  .purpur-table-body {
+    .purpur-table-row {
+      background: var(--purpur-color-background-secondary);
+
+      &:nth-of-type(odd) {
+        background: var(--purpur-color-background-primary);
+      }
+    }
+  }
+}
+
+.purpur-table__empty-section {
+  display: flex;
+  padding: var(--purpur-spacing-250) var(--purpur-spacing-400) var(--purpur-spacing-400)
+    var(--purpur-spacing-400);
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+  gap: var(--purpur-spacing-150);
+  align-self: stretch;
+
+  &__icon {
+    width: var(--purpur-spacing-1600);
+    height: var(--purpur-spacing-1600);
+    aspect-ratio: 1/1;
+    opacity: 0.9;
+  }
+
+  &__texts {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    gap: var(--purpur-spacing-100);
+    align-self: stretch;
+  }
+
+  &--primary {
+    background: var(--purpur-color-background-secondary);
+  }
+
+  &--secondary {
+    background: var(--purpur-color-background-primary);
+  }
+
+  @media (min-width: $purpur-breakpoint-md) {
+    padding: var(--purpur-spacing-250) var(--purpur-spacing-0) var(--purpur-spacing-400)
+      var(--purpur-spacing-0);
+  }
+}