@multiplatform.one/table 7.52.0 → 7.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist/cjs/components/DataTable/CellContent.cjs +12 -1
  2. package/dist/cjs/components/DataTable/CellContent.native.js +12 -1
  3. package/dist/cjs/components/DataTable/CellContent.native.js.map +1 -1
  4. package/dist/cjs/components/DataTable/DataTableDocumentList.cjs +65 -21
  5. package/dist/cjs/components/DataTable/DataTableDocumentList.native.js +76 -21
  6. package/dist/cjs/components/DataTable/DataTableDocumentList.native.js.map +1 -1
  7. package/dist/esm/components/DataTable/CellContent.mjs +13 -2
  8. package/dist/esm/components/DataTable/CellContent.mjs.map +1 -1
  9. package/dist/esm/components/DataTable/CellContent.native.js +13 -2
  10. package/dist/esm/components/DataTable/CellContent.native.js.map +1 -1
  11. package/dist/esm/components/DataTable/DataTableDocumentList.mjs +65 -22
  12. package/dist/esm/components/DataTable/DataTableDocumentList.mjs.map +1 -1
  13. package/dist/esm/components/DataTable/DataTableDocumentList.native.js +76 -22
  14. package/dist/esm/components/DataTable/DataTableDocumentList.native.js.map +1 -1
  15. package/dist/jsx/components/DataTable/CellContent.mjs +13 -2
  16. package/dist/jsx/components/DataTable/CellContent.mjs.map +1 -1
  17. package/dist/jsx/components/DataTable/CellContent.native.js +12 -1
  18. package/dist/jsx/components/DataTable/CellContent.native.js.map +1 -1
  19. package/dist/jsx/components/DataTable/DataTableDocumentList.mjs +65 -22
  20. package/dist/jsx/components/DataTable/DataTableDocumentList.mjs.map +1 -1
  21. package/dist/jsx/components/DataTable/DataTableDocumentList.native.js +76 -21
  22. package/dist/jsx/components/DataTable/DataTableDocumentList.native.js.map +1 -1
  23. package/package.json +12 -12
  24. package/src/components/DataTable/CellContent.tsx +6 -2
  25. package/src/components/DataTable/DataTableDocumentList.tsx +67 -11
  26. package/src/components/DataTable/dataTableDocumentList.spec.tsx +67 -0
  27. package/types/components/DataTable/CellContent.d.ts.map +1 -1
  28. package/types/components/DataTable/DataTableDocumentList.d.ts +14 -0
  29. package/types/components/DataTable/DataTableDocumentList.d.ts.map +1 -1
@@ -12,6 +12,11 @@
12
12
  * bare number never stands alone; indicators and actions stay on the right
13
13
  * like desk's phone row (FZ-7684). An empty meta field is left out (FZ-7374).
14
14
  * LC-71: selected = fill; keyboard ring rides the row when it is the tab stop.
15
+ *
16
+ * LC-155 ROW-ANATOMY (compact): the subject paints the headline role, the
17
+ * meta line the meta role, and the row is a two-line Mail row. Selection
18
+ * checkboxes appear only in select mode: a long-press selects its row and
19
+ * enters it, a tap then toggles rows, and clearing the selection leaves it.
15
20
  */
16
21
 
17
22
  import { EmptyState, ListRowMeta, Text } from "@multiplatform.one/components";
@@ -66,6 +71,33 @@ export interface DataTableDocumentListProps<TData> {
66
71
  bleed?: PhoneTableBleed | null;
67
72
  }
68
73
 
74
+ const plainCell = { inTableCell: true, isHeader: false } as const;
75
+ const headlineCell = { inTableCell: true, isHeader: false, textRole: "headline" } as const;
76
+ const metaCell = { inTableCell: true, isHeader: false, textRole: "meta" } as const;
77
+ const captionCell = { inTableCell: true, isHeader: false, textRole: "caption" } as const;
78
+ const DATE_FIELDS = new Set(["datepicker", "datetimepicker", "timepicker"]);
79
+
80
+ function isDateCell(cell: any): boolean {
81
+ const field = (cell.column?.columnDef as DataTableColumn | undefined)?.field;
82
+ return field != null && DATE_FIELDS.has(field);
83
+ }
84
+
85
+ /**
86
+ * LC-155: wide rows always carry their selection checkbox; a compact row
87
+ * shows it only in select mode, which a selected row turns on.
88
+ */
89
+ export function documentListShowsCheckboxes({
90
+ enableRowSelection,
91
+ compact,
92
+ selectMode,
93
+ }: {
94
+ enableRowSelection: boolean;
95
+ compact: boolean;
96
+ selectMode: boolean;
97
+ }): boolean {
98
+ return enableRowSelection && (!compact || selectMode);
99
+ }
100
+
69
101
  /** The column's human name: `meta.label`, else a string header, else its id. */
