Decoupling data table manager components

.changeset/shy-goats-obey.md

@@ -0,0 +1,6 @@
+---
+'@commercetools-uikit/data-table-manager': minor
+'@commercetools-uikit/data-table': minor
+---
+
+decouple the datatable manager from the data table to enable users position the data table manager settings dropdown anywhere in the DOM structure.

packages/components/data-table-manager/_docs/description.md

@@ -5,5 +5,6 @@ This component enhances the `<DataTable>` component and additionally provides a
 
 - The `disableDisplaySettings` enables / disables the layout settings panel, allowing the user to select wrapping text and density display options.
 - The `disableColumnManager` enables / disables the column manager panel, allowing the user to select which columns are visible.
+- To Detach the `DatatableManager` settings dropdown from the Datatable and position it anywhere else, you would need to import a `DataTableManagerProvider` and wrap both components with the provider.
 
 Both panels delegate the handling of the settings change on the parent through function properties, allowing the settings to be persisted or just used as state props.

packages/components/data-table-manager/_docs/usage-example.js

@@ -1,5 +1,8 @@
-import DataTableManager from '@commercetools-uikit/data-table-manager';
+import DataTableManager, {
+  DataTableManagerProvider,
+} from '@commercetools-uikit/data-table-manager';
 import DataTable from '@commercetools-uikit/data-table';
