@gemologic/sheen-table 0.2.0 → 0.3.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 (50) hide show
  1. package/dist/DataTable.d.ts +7 -0
  2. package/dist/DataTable.js +1154 -1624
  3. package/dist/DataTableToolbar.js +1 -2
  4. package/dist/FilterBar.d.ts +3 -0
  5. package/dist/FilterBar.js +127 -108
  6. package/dist/QueryBuilder.js +72 -68
  7. package/dist/cell-edit.js +1 -2
  8. package/dist/client-state.js +20 -21
  9. package/dist/client-view.js +12 -13
  10. package/dist/column-layout.js +1 -2
  11. package/dist/columns.d.ts +5 -1
  12. package/dist/columns.js +7 -5
  13. package/dist/constrained-columns.js +1 -2
  14. package/dist/data-table-features.d.ts +129 -0
  15. package/dist/data-table-features.js +550 -0
  16. package/dist/export.js +1 -2
  17. package/dist/facets.js +5 -7
  18. package/dist/filter-bar-state.js +14 -18
  19. package/dist/filter-client.js +1 -2
  20. package/dist/filter.js +1 -2
  21. package/dist/grouping.js +1 -2
  22. package/dist/index.js +3 -3
  23. package/dist/messages.d.ts +1 -1
  24. package/dist/messages.js +2 -3
  25. package/dist/pagination.js +1 -2
  26. package/dist/query-builder-state.js +1 -2
  27. package/dist/requests.js +1 -2
  28. package/dist/row-hierarchy.js +1 -2
  29. package/dist/row-identity.js +1 -2
  30. package/dist/saved-views.js +1 -2
  31. package/dist/search-controller.js +1 -2
  32. package/dist/search.js +1 -2
  33. package/dist/selection-client.js +1 -2
  34. package/dist/selection.d.ts +3 -0
  35. package/dist/selection.js +9 -2
  36. package/dist/server-export.js +1 -2
  37. package/dist/sorting.js +1 -2
  38. package/dist/table-state-changes.js +1 -2
  39. package/dist/table-state.js +1 -2
  40. package/dist/text-normalization.js +1 -2
  41. package/dist/url-state.js +1 -2
  42. package/package.json +5 -5
  43. package/src/DataTable.tsx +285 -712
  44. package/src/FilterBar.tsx +17 -3
  45. package/src/QueryBuilder.tsx +5 -5
  46. package/src/columns.ts +9 -3
  47. package/src/data-table-features.tsx +579 -0
  48. package/src/messages.ts +1 -1
  49. package/src/selection.ts +8 -0
  50. package/src/styles.css +17 -11
package/src/FilterBar.tsx CHANGED
@@ -1,4 +1,4 @@
1
- import { Button, Checkbox, CheckboxGroup, Input, Popover, Select, cn, useTheme } from "@gemologic/sheen";
1
+ import { Button, Checkbox, CheckboxGroup, Glyph, Input, Popover, Select, cn, useTheme } from "@gemologic/sheen";
2
2
  import { For, Show, createEffect, createMemo, createSignal, untrack } from "solid-js";
3
3
  import type { Accessor, JSX } from "solid-js";
4
4
  import { Dynamic } from "solid-js/web";