70
102
  function columnLabel(cell: any): string {
71
103
  const def = cell.column?.columnDef as DataTableColumn | undefined;
@@ -97,6 +129,9 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
97
129
  const chrome = dataTableChrome(String(knobProps.sizeToken));
98
130
  const tableZebraOn = knobProps.tableZebra === "on";
99
131
  const rowPad = bleed ? bleed.inset : knobProps.panelPadding.padding;
132
+ const selectMode =
133
+ enableRowSelection && tableRows.some((row: any) => Boolean(row.getIsSelected?.()));
134
+ const showCheckboxes = documentListShowsCheckboxes({ enableRowSelection, compact, selectMode });
100
135
 
101
136
  const renderRow = useCallback(
102
137
  (row: any, index: number) => {
@@ -111,9 +146,11 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
111
146
  actions,
112
147
  } = partitionDocumentListCells(visibleCells, titleCell);
113
148
  const metas = metaCells.filter((cell: any) => !isEmptyMetaCell(cell));
114
- const labelledTrailing = compact
115
- ? trailing.filter((cell: any) => !isEmptyMetaCell(cell))
116
- : [];
149
+ const compactTrailing = compact ? trailing.filter((cell: any) => !isEmptyMetaCell(cell)) : [];
150
+ // LC-155: the first date column is the row's timestamp, a caption at
151
+ // the top right like Mail's; other trailing values join the meta line.
152
+ const stampCell = compactTrailing.find(isDateCell);
153
+ const labelledTrailing = compactTrailing.filter((cell: any) => cell !== stampCell);
117
154
  const slotCell = (cell: any, slot: "indicator" | "actions") => (
118
155
  <View
119
156
  key={cell.id}
@@ -161,7 +198,7 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
161
198
  alignItems={compact ? "flex-start" : "center"}
162
199
  gap="$3"
163
200
  paddingHorizontal={rowPad}
164
- paddingVertical="$2"
201
+ paddingVertical={compact ? "$3" : "$2"}
165
202
  minHeight={chrome.rowPx}
166
203
  overflow="hidden"
167
204
  display="flex"
@@ -178,10 +215,17 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
178
215
  ...(rowState.hoverStyle as object),
179
216
  ...corners,
180
217
  }}
181
- {...(getRowPressProps ? (getRowPressProps(row, index, "row") as any) : {})}
218
+ {...(compact && selectMode
219
+ ? { onPress: () => !disabled && row.toggleSelected(!row.getIsSelected()) }
220
+ : getRowPressProps
221
+ ? (getRowPressProps(row, index, "row") as any)
222
+ : {})}
223
+ {...(compact && enableRowSelection && !selectMode && !disabled
224
+ ? { onLongPress: () => row.toggleSelected(true) }
225
+ : {})}
182
226
  {...(rowIntentProps(rowData) as any)}
183
227
  >
184
- {enableRowSelection && (
228
+ {showCheckboxes && (
185
229
  <Checkbox
186
230
  checked={row.getIsSelected()}
187
231
  onChange={(checked) => {
@@ -208,7 +252,7 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
208
252
  <YStack flex={1} minWidth={0} gap="$1" overflow="hidden">
209
253
  {titleCell ? (
210
254
  <View minWidth={0} {...({ "data-list-slot": "title" } as any)}>
211
- <TableCellContext.Provider value={{ inTableCell: true, isHeader: false }}>
255
+ <TableCellContext.Provider value={compact ? headlineCell : plainCell}>
212
256
  {renderCellContent(titleCell, index, rowData)}
213
257
  </TableCellContext.Provider>
214
258
  </View>
@@ -222,7 +266,6 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
222
266
  alignItems="center"
223
267
  columnGap="$3"
224
268
  rowGap="$1"
225
- opacity={0.7}
226
269
  overflow="hidden"
227
270
  {...({ "data-list-slot": "meta-line" } as any)}
228
271
  >
@@ -234,7 +277,7 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
234
277
  overflow="hidden"
235
278
  {...({ "data-list-slot": "meta" } as any)}
236
279
  >
237
- <TableCellContext.Provider value={{ inTableCell: true, isHeader: false }}>
280
+ <TableCellContext.Provider value={metaCell}>
238
281
  {renderCellContent(cell, index, rowData)}
239
282
  </TableCellContext.Provider>
240
283
  </View>
@@ -247,11 +290,11 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
247
290
  flexShrink={0}
248
291
  {...({ "data-list-slot": "labelled-meta" } as any)}
249
292
  >
250
- <Text fontSize="$3" color="$color11" numberOfLines={1} flexShrink={0}>
293
+ <Text {...knobProps.textRole.meta} numberOfLines={1} flexShrink={0}>
251
294
  {columnLabel(cell)}
252
295
  </Text>
253
296
  <View flexShrink={0}>
254
- <TableCellContext.Provider value={{ inTableCell: true, isHeader: false }}>
297
+ <TableCellContext.Provider value={metaCell}>
255
298
  {renderCellContent(cell, index, rowData)}
256
299
  </TableCellContext.Provider>
257
300
  </View>
@@ -260,6 +303,17 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
260
303
  </XStack>
261
304
  ) : null}
262
305
  </YStack>
306
+ {stampCell ? (
307
+ <View
308
+ flexShrink={0}
309
+ alignSelf="flex-start"
310
+ {...({ "data-list-slot": "stamp" } as any)}
311
+ >
312
+ <TableCellContext.Provider value={captionCell}>
313
+ {renderCellContent(stampCell, index, rowData)}
314
+ </TableCellContext.Provider>
315
+ </View>
316
+ ) : null}
263
317
  {compact && indicators.length + actions.length > 0 ? (
264
318
  <XStack
265
319
  flexShrink={0}
@@ -302,6 +356,8 @@ export function DataTableDocumentList<TData extends Record<string, any>>({
302
356
  compact,
303
357
  disabled,
304
358
  enableRowSelection,
359
+ selectMode,
360
+ showCheckboxes,
305
361
  getRowPressProps,
306
362
  knobProps.borderRadiusOuter.borderRadius,
307
363
  renderCellContent,
@@ -14,6 +14,7 @@ import { renderWithProviders } from "@multiplatform.one/test-utils";
14
14
  import { screen, waitFor } from "@testing-library/react";
15
15
  import { describe, expect, it, vi } from "vitest";
16
16
  import type { DataTableColumn, TableFilter } from "../../types";
17
+ import { documentListShowsCheckboxes } from "./DataTableDocumentList";
17
18
  import { DataTable } from "./index";
18
19
 
19
20
  type Task = {
@@ -223,6 +224,72 @@ describe("DataTableDocumentList", () => {
223
224
  expect(screen.getAllByLabelText(/^Select row /).length).toBe(tasks.length);
224
225
  });
225
226
 
227
+ describe("LC-155 row anatomy on a phone", () => {
228
+ const atPhone = (run: () => void) => {
229
+ const width = window.innerWidth;
230
+ window.innerWidth = 390;
231
+ try {
232
+ run();
233
+ } finally {
234
+ window.innerWidth = width;
235
+ }
236
+ };
237
+
238
+ it("draws no selection checkbox at rest", () => {
239
+ atPhone(() => {
240
+ renderList({ enableRowSelection: true });
241
+ expect(screen.queryAllByLabelText(/^Select row /)).toHaveLength(0);
242
+ });
243
+ });
244
+
245
+ it("select mode is the only way a compact row shows its checkbox", () => {
246
+ expect(
247
+ documentListShowsCheckboxes({ enableRowSelection: true, compact: true, selectMode: false }),
248
+ ).toBe(false);
249
+ expect(
250
+ documentListShowsCheckboxes({ enableRowSelection: true, compact: true, selectMode: true }),
251
+ ).toBe(true);
252
+ expect(
253
+ documentListShowsCheckboxes({
254
+ enableRowSelection: true,
255
+ compact: false,
256
+ selectMode: false,
257
+ }),
258
+ ).toBe(true);
259
+ expect(
260
+ documentListShowsCheckboxes({ enableRowSelection: false, compact: true, selectMode: true }),
261
+ ).toBe(false);
262
+ });
263
+
264
+ it("puts the row's date at the top right as a caption, out of the meta line", () => {
265
+ atPhone(() => {
266
+ const { container } = renderList({
267
+ columns: [
268
+ ...columns,
269
+ { accessorKey: "id", header: "Points", align: "right" },
270
+ { id: "modified", accessorKey: "owner", header: "Modified", field: "datepicker" },
271
+ ],
272
+ });
273
+ const row = container.querySelector('[data-testid="data-table-list-row"]')!;
274
+ const stamp = row.querySelector('[data-list-slot="stamp"]')!;
275
+ expect(stamp).not.toBeNull();
276
+ expect(getComputedStyle(stamp).alignSelf).toBe("flex-start");
277
+ const metaLine = row.querySelector('[data-list-slot="meta-line"]')!;
278
+ expect(metaLine.contains(stamp)).toBe(false);
279
+ expect(metaLine.textContent).toContain("Points1");
280
+ expect(metaLine.textContent).not.toContain("Modified");
281
+ });
282
+ });
283
+
284
+ it("drops the meta line's opacity: its ink comes from the meta role", () => {
285
+ atPhone(() => {
286
+ const { container } = renderList();
287
+ const metaLine = container.querySelector('[data-list-slot="meta-line"]')!;
288
+ expect(getComputedStyle(metaLine).opacity).not.toBe("0.7");
289
+ });
290
+ });
291
+ });
292
+
226
293
  it("empty with no filters reads 'No data available'", () => {
227
294
  renderWithProviders(
228
295
  <DataTable data={[]} columns={columns} layout="list" onStateChange={vi.fn()} />,
@@ -1 +1 @@
1
- {"version":3,"file":"CellContent.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/CellContent.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AA0C9C;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,EAC1B,OAAO,EACP,GAAG,EACH,QAAQ,GACT,EAAE;IACD,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;CAC1B,2CAMA"}
1
+ {"version":3,"file":"CellContent.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/CellContent.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AA6C9C;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,EAC1B,OAAO,EACP,GAAG,EACH,QAAQ,GACT,EAAE;IACD,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;CAC1B,2CAMA"}
@@ -12,6 +12,11 @@
12
12
  * bare number never stands alone; indicators and actions stay on the right
13
13
  * like desk's phone row (FZ-7684). An empty meta field is left out (FZ-7374).
14
14
  * LC-71: selected = fill; keyboard ring rides the row when it is the tab stop.
15
+ *
16
+ * LC-155 ROW-ANATOMY (compact): the subject paints the headline role, the
17
+ * meta line the meta role, and the row is a two-line Mail row. Selection
18
+ * checkboxes appear only in select mode: a long-press selects its row and
19
+ * enters it, a tap then toggles rows, and clearing the selection leaves it.
15
20
  */
16
21
  import { type PhoneTableBleed } from "@multiplatform.one/theme";
17
22
  import type React from "react";
@@ -36,5 +41,14 @@ export interface DataTableDocumentListProps<TData> {
36
41
  /** LC-146: rows run edge to edge and take the gutter as their inset. */
37
42
  bleed?: PhoneTableBleed | null;
38
43
  }
44
+ /**
45
+ * LC-155: wide rows always carry their selection checkbox; a compact row
46
+ * shows it only in select mode, which a selected row turns on.
47
+ */
48
+ export declare function documentListShowsCheckboxes({ enableRowSelection, compact, selectMode, }: {
49
+ enableRowSelection: boolean;
50
+ compact: boolean;
51
+ selectMode: boolean;
52
+ }): boolean;
39
53
  export declare function DataTableDocumentList<TData extends Record<string, any>>({ tableRows, enableRowSelection, disabled, hasActiveFilters, renderCellContent, selectRowLabel, getRowPressProps, queryInFlight, bleed, }: DataTableDocumentListProps<TData>): import("react/jsx-runtime").JSX.Element;
40
54
  //# sourceMappingURL=DataTableDocumentList.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DataTableDocumentList.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/DataTableDocumentList.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,EAML,KAAK,eAAe,EACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAU/B,iFAAiF;AACjF,wBAAgB,yBAAyB,CACvC,KAAK,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,EACxE,YAAY,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,SAAS,CAY1C;AAED,MAAM,WAAW,0BAA0B,CAAC,KAAK;IAC/C,SAAS,EAAE,GAAG,EAAE,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,KAAK,KAAK,CAAC,SAAS,CAAC;IACpF,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IACxD,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjG,qEAAqE;IACrE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAChC;AAgBD,wBAAgB,qBAAqB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,EACvE,SAAS,EACT,kBAA0B,EAC1B,QAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,aAAqB,EACrB,KAAY,GACb,EAAE,0BAA0B,CAAC,KAAK,CAAC,2CA0PnC"}
1
+ {"version":3,"file":"DataTableDocumentList.d.ts","sourceRoot":"","sources":["../../../src/components/DataTable/DataTableDocumentList.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH,OAAO,EAML,KAAK,eAAe,EACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAU/B,iFAAiF;AACjF,wBAAgB,yBAAyB,CACvC,KAAK,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,EACxE,YAAY,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,SAAS,CAY1C;AAED,MAAM,WAAW,0BAA0B,CAAC,KAAK;IAC/C,SAAS,EAAE,GAAG,EAAE,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,KAAK,KAAK,CAAC,SAAS,CAAC;IACpF,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IACxD,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjG,qEAAqE;IACrE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wEAAwE;IACxE,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAChC;AAaD;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,kBAAkB,EAClB,OAAO,EACP,UAAU,GACX,EAAE;IACD,kBAAkB,EAAE,OAAO,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;CACrB,GAAG,OAAO,CAEV;AAgBD,wBAAgB,qBAAqB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,EACvE,SAAS,EACT,kBAA0B,EAC1B,QAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,aAAqB,EACrB,KAAY,GACb,EAAE,0BAA0B,CAAC,KAAK,CAAC,2CAkRnC"}