+import SearchTextInput from '@commercetools-uikit/search-text-input';
 
 const rows = [
   { id: 'parasite', title: 'Parasite', country: 'South Korea' },
@@ -12,10 +15,29 @@ const columns = [
   { key: 'country', label: 'Country' },
 ];
 
-const Example = () => (
+export const Example = () => (
   <DataTableManager columns={columns}>
     <DataTable rows={rows} />
   </DataTableManager>
 );
-
 export default Example;
+
+// Introduce this component to test that DataTable and DataTableManager should not necessarily be direct descendants
+const SomeOtherComponent = () => {
+  return <div>Some other component</div>;
+};
+
+// With the data table settings decoupled.
+//  It can also be exported as default.
+export const ExampleWithDecoupledDataTableManager = () => (
+  <DataTableManagerProvider columns={columns}>
+    <header>
+      <DataTableManager />
+      <SearchTextInput />
+    </header>
+    <main>
+      <SomeOtherComponent />
+      <DataTable rows={rows} />
+    </main>
+  </DataTableManagerProvider>
+);

packages/components/data-table-manager/data-table-manager-provider/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "dist/commercetools-uikit-data-table-manager-data-table-manager-provider.cjs.js",
+  "module": "dist/commercetools-uikit-data-table-manager-data-table-manager-provider.esm.js"
+}

packages/components/data-table-manager/package.json

@@ -17,7 +17,10 @@
   "sideEffects": false,
   "main": "dist/commercetools-uikit-data-table-manager.cjs.js",
   "module": "dist/commercetools-uikit-data-table-manager.esm.js",
-  "files": ["dist"],
+  "preconstruct": {
+    "entrypoints": ["./index.ts", "data-table-manager-provider/index.ts"]
+  },
+  "files": ["dist", "data-table-manager-provider"],
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",

packages/components/data-table-manager/src/data-table-manager-provider/data-table-manager-provider.tsx

@@ -0,0 +1,72 @@
+import { createContext, useContext, useMemo } from 'react';
+import type { TDataTableSettingsProps, TColumnManagerProps } from '../types';
+import type { TDataTableManagerColumnProps, TRow } from './types';
+
+export type TDataTableManagerContext<Row extends TRow = TRow> =
+  TDataTableSettingsProps & {
+    columns: TDataTableManagerColumnProps<Row>[];
+    isCondensed?: boolean;
+  };
+
+const DataTableManagerContext = createContext<TDataTableManagerContext>({
+  columns: [],
+  displaySettings: undefined,
+  isCondensed: true,
+});
+
+export const useDataTableManagerContext = () => {
+  const dataTableManagerContext = useContext(DataTableManagerContext);
+
+  if (!dataTableManagerContext) {
+    throw new Error(
+      'ui-kit/DataTableManager: `useDataTableManagerContext` must be used within the DataTableManagerProvider.'
+    );
+  }
+
+  return dataTableManagerContext;
+};
+
+export const DataTableManagerProvider = ({
+  children,
+  columns,
+  displaySettings,
+  topBar,
+  onSettingsChange,
+  columnManager,
+}: {
+  children: React.ReactNode;
+  columns: TDataTableManagerColumnProps[];
+  displaySettings: TDataTableSettingsProps['displaySettings'];
+  topBar: string;
+  onSettingsChange: () => void;
+  columnManager: TColumnManagerProps;
+}) => {
+  const decoupledDataTableManagerContext = useMemo(() => {
+    const areDisplaySettingsEnabled = Boolean(
+      displaySettings && !displaySettings.disableDisplaySettings
+    );
+
+    const isWrappingText =
+      areDisplaySettingsEnabled && displaySettings!.isWrappingText;
+
+    return {
+      columns: columns.map((column) => ({
+        ...column,
+        isTruncated: areDisplaySettingsEnabled
+          ? isWrappingText
+          : column.isTruncated,
+      })),
+      displaySettings,
+      topBar,
+      onSettingsChange,
+      columnManager,
+      isCondensed: areDisplaySettingsEnabled && displaySettings!.isCondensed,
+    };
+  }, [columns, displaySettings, topBar, onSettingsChange, columnManager]);
+
+  return (
+    <DataTableManagerContext.Provider value={decoupledDataTableManagerContext}>
+      {children}
+    </DataTableManagerContext.Provider>
+  );
+};

packages/components/data-table-manager/src/data-table-manager-provider/index.ts

@@ -0,0 +1,6 @@
+export {
+  DataTableManagerProvider,
+  useDataTableManagerContext,
+} from './data-table-manager-provider';
+
+export type { TDataTableManagerContext } from './data-table-manager-provider';

packages/components/data-table-manager/src/data-table-manager-provider/types.tsx

@@ -0,0 +1,91 @@
+import { type ReactNode, type MouseEventHandler } from 'react';
+
+export interface TRow {
+  id: string;
+}
+
+export type TDataTableManagerColumnProps<Row extends TRow = TRow> = {
+  /**
+   * The unique key of the column that is used to identify your data type.
+   * You can use this value to determine which value from a row item should be rendered.
+   * <br>
+   * For example, if the data is a list of users, where each user has a `firstName` property,
+   * the column key should be `firstName`, which renders the correct value by default.
+   * The key can also be some custom or computed value, in which case you need to provide
+   * an explicit mapping of the value by implementing either the `itemRendered` function or
+   * the column-specific `renderItem` function.
+   */
+  key: string;
+
+  /**
+   * The label of the column that will be shown on the column header.
+   */
+  label: ReactNode;
+
+  /**
+   * Sets a width for this column. Accepts the same values as the ones specified for
+   * individual [grid-template-columns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).
+   * <br>
+   * For example, using `minmax` pairs (e.g. `minmax(200px, 400px)`), a combinations of
+   * fraction values (`1fr`/`2fr`/etc), or fixed values such as `200px`.
+   * By default, the column grows according to the content and respecting the total table available width.
+   */
+  width?: string;
+
+  /**
+   * Use this to override the table's own `horizontalCellAlignment` prop for this specific column.
+   */
+  align?: 'left' | 'center' | 'right';
+
+  /**
+   * A callback function, called when the header cell is clicked.
+   */
+  onClick?: (event: MouseEventHandler) => void;
+
+  /**
+   * A callback function to render the content of cells under this column, overriding
+   * the default `itemRenderer` prop of the table.
+   */
+  renderItem?: (row: Row, isRowCollapsed: boolean) => ReactNode;
+
+  /**
+   * Use this prop to place an `Icon` or `IconButton` on the left of the column label.
+   * It is advised to place these types of components through this prop instead of `label`,
+   * in order to properly position and align the elements.
+   * This is particularly useful for medium-sized icons which require more vertical space than the typography.
+   */
+  headerIcon?: ReactNode;
+
+  /**
+   * Set this to `true` to allow text content of this cell to be truncated with an ellipsis,
+   * instead of breaking into multiple lines.
+   * <br>
+   * NOTE: when using this option, it is recommended to specify a `width` for the column, because
+   * if the table doesn't have enough space for all columns, it will start clipping the columns
+   * with _truncated_ content, and if no `width` is set (or the value is set `auto` -- the default)
+   * it can shrink until the column disappears completely.
+   * By enforcing a minimum width for these columns, the table will respect them and grow horizontally,
+   * adding scrollbars if needed.
+   */
+  isTruncated?: boolean;
+
+  /**
+   * Set this to `true` to show a sorting button, which calls `onSortChange` upon being clicked.
+   * You should enable this flag for every column you want to be able to sort.
+   * When at least one column is sortable, the table props `sortBy`, `sortDirection` and `onSortChange` should be provided.
+   */
+  isSortable?: boolean;
+
+  /**
+   * Set this to `true` to prevent this column from being manually resized by dragging
+   * the edge of the header with a mouse.
+   */
+  disableResizing?: boolean;
+
+  /**
+   * Set this to `true` to prevent click event propagation for this cell.
+   * You might want this if you need the column to have its own call-to-action or input while
+   * the row also has a defined `onRowClick`.
+   */
+  shouldIgnoreRowClick?: boolean;
+};