@@ -10,6 +10,7 @@ import { appendFilterCondition, listFilterConditions, removeFilterCondition, rep
10
10
  import type { FilterCondition, FilterConditionEntry } from "./filter-bar-state.ts";
11
11
  import { resolveTableMessages } from "./messages.ts";
12
12
  import type { TableMessages } from "./messages.ts";
13
+ import type { DataTableFeatureContext, DataTableFeatureInstance } from "./data-table-features.tsx";
13
14
 
14
15
  export interface FilterBarProps<Row extends object> {
15
16
  readonly columns: SheenColumns<Row>;
@@ -292,7 +293,7 @@ function ConditionChip(props: {
292
293
  onApply={(condition, negated) => { setOpen(false); props.onApply(props.record.key, props.record.entry(), condition, negated); }} /></Show>
293
294
  </Popover>
294
295
  <button ref={element => props.removeRef(props.record.key, element)} type="button" class="sheen-filter-remove" disabled={props.disabled}
295
- aria-label={`${messages().filterRemove}: ${summary()}`} onClick={() => props.onRemove(props.record.key, props.record.entry())}><span aria-hidden="true">×</span></button>
296
+ aria-label={`${messages().filterRemove}: ${summary()}`} onClick={() => props.onRemove(props.record.key, props.record.entry())}><Glyph name="close" /></button>
296
297
  </li>;
297
298
  }
298
299
 
@@ -379,7 +380,7 @@ export function FilterBar<Row extends object>(props: FilterBarProps<Row>): JSX.E
379
380
  removeRef={(key, element) => { element.dataset.filterKey = key; }} />;
380
381
  }}</For></ul>
381
382
  <div ref={addRoot} class="sheen-filter-add">
382
- <Popover trigger={messages().filterAdd} title={chosen() ? `${messages().filterAdd}: ${chosen()?.header}` : messages().filterColumns}
383
+ <Popover trigger={<><Glyph name="plus" />{messages().filterAdd}</>} title={chosen() ? `${messages().filterAdd}: ${chosen()?.header}` : messages().filterColumns}
383
384
  open={addOpen()} onOpenChange={changeAddOpen} class="sheen-filter-picker">
384
385
  <Show when={chosen()} fallback={<>
385
386
  <Input type="search" label={messages().filterSearchColumns} value={search()} onInput={event => setSearch(event.currentTarget.value)} disabled={props.disabled} />
@@ -394,3 +395,16 @@ export function FilterBar<Row extends object>(props: FilterBarProps<Row>): JSX.E
394
395
  </div>
395
396
  </div>;
396
397
  }
398
+
399
+ /** DataTable toolbar integration for the filters declared by its column definitions. */
400
+ export function filterBarFeature<Row extends object>(context: DataTableFeatureContext<Row>): DataTableFeatureInstance<Row> | undefined {
401
+ if (context.filterColumns.length === 0) return undefined;
402
+ const props = context.props;
403
+ return {
404
+ query: {
405
+ visible: () => props.filterBar !== false,
406
+ render: () => <FilterBar columns={props.columns} value={context.acceptedFilter()} facets={context.result().facets} disabled={context.pending()} onChange={context.requestFilter}
407
+ {...(typeof props.filterBar === "object" && props.filterBar.dateEditor ? { dateEditor: props.filterBar.dateEditor } : {})} />,
408
+ },
409
+ };
410
+ }
@@ -173,12 +173,12 @@ function StructuralActions(props: NodeEditorProps): JSX.Element {
173
173
  if (!props.structural) return null;
174
174
  const update = (next: FilterNode, announcement: string): void => props.publish(next, announcement);
175
175
  return <div class="sheen-query-node-actions">
176
- <Button size="xs" aria-label={props.messages.queryMoveBefore} disabled={props.disabled || props.index === 0}
176
+ <Button variant="ghost" size="xs" aria-label={props.messages.queryMoveBefore} disabled={props.disabled || props.index === 0}
177
177
  onClick={() => update(moveQueryNode(props.root(), props.path, -1, props.schema), props.messages.queryChanged)}>{props.messages.queryMoveBefore}</Button>
178
- <Button size="xs" aria-label={props.messages.queryMoveAfter} disabled={props.disabled || props.index >= props.siblingCount - 1}
178
+ <Button variant="ghost" size="xs" aria-label={props.messages.queryMoveAfter} disabled={props.disabled || props.index >= props.siblingCount - 1}
179
179
  onClick={() => update(moveQueryNode(props.root(), props.path, 1, props.schema), props.messages.queryChanged)}>{props.messages.queryMoveAfter}</Button>
180
- <Button size="xs" disabled={props.disabled} onClick={() => update(toggleQueryNegation(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryNegate}</Button>
181
- <Button size="xs" tone="danger" disabled={props.disabled} onClick={() => update(removeQueryNode(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryRemove}</Button>
180
+ <Button variant="ghost" size="xs" disabled={props.disabled} onClick={() => update(toggleQueryNegation(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryNegate}</Button>
181
+ <Button variant="ghost" size="xs" tone="danger" disabled={props.disabled} onClick={() => update(removeQueryNode(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryRemove}</Button>
182
182
  </div>;
183
183
  }
184
184
 
@@ -244,7 +244,7 @@ function QueryNodeEditor(props: NodeEditorProps): JSX.Element {
244
244
  return <MatchSwitch>
245
245
  <Match when={props.node.kind === "not"}><section class="sheen-query-not" aria-label={props.messages.queryNegate} data-query-path={pathKey(props.path)}>
246
246
  <div class="sheen-query-not-toolbar"><strong>{props.messages.queryNegate}</strong>
247
- <Button size="xs" disabled={props.disabled} onClick={() => props.publish(toggleQueryNegation(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryRemoveNegation}</Button>
247
+ <Button variant="ghost" size="xs" disabled={props.disabled} onClick={() => props.publish(toggleQueryNegation(props.root(), props.path, props.schema), props.messages.queryChanged)}>{props.messages.queryRemoveNegation}</Button>
248
248
  <StructuralActions {...props} />
249
249
  </div>
250
250
  <QueryNodeEditor {...props} node={notNode(props.node).child} path={[...props.path, 0]} structural={false} index={0} siblingCount={1} />
package/src/columns.ts CHANGED
@@ -51,6 +51,8 @@ export interface SheenAccessorColumn<Row extends object> extends ColumnBase<Row>
51
51
  /** Omit to infer number/date from filter or numeric, otherwise text. */
52
52
  readonly sort?: ColumnSort;
53
53
  readonly aggregate?: ColumnAggregate;
54
+ /** Tint a numeric cell up or down when its value changes for the same row. Off under reduced motion. */
55
+ readonly flash?: boolean;
54
56
  }
55
57
  export interface SheenDisplayColumn<Row extends object> extends ColumnBase<Row> {
56
58
  readonly accessor?: never;
@@ -62,10 +64,11 @@ export interface SheenDisplayColumn<Row extends object> extends ColumnBase<Row>
62
64
  readonly sort?: never;
63
65
  readonly aggregate?: never;
64
66
  readonly editor?: never;
67
+ readonly flash?: never;
65
68
  }
66
69
  export type SheenColumnInput<Row extends object> = SheenAccessorColumn<Row> | SheenDisplayColumn<Row>;
67
70
 
68
- interface ResolvedColumn<Row extends object> {
71
+ export interface ResolvedColumn<Row extends object> {
69
72
  readonly id: string;
70
73
  readonly header: string;
71
74
  readonly accessor: ((row: Row) => ColumnValue) | null;
@@ -86,6 +89,7 @@ interface ResolvedColumn<Row extends object> {
86
89
  readonly faceted: boolean;
87
90
  readonly sort: SortColumn | null;
88
91
  readonly aggregate: ColumnAggregate | null;
92
+ readonly flash: boolean;
89
93
  readonly unsafeTanStack: UnsafeTanStackColumnOptions | null;
90
94
  }
91
95
 
@@ -106,7 +110,7 @@ class DefinedColumns<Row extends object> implements SheenColumns<Row> {
106
110
  [inspectColumns](): readonly ResolvedColumn<Row>[] { return this.#definitions; }
107
111
  }
108
112
 
109
- const baseKeys = new Set(["id", "header", "accessor", "cell", "cellDependencies", "footer", "width", "minWidth", "maxWidth", "align", "numeric", "pin", "visible", "search", "sensitive", "editor", "filter", "sort", "aggregate", "__unsafe_tanstack"]);
113
+ const baseKeys = new Set(["id", "header", "accessor", "cell", "cellDependencies", "footer", "width", "minWidth", "maxWidth", "align", "numeric", "pin", "visible", "search", "sensitive", "editor", "filter", "sort", "aggregate", "flash", "__unsafe_tanstack"]);
110
114
  function assertRecord(value: unknown, label: string): asserts value is Record<string, unknown> {
111
115
  if (typeof value !== "object" || value === null || Array.isArray(value)) throw new Error(`${label} must be an object`);
112
116
  const prototype = Object.getPrototypeOf(value);
@@ -251,12 +255,14 @@ export function defineColumns<Row extends object>(values: readonly SheenColumnIn
251
255
  const aggregate = input.aggregate ?? null;
252
256
  if (aggregate !== null && aggregate !== "sum" && aggregate !== "average" && aggregate !== "min" && aggregate !== "max" && aggregate !== "count") throw new Error(`${label}.aggregate is invalid`);
253
257
  if (aggregate !== null && aggregate !== "count" && !numeric && filter?.type !== "number") throw new Error(`${label}.${aggregate} requires a numeric column`);
258
+ if (input.flash !== undefined && (typeof input.flash !== "boolean" || accessor === null)) throw new Error(`${label}.flash must be boolean on an accessor column`);
259
+ const flash = input.flash ?? false;
254
260
  let unsafeTanStack: UnsafeTanStackColumnOptions | null = null;
255
261
  if (input.__unsafe_tanstack !== undefined) {
256
262
  assertRecord(input.__unsafe_tanstack, `${label}.__unsafe_tanstack`);
257
263
  unsafeTanStack = Object.freeze({ ...input.__unsafe_tanstack });
258
264
  }
259
- definitions.push(Object.freeze({ id: input.id, header: input.header, accessor, cell, cellDependencies, footer: functions.footer, width, minWidth, maxWidth, align, numeric, pin, visible, search, sensitive, editor, filter, faceted, sort, aggregate, unsafeTanStack }));
265
+ definitions.push(Object.freeze({ id: input.id, header: input.header, accessor, cell, cellDependencies, footer: functions.footer, width, minWidth, maxWidth, align, numeric, pin, visible, search, sensitive, editor, filter, faceted, sort, aggregate, flash, unsafeTanStack }));
260
266
  index++;
261
267
  }
262
268
  return new DefinedColumns(Object.freeze(definitions));