torch-glare 2.4.4 → 2.5.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.
- package/apps/lib/components/DataViews/{badgeAdapter.ts → badge.ts} +2 -2
- package/apps/lib/components/DataViews/cell.tsx +324 -0
- package/apps/lib/components/DataViews/context.ts +144 -0
- package/apps/lib/components/DataViews/data-views.tsx +383 -0
- package/apps/lib/components/DataViews/filters/children.tsx +98 -0
- package/apps/lib/components/DataViews/filters/custom.tsx +34 -0
- package/apps/lib/components/DataViews/filters/filters.tsx +163 -0
- package/apps/lib/components/DataViews/filters/index.ts +4 -0
- package/apps/lib/components/DataViews/filters/labelled.tsx +20 -0
- package/apps/lib/components/DataViews/filters/presets.tsx +65 -0
- package/apps/lib/components/DataViews/filters/summary.tsx +65 -0
- package/apps/lib/components/DataViews/filters/sync.tsx +35 -0
- package/apps/lib/components/DataViews/filters/values.ts +173 -0
- package/apps/lib/components/DataViews/header.tsx +217 -0
- package/apps/lib/components/DataViews/hooks/index.ts +5 -0
- package/apps/lib/components/DataViews/hooks/useActiveRow.ts +22 -0
- package/apps/lib/components/DataViews/hooks/useControllable.ts +52 -0
- package/apps/lib/components/DataViews/index.ts +74 -26
- package/apps/lib/components/DataViews/panel/columns.tsx +153 -0
- package/apps/lib/components/DataViews/panel/controls.tsx +106 -0
- package/apps/lib/components/DataViews/panel/index.ts +3 -0
- package/apps/lib/components/DataViews/panel/panel.tsx +164 -0
- package/apps/lib/components/DataViews/panel/saved-views.tsx +67 -0
- package/apps/lib/components/DataViews/panel/section.tsx +79 -0
- package/apps/lib/components/DataViews/panel/sort.tsx +42 -0
- package/apps/lib/components/DataViews/panel/tab.tsx +31 -0
- package/apps/lib/components/DataViews/slots.ts +63 -0
- package/apps/lib/components/DataViews/states.tsx +38 -0
- package/apps/lib/components/DataViews/types.ts +485 -178
- package/apps/lib/components/DataViews/views/board-view.tsx +379 -0
- package/apps/lib/components/DataViews/views/card-rows.tsx +36 -0
- package/apps/lib/components/DataViews/views/inbox-view.tsx +257 -0
- package/apps/lib/components/DataViews/views/pane-views.tsx +192 -0
- package/apps/lib/components/DataViews/views/table-view.tsx +426 -0
- package/apps/lib/components/DataViews/views/tree-view.tsx +365 -0
- package/apps/lib/components/FormBuilder/context.ts +20 -6
- package/apps/lib/components/FormBuilder/field-kind.ts +28 -0
- package/apps/lib/components/FormBuilder/fields/DateField.tsx +3 -3
- package/apps/lib/components/FormBuilder/fields/FieldShell.tsx +7 -6
- package/apps/lib/components/FormBuilder/fields/PhoneField.tsx +30 -4
- package/apps/lib/components/FormBuilder/fields/SelectField.tsx +7 -7
- package/apps/lib/components/FormBuilder/fields/TableField.tsx +80 -52
- package/apps/lib/components/FormBuilder/fields/TextField.tsx +9 -9
- package/apps/lib/components/FormBuilder/form-builder.tsx +66 -6
- package/apps/lib/components/FormBuilder/index.ts +3 -1
- package/apps/lib/components/FormBuilder/types.ts +40 -0
- package/apps/lib/components/Input.tsx +3 -0
- package/apps/lib/components/SearchableTable.tsx +5 -4
- package/apps/lib/components/SectionBlock.tsx +58 -11
- package/apps/lib/components/Select.tsx +3 -1
- package/apps/lib/components/TabSwitch.tsx +16 -4
- package/apps/lib/components/Table.tsx +265 -67
- package/apps/lib/components/TreeFolder/TreeFolder.tsx +6 -3
- package/apps/lib/components/TreeFolder/TreeFolderRow.tsx +16 -14
- package/apps/lib/components/TreeFolder/index.ts +1 -1
- package/apps/lib/components/TreeFolder/useTreeFolderDnD.ts +70 -207
- package/apps/lib/hooks/useDragDrop.tsx +365 -0
- package/apps/lib/hooks/useInfiniteScroll.ts +108 -0
- package/apps/lib/registry.json +159 -4
- package/apps/lib/tsconfig.tsbuildinfo +1 -1
- package/apps/lib/utils/dataViews/path.ts +67 -0
- package/apps/lib/utils/dataViews/query.ts +73 -0
- package/apps/lib/utils/dataViews/types.ts +187 -0
- package/docs/components/breadcrumb.md +1 -1
- package/docs/components/button-group.md +1 -1
- package/docs/components/button.md +1 -1
- package/docs/components/card.md +1 -1
- package/docs/components/checkbox.md +1 -1
- package/docs/components/data-views/backend-response.md +324 -0
- package/docs/components/data-views/examples/a11y-rtl.md +250 -0
- package/docs/components/data-views/examples/api-orders-route.md +130 -0
- package/docs/components/data-views/examples/fields.md +362 -0
- package/docs/components/data-views/examples/filters.md +308 -0
- package/docs/components/data-views/examples/inbox-routing.md +218 -0
- package/docs/components/data-views/examples/index.md +29 -0
- package/docs/components/data-views/examples/overview.md +244 -0
- package/docs/components/data-views/examples/panel.md +212 -0
- package/docs/components/data-views/examples/scale.md +231 -0
- package/docs/components/data-views/examples/server-side.md +210 -0
- package/docs/components/data-views/examples/state.md +250 -0
- package/docs/components/data-views/examples/tree-custom.md +388 -0
- package/docs/components/data-views/examples/view-registry.md +313 -0
- package/docs/components/data-views/examples/views.md +534 -0
- package/docs/components/data-views/guide.md +405 -0
- package/docs/components/data-views/index.md +1504 -0
- package/docs/components/data-views/migration.md +79 -0
- package/docs/components/date-picker.md +0 -1
- package/docs/components/form-builder.md +19 -8
- package/docs/components/form-renderer.md +2 -1
- package/docs/components/form.md +1 -1
- package/docs/components/input-field.md +1 -1
- package/docs/components/input-otp.md +1 -1
- package/docs/components/input.md +1 -1
- package/docs/components/labeled-check-box.md +1 -1
- package/docs/components/labeled-radio.md +1 -1
- package/docs/components/radio-card.md +1 -1
- package/docs/components/radio.md +1 -1
- package/docs/components/search-field.md +1 -1
- package/docs/components/section-block.md +79 -3
- package/docs/components/select.md +1 -1
- package/docs/components/simple-select.md +1 -1
- package/docs/components/switch.md +1 -1
- package/docs/components/tab-switch.md +1 -1
- package/docs/components/table.md +45 -8
- package/docs/components/text-editor.md +1 -1
- package/docs/components/textarea.md +1 -1
- package/docs/components/toggle-button.md +1 -1
- package/docs/components/toggle.md +1 -1
- package/docs/components/tree-folder.md +110 -0
- package/docs/how-to/forms-with-form-builder.md +6 -4
- package/docs/reference/components.md +16 -6
- package/docs/tutorials/component-composition.md +11 -13
- package/package.json +3 -2
- package/apps/lib/components/DataViews/DataViewRadio.tsx +0 -49
- package/apps/lib/components/DataViews/DataViewsConfigPanel.tsx +0 -393
- package/apps/lib/components/DataViews/DataViewsHeader.tsx +0 -207
- package/apps/lib/components/DataViews/DataViewsLayout.tsx +0 -332
- package/apps/lib/components/DataViews/FilterPanel.tsx +0 -493
- package/apps/lib/components/DataViews/HeaderSearch.tsx +0 -93
- package/apps/lib/components/DataViews/InboxView.tsx +0 -463
- package/apps/lib/components/DataViews/InboxViewCard.tsx +0 -127
- package/apps/lib/components/DataViews/KanbanView.tsx +0 -336
- package/apps/lib/components/DataViews/PanelControls.tsx +0 -39
- package/apps/lib/components/DataViews/SettingsPanel.tsx +0 -279
- package/apps/lib/components/DataViews/TableView.tsx +0 -212
- package/apps/lib/components/DataViews/TreeView.tsx +0 -364
- package/apps/lib/components/DataViews/fieldRenderers.tsx +0 -299
- package/apps/lib/components/DataViews/filters/DatePickerRangeFilter.tsx +0 -87
- package/apps/lib/components/DataViews/filters/DateRangePopover.tsx +0 -120
- package/apps/lib/components/DataViews/filters/PresetChips.tsx +0 -45
- package/apps/lib/components/DataViews/filters/RangeSliderWithInputs.tsx +0 -165
- package/apps/lib/components/DataViews/tree/TreeDrawer.tsx +0 -50
- package/apps/lib/components/DataViews/tree/TreeSidebar.tsx +0 -74
- package/apps/lib/hooks/useDataViewsState.ts +0 -175
- package/apps/lib/utils/dataViews/columnUtils.ts +0 -132
- package/apps/lib/utils/dataViews/fieldUtils.ts +0 -197
- package/apps/lib/utils/dataViews/nestedDataUtils.tsx +0 -371
- package/apps/lib/utils/dataViews/pathUtils.ts +0 -139
- package/apps/lib/utils/dataViews/rangeUtils.ts +0 -234
- package/apps/lib/utils/dataViews/treeUtils.ts +0 -396
- package/docs/components/data-views-config-panel.md +0 -208
- package/docs/components/data-views-layout.md +0 -291
- package/docs/components/inbox-view.md +0 -170
- package/docs/components/kanban-view.md +0 -135
- package/docs/components/table-view.md +0 -141
- package/docs/components/tree-view.md +0 -147
- package/docs/how-to/data-views-from-backend-response.md +0 -194
|
@@ -1,203 +1,510 @@
|
|
|
1
|
-
import type
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
export
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
1
|
+
import type { ReactNode } from "react";
|
|
2
|
+
import type { Themes } from "../../utils/types";
|
|
3
|
+
import type {
|
|
4
|
+
ColumnState,
|
|
5
|
+
DataViewsQuery,
|
|
6
|
+
FieldConfig,
|
|
7
|
+
FilterState,
|
|
8
|
+
MoveIntent,
|
|
9
|
+
Row,
|
|
10
|
+
RowGroup,
|
|
11
|
+
Sort,
|
|
12
|
+
TreeNode,
|
|
13
|
+
} from "../../utils/dataViews/types";
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Props for every DataViews part. No runtime imports — this file is types only, as in
|
|
17
|
+
* `FormBuilder/types.ts`.
|
|
18
|
+
*
|
|
19
|
+
* Read every `on*Change` as intent: DataViews reports what the user did and applies none of it
|
|
20
|
+
* itself. The only state that leaves the component is the query — see `DataViewsRootProps`.
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
// ─── Root ─────────────────────────────────────────────────────────────────────
|
|
24
|
+
|
|
25
|
+
export interface DataViewsRootProps {
|
|
26
|
+
/** The rows to paint — already filtered, searched and sorted by you. */
|
|
27
|
+
rows: readonly Row[];
|
|
28
|
+
/** How to paint each field. Authored, never inferred. */
|
|
29
|
+
fields: readonly FieldConfig[];
|
|
30
|
+
children: ReactNode;
|
|
31
|
+
|
|
32
|
+
/** Stable row identity (default `id ?? _id ?? uuid ?? index`). Selection and drag key off this. */
|
|
33
|
+
getRowId?: (row: Row, index: number) => string;
|
|
34
|
+
/**
|
|
35
|
+
* How many rows match the query, before paging. Supplied by whatever ran it — the component is
|
|
36
|
+
* handed one page and cannot count what it was never sent. It is what `hasMore` is derived from.
|
|
37
|
+
*/
|
|
38
|
+
total?: number;
|
|
39
|
+
/** Fetching. Each view paints skeletons in its own shape rather than emptying itself. */
|
|
40
|
+
loading?: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Called when a view scrolls near its end. Fetch the next page and **append** it to `rows`.
|
|
43
|
+
*
|
|
44
|
+
* A request, not state — it deliberately does not go through `onQueryChange`, so `page` stays
|
|
45
|
+
* the caller's business. With TanStack that is `fetchNextPage`, and `rows` is the flattened
|
|
46
|
+
* pages. Leave it off and nothing loads on scroll.
|
|
47
|
+
*
|
|
48
|
+
* Whether there *is* a next page is not a prop: the component derives it from `rows.length` and
|
|
49
|
+
* `total`, both of which it already has.
|
|
50
|
+
*/
|
|
51
|
+
onLoadMore?: () => void;
|
|
52
|
+
/** True while that next page is in flight. Distinct from `loading`, which is the first load. */
|
|
53
|
+
loadingMore?: boolean;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* What the user has asked for: search, filters, sort, page, page size.
|
|
57
|
+
*
|
|
58
|
+
* This is the only state that leaves the component, because it is the only state you can act on
|
|
59
|
+
* — everything else (which view is showing, which tab is open, how the columns are arranged,
|
|
60
|
+
* what is selected) changes nothing but the picture, so the component keeps it.
|
|
61
|
+
*
|
|
62
|
+
* Wire `onQueryChange` and go fetch. `query` itself is optional: pass it only when something
|
|
63
|
+
* else genuinely owns the query, such as syncing it to the URL.
|
|
64
|
+
*/
|
|
65
|
+
query?: DataViewsQuery;
|
|
66
|
+
onQueryChange?: (query: DataViewsQuery) => void;
|
|
67
|
+
/** Where the query starts. Partial — anything omitted takes its usual default. */
|
|
68
|
+
defaultQuery?: Partial<DataViewsQuery>;
|
|
69
|
+
|
|
70
|
+
/** Which view shows first. Defaults to the first one you rendered. */
|
|
71
|
+
defaultView?: string;
|
|
72
|
+
/** Whether the settings rail starts open. */
|
|
73
|
+
defaultPanelOpen?: boolean;
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Told, not asked. These report UI state the component owns, for the cases where an app has to
|
|
77
|
+
* react to it — a bulk-action bar needs the selection, a router needs the open row. There is no
|
|
78
|
+
* matching value prop: reporting is not the same as being driven.
|
|
79
|
+
*/
|
|
80
|
+
onViewChange?: (view: string) => void;
|
|
81
|
+
onSelectionChange?: (ids: readonly string[]) => void;
|
|
82
|
+
onActiveIdChange?: (id: string | null) => void;
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Applied as `data-theme`, as everywhere else in Glare. Note that the filter dropdowns and the
|
|
86
|
+
* date calendar portal to `document.body`, so they follow the *page* theme rather than this one.
|
|
87
|
+
*/
|
|
88
|
+
theme?: Themes;
|
|
89
|
+
className?: string;
|
|
90
|
+
}
|
|
35
91
|
|
|
36
|
-
|
|
92
|
+
// ─── Shell ────────────────────────────────────────────────────────────────────
|
|
93
|
+
|
|
94
|
+
export interface HeaderProps {
|
|
95
|
+
title?: ReactNode;
|
|
96
|
+
/** `DataViews.ViewSwitch`, `.Search`, `.Actions`, `.PanelToggle` — in whatever order you like. */
|
|
97
|
+
children?: ReactNode;
|
|
98
|
+
className?: string;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export interface ViewSwitchProps {
|
|
102
|
+
className?: string;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export interface SearchProps {
|
|
106
|
+
placeholder?: string;
|
|
107
|
+
className?: string;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export interface ActionsProps {
|
|
111
|
+
children?: ReactNode;
|
|
112
|
+
className?: string;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export interface PanelToggleProps {
|
|
116
|
+
children?: ReactNode;
|
|
117
|
+
className?: string;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// ─── Views ────────────────────────────────────────────────────────────────────
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* What every view hands a render prop.
|
|
124
|
+
*
|
|
125
|
+
* `row` is your record, untouched. `id` is what `getRowId` resolved — the same id selection and
|
|
126
|
+
* drag key off, so it is what you pass back to anything that identifies a row.
|
|
127
|
+
*/
|
|
128
|
+
export interface RowRenderArgs {
|
|
129
|
+
row: Row;
|
|
37
130
|
id: string;
|
|
131
|
+
/** Position within the list this view is painting, not within the dataset. */
|
|
132
|
+
index: number;
|
|
133
|
+
/** The fields the panel left visible, in order — reuse them with `Cell` to stay consistent. */
|
|
134
|
+
fields: readonly FieldConfig[];
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** Shared by every view: how it registers itself in the switcher. */
|
|
138
|
+
export interface ViewBaseProps {
|
|
139
|
+
/** Switcher id. Defaults to the view's own name, so two boards need explicit ids. */
|
|
140
|
+
id?: string;
|
|
38
141
|
label?: string;
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
render?: (value: string, isSelected: boolean) => React.ReactNode;
|
|
43
|
-
onChange?: (selectedValues: string[]) => void;
|
|
44
|
-
};
|
|
45
|
-
|
|
46
|
-
export type NumericRangeFilter = { kind: "number"; min?: number; max?: number };
|
|
47
|
-
export type DateRangeFilter = { kind: "date"; from?: string; to?: string };
|
|
48
|
-
export type RangeFilter = NumericRangeFilter | DateRangeFilter;
|
|
49
|
-
export type FilterValue = string[] | RangeFilter;
|
|
50
|
-
export type FilterState = Record<string, FilterValue>;
|
|
51
|
-
|
|
52
|
-
export type FieldPreset =
|
|
53
|
-
{ label: string; min?: number; max?: number } | { label: string; from?: string; to?: string };
|
|
54
|
-
|
|
55
|
-
// Palette keys for the Kanban column header pill. Kept in lockstep with
|
|
56
|
-
// `COLUMN_PALETTE` in KanbanView.tsx so consumers can pick a color per status
|
|
57
|
-
// via `FieldConfig.kanbanVariants`.
|
|
58
|
-
export type KanbanColumnColor = "gray" | "purple" | "orange" | "blue" | "green" | "red";
|
|
59
|
-
|
|
60
|
-
export type BadgeVariant =
|
|
61
|
-
| "green"
|
|
62
|
-
| "greenLight"
|
|
63
|
-
| "cocktailGreen"
|
|
64
|
-
| "yellow"
|
|
65
|
-
| "redOrange"
|
|
66
|
-
| "redLight"
|
|
67
|
-
| "rose"
|
|
68
|
-
| "purple"
|
|
69
|
-
| "bluePurple"
|
|
70
|
-
| "blue"
|
|
71
|
-
| "navy"
|
|
72
|
-
| "gray"
|
|
73
|
-
| "highlight";
|
|
74
|
-
|
|
75
|
-
export type FieldType =
|
|
76
|
-
| "text"
|
|
77
|
-
| "number"
|
|
78
|
-
| "date"
|
|
79
|
-
| "boolean"
|
|
80
|
-
| "hidden"
|
|
81
|
-
| "enum-badge"
|
|
82
|
-
| "badge-array"
|
|
83
|
-
| "currency"
|
|
84
|
-
| "number-format"
|
|
85
|
-
| "progress-bar"
|
|
86
|
-
| "star-rating"
|
|
87
|
-
| "icon-text"
|
|
88
|
-
| "two-line"
|
|
89
|
-
| "avatar"
|
|
90
|
-
| "link"
|
|
91
|
-
| "image"
|
|
92
|
-
| "date-format";
|
|
93
|
-
|
|
94
|
-
export type CurrencyOptions = {
|
|
95
|
-
symbol?: string;
|
|
96
|
-
locale?: string;
|
|
97
|
-
decimals?: number;
|
|
98
|
-
code?: string;
|
|
99
|
-
};
|
|
100
|
-
|
|
101
|
-
export type FieldConfig = {
|
|
102
|
-
path: string;
|
|
103
|
-
label?: string;
|
|
104
|
-
type?: FieldType;
|
|
105
|
-
visible?: boolean;
|
|
106
|
-
order?: number;
|
|
142
|
+
icon?: ReactNode;
|
|
143
|
+
className?: string;
|
|
144
|
+
}
|
|
107
145
|
|
|
108
|
-
|
|
109
|
-
|
|
146
|
+
export interface TableViewProps extends ViewBaseProps {
|
|
147
|
+
/** Per-row checkboxes and select-all (default `false`). */
|
|
148
|
+
selectable?: boolean;
|
|
149
|
+
onRowClick?: (row: Row, id: string) => void;
|
|
150
|
+
/**
|
|
151
|
+
* Show a "+ Add New" row at the foot of the table, and what to do when it is pressed. Without
|
|
152
|
+
* it there is no row — the same rule the rest of the component follows: a part exists because
|
|
153
|
+
* you asked for it.
|
|
154
|
+
*/
|
|
155
|
+
onAddRow?: () => void;
|
|
156
|
+
/** The label on that row. Defaults to "Add New". */
|
|
157
|
+
addRowLabel?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Reorder rows by dragging. Passing it adds a grip column; leaving it off means no drag at all.
|
|
160
|
+
*
|
|
161
|
+
* Like every other drag here it emits intent and moves nothing — the row settles where it landed
|
|
162
|
+
* only once you hand back reordered `rows`.
|
|
163
|
+
*
|
|
164
|
+
* **A manual order and a sort are two different orders**, and the component cannot reconcile
|
|
165
|
+
* them: it paints whatever you give it. If a sort is active when someone drags a row, decide
|
|
166
|
+
* which one wins — usually by clearing `sort` in the same update that persists the new position.
|
|
167
|
+
*/
|
|
168
|
+
onRowMove?: (intent: MoveIntent) => void;
|
|
169
|
+
/**
|
|
170
|
+
* Paint one cell yourself, in this view only.
|
|
171
|
+
*
|
|
172
|
+
* `FieldConfig.render` is the other way to do this and usually the better one: it applies
|
|
173
|
+
* wherever the field is painted, so the board's cards and the tree's labels agree with the
|
|
174
|
+
* table. Reach for this when a field should look *different here* — wider, with an action, or
|
|
175
|
+
* with context only the table has.
|
|
176
|
+
*
|
|
177
|
+
* Return `undefined` to fall through to the normal painting for that cell.
|
|
178
|
+
*/
|
|
179
|
+
renderCell?: (args: RowRenderArgs & { field: FieldConfig }) => ReactNode;
|
|
180
|
+
}
|
|
110
181
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
182
|
+
export interface BoardViewProps extends ViewBaseProps {
|
|
183
|
+
/** Pre-grouped columns. You build these — the board never groups rows itself. */
|
|
184
|
+
groups: readonly RowGroup[];
|
|
185
|
+
/** Which field to show as the card title. */
|
|
186
|
+
titlePath?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Replace the card.
|
|
189
|
+
*
|
|
190
|
+
* The board still owns the wrapper — dragging, the drop target, the click that opens a row —
|
|
191
|
+
* and yours goes inside it, so a custom card keeps working with `onRowMove` without wiring any
|
|
192
|
+
* of it yourself. `group` is the column it is sitting in.
|
|
193
|
+
*
|
|
194
|
+
* ```tsx
|
|
195
|
+
* <DataViews.Board
|
|
196
|
+
* groups={groups}
|
|
197
|
+
* renderCard={({ row, fields, isActive }) => (
|
|
198
|
+
* <MyCard highlighted={isActive}>
|
|
199
|
+
* <Cell field={fields[0]} row={row} />
|
|
200
|
+
* </MyCard>
|
|
201
|
+
* )}
|
|
202
|
+
* />
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
renderCard?: (
|
|
206
|
+
args: RowRenderArgs & { group: RowGroup; isActive: boolean; isDragging: boolean },
|
|
207
|
+
) => ReactNode;
|
|
208
|
+
/** Drag-and-drop. Emits intent; the card does not move until you update `rows`. */
|
|
209
|
+
onRowMove?: (intent: MoveIntent) => void;
|
|
210
|
+
onColumnAction?: (groupId: string) => void;
|
|
211
|
+
}
|
|
116
212
|
|
|
117
|
-
|
|
118
|
-
|
|
213
|
+
export interface InboxViewProps extends ViewBaseProps {
|
|
214
|
+
/** The detail pane. Rendered beside the list; yours to fill. */
|
|
215
|
+
children?: ReactNode;
|
|
216
|
+
/**
|
|
217
|
+
* Replace the list item's contents. The row keeps its hover and selected treatment, its click
|
|
218
|
+
* handling and its link — this fills the inside.
|
|
219
|
+
*/
|
|
220
|
+
renderItem?: (args: RowRenderArgs & { isActive: boolean }) => ReactNode;
|
|
221
|
+
/** Names the field whose label titles the list column. */
|
|
222
|
+
titlePath?: string;
|
|
223
|
+
/** Pulled out of the card body and shown as a pill. Defaults to the first date field. */
|
|
224
|
+
datePath?: string;
|
|
225
|
+
itemHref?: (row: Row, id: string) => string;
|
|
226
|
+
/** Your router's Link, so selection navigates client-side. Defaults to a plain `<a>`. */
|
|
227
|
+
linkComponent?: React.ElementType;
|
|
228
|
+
placeholder?: ReactNode;
|
|
229
|
+
}
|
|
119
230
|
|
|
120
|
-
|
|
121
|
-
|
|
231
|
+
/**
|
|
232
|
+
* Which shape the tree's pane lists the selected node's rows in.
|
|
233
|
+
*
|
|
234
|
+
* `"table"` and `"cards"` are built in; any other string is the `value` of a
|
|
235
|
+
* `DataViews.Tree.PaneTab` you rendered.
|
|
236
|
+
*/
|
|
237
|
+
export type TreePaneMode = "table" | "cards" | (string & NonNullable<unknown>);
|
|
122
238
|
|
|
123
|
-
|
|
239
|
+
/**
|
|
240
|
+
* What every tab in the tree's pane can say about itself in the switch. The two built-in views
|
|
241
|
+
* fill these in — `DataViews.Tree.Table` is "List", `DataViews.Tree.Cards` is "Cards" — so you
|
|
242
|
+
* pass them only to rename a tab or to register the same view twice.
|
|
243
|
+
*/
|
|
244
|
+
export interface TreePaneViewBase {
|
|
245
|
+
/** What `paneMode` becomes while this tab shows. Defaults to `"table"` / `"cards"`. */
|
|
246
|
+
value?: string;
|
|
247
|
+
label?: string;
|
|
248
|
+
icon?: ReactNode;
|
|
249
|
+
}
|
|
124
250
|
|
|
125
|
-
|
|
251
|
+
/**
|
|
252
|
+
* `DataViews.Tree.Table` — the pane as a table. Everything `DataViews.Table` can do, over the
|
|
253
|
+
* selected node's rows rather than the root's.
|
|
254
|
+
*/
|
|
255
|
+
export interface TreePaneTableProps
|
|
256
|
+
extends TreePaneViewBase,
|
|
257
|
+
Omit<TableViewProps, keyof ViewBaseProps> {}
|
|
126
258
|
|
|
127
|
-
|
|
128
|
-
|
|
259
|
+
/** `DataViews.Tree.Cards` — the pane as a grid of cards. */
|
|
260
|
+
export interface TreePaneCardsProps extends TreePaneViewBase {
|
|
261
|
+
/** Replaces `DataViewCard` outright. Same signature as the board's `renderCard`. */
|
|
262
|
+
renderCard?: (args: RowRenderArgs) => ReactNode;
|
|
263
|
+
/** Replaces the grid's own classes — the responsive 1/2/3 columns and its padding. */
|
|
264
|
+
className?: string;
|
|
265
|
+
}
|
|
129
266
|
|
|
130
|
-
|
|
267
|
+
/**
|
|
268
|
+
* `DataViews.Tree.Tab` — a mode of your own, beside the built-in two. Its `children` are the pane
|
|
269
|
+
* while it is selected and nothing while it is not.
|
|
270
|
+
*/
|
|
271
|
+
export interface TreePaneTabProps extends TreePaneViewBase {
|
|
272
|
+
/** Required: there is no sensible default name for a view only you know about. */
|
|
273
|
+
value: string;
|
|
274
|
+
label: string;
|
|
275
|
+
children?: ReactNode;
|
|
276
|
+
}
|
|
131
277
|
|
|
132
|
-
|
|
278
|
+
export interface TreeViewProps extends ViewBaseProps {
|
|
279
|
+
/**
|
|
280
|
+
* The pane's mode. Omit to let the view hold it.
|
|
281
|
+
*
|
|
282
|
+
* Seed the starting mode with `defaultPaneMode` and persist every switch from
|
|
283
|
+
* `onPaneModeChange` — the same round-trip the query uses, so a reload can restore what the
|
|
284
|
+
* user last chose.
|
|
285
|
+
*/
|
|
286
|
+
paneMode?: TreePaneMode;
|
|
287
|
+
/**
|
|
288
|
+
* Initial mode when uncontrolled. Defaults to the **first tab you rendered** — so a pane whose
|
|
289
|
+
* only tab is your own opens on it rather than on a `"table"` that matches nothing.
|
|
290
|
+
*/
|
|
291
|
+
defaultPaneMode?: TreePaneMode;
|
|
292
|
+
/** Told when the user switches. The component still owns the mode. */
|
|
293
|
+
onPaneModeChange?: (mode: TreePaneMode) => void;
|
|
294
|
+
/**
|
|
295
|
+
* Which rows the pane lists for the selected node.
|
|
296
|
+
*
|
|
297
|
+
* Defaults to the node's **descendants** — a branch shows what is under it, a leaf shows
|
|
298
|
+
* itself. Override it when the tree and the pane hold different things: a tree of categories
|
|
299
|
+
* whose pane must list that category's items, for instance.
|
|
300
|
+
*/
|
|
301
|
+
paneRows?: (node: TreeNode) => readonly Row[];
|
|
302
|
+
/**
|
|
303
|
+
* Your markup in the pane's header, between the record count and the mode switch — an
|
|
304
|
+
* "Add item" button, a menu, a count of your own.
|
|
305
|
+
*
|
|
306
|
+
* It is a node rather than a render prop because the header is a slot, not a template: what
|
|
307
|
+
* belongs there rarely varies per node, and what does can read `useActiveRow()`.
|
|
308
|
+
*/
|
|
309
|
+
paneActions?: ReactNode;
|
|
310
|
+
/** Pre-built hierarchy. You build it — the tree never derives one from the rows. */
|
|
311
|
+
nodes: readonly TreeNode[];
|
|
312
|
+
labelPath?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Dress a node in the rail.
|
|
315
|
+
*
|
|
316
|
+
* `TreeFolder` owns the row — the indent, the connector lines, the selection band, the drag
|
|
317
|
+
* grip — and takes its label as text, so this returns the three pieces it *can* vary rather
|
|
318
|
+
* than arbitrary markup. `icon` sits before the name, `meta` after it.
|
|
319
|
+
*
|
|
320
|
+
* ```tsx
|
|
321
|
+
* renderNode={({ row }) => ({
|
|
322
|
+
* icon: <Avatar size="XS" src={row.avatar as string} />,
|
|
323
|
+
* meta: <Badge label={row.status as string} color="blue" />,
|
|
324
|
+
* })}
|
|
325
|
+
* ```
|
|
326
|
+
*
|
|
327
|
+
* For markup a row cannot hold, put it in `children` — that pane is entirely yours.
|
|
328
|
+
*/
|
|
329
|
+
renderNode?: (args: { node: TreeNode; row: Row; fields: readonly FieldConfig[] }) => {
|
|
330
|
+
name?: string;
|
|
331
|
+
icon?: ReactNode;
|
|
332
|
+
meta?: ReactNode;
|
|
333
|
+
};
|
|
334
|
+
expanded?: readonly string[];
|
|
335
|
+
onExpandedChange?: (ids: readonly string[]) => void;
|
|
336
|
+
/** Which node is selected is `activeId` — the tree keeps no second copy. */
|
|
337
|
+
onNodeMove?: (intent: MoveIntent) => void;
|
|
338
|
+
/**
|
|
339
|
+
* The pane's tabs: `DataViews.Tree.Table`, `DataViews.Tree.Cards`, and any
|
|
340
|
+
* `DataViews.Tree.Tab` of your own. A tab exists because you rendered it, and the switch shows
|
|
341
|
+
* exactly what you passed — one tab and there is no switch at all, the same rule `ViewSwitch`
|
|
342
|
+
* follows. Pass **none** and there is no pane: the tree is a hierarchy and takes the whole
|
|
343
|
+
* width, because a part exists here only if you rendered it.
|
|
344
|
+
*
|
|
345
|
+
* ```tsx
|
|
346
|
+
* <DataViews.Tree nodes={nodes} labelPath="name">
|
|
347
|
+
* <DataViews.Tree.Table selectable renderCell={cell} />
|
|
348
|
+
* <DataViews.Tree.Cards renderCard={card} />
|
|
349
|
+
* <DataViews.Tree.Tab value="timeline" label="Timeline"><Timeline /></DataViews.Tree.Tab>
|
|
350
|
+
* </DataViews.Tree>
|
|
351
|
+
* ```
|
|
352
|
+
*
|
|
353
|
+
* Anything here that is **not** one of those three *is* the pane — the whole-pane override,
|
|
354
|
+
* header and switch included, which is what a tree written before these tabs existed passes.
|
|
355
|
+
*/
|
|
356
|
+
children?: ReactNode;
|
|
357
|
+
}
|
|
133
358
|
|
|
134
|
-
|
|
359
|
+
// ─── Panel ────────────────────────────────────────────────────────────────────
|
|
135
360
|
|
|
136
|
-
|
|
361
|
+
export interface PanelProps {
|
|
362
|
+
children?: ReactNode;
|
|
363
|
+
/** Which tab shows first. Defaults to the first one you rendered. */
|
|
364
|
+
defaultTab?: string;
|
|
365
|
+
title?: ReactNode;
|
|
366
|
+
className?: string;
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
export interface PanelTabProps {
|
|
370
|
+
value: string;
|
|
371
|
+
label: string;
|
|
372
|
+
icon?: ReactNode;
|
|
373
|
+
children?: ReactNode;
|
|
374
|
+
}
|
|
137
375
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
376
|
+
export interface PanelSectionProps {
|
|
377
|
+
/**
|
|
378
|
+
* A small line under the title explaining the section — Figma's
|
|
379
|
+
* "Show or hide columns in table view". Optional; most sections have none.
|
|
380
|
+
*
|
|
381
|
+
* It sits with the header rather than inside the fold, so it still reads when the group is shut.
|
|
382
|
+
*/
|
|
383
|
+
description?: ReactNode;
|
|
384
|
+
/** Collapsible via its `ConclusionHeader` title. Defaults to `true` when there is a title. */
|
|
385
|
+
collapsible?: boolean;
|
|
386
|
+
/** Initial open state when collapsible. Defaults to `true`, so nothing starts folded. */
|
|
387
|
+
defaultOpen?: boolean;
|
|
388
|
+
title?: ReactNode;
|
|
389
|
+
children?: ReactNode;
|
|
390
|
+
className?: string;
|
|
391
|
+
}
|
|
142
392
|
|
|
143
|
-
|
|
144
|
-
filterLabel?: string;
|
|
145
|
-
filterOptions?: string[] | { label: string; value: string }[];
|
|
393
|
+
export interface PanelColumnsProps {
|
|
146
394
|
/**
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
395
|
+
* A small line under the title explaining the section — Figma's
|
|
396
|
+
* "Show or hide columns in table view". Optional; most sections have none.
|
|
397
|
+
*
|
|
398
|
+
* It sits with the header rather than inside the fold, so it still reads when the group is shut.
|
|
150
399
|
*/
|
|
151
|
-
|
|
400
|
+
description?: ReactNode;
|
|
401
|
+
title?: ReactNode;
|
|
152
402
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
* when a field has many options. Implies single-select; the FilterValue is
|
|
157
|
-
* a 1-element array (or empty when cleared).
|
|
403
|
+
* Column visibility and order — drag to reorder, toggle to hide. The component holds it: every
|
|
404
|
+
* view paints from the same arrangement, so hiding a column here also retitles the board's
|
|
405
|
+
* cards, and nothing outside the component can act on it.
|
|
158
406
|
*/
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
rangeMin?: number;
|
|
162
|
-
rangeMax?: number;
|
|
163
|
-
rangeStep?: number;
|
|
164
|
-
onFilterChange?: (value: FilterValue) => void;
|
|
407
|
+
className?: string;
|
|
408
|
+
}
|
|
165
409
|
|
|
166
|
-
|
|
167
|
-
|
|
410
|
+
export interface PanelSortProps {
|
|
411
|
+
title?: ReactNode;
|
|
412
|
+
/** The same sort the table's column headers set. Both write to the query. */
|
|
413
|
+
className?: string;
|
|
414
|
+
}
|
|
168
415
|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
previewPath?: string;
|
|
176
|
-
};
|
|
416
|
+
/** What a saved view restores. Opaque to you — hand back whatever `onSave` gave you. */
|
|
417
|
+
export interface SavedViewSnapshot {
|
|
418
|
+
filters: FilterState;
|
|
419
|
+
sort: Sort;
|
|
420
|
+
columns: readonly ColumnState[];
|
|
421
|
+
}
|
|
177
422
|
|
|
178
|
-
export
|
|
423
|
+
export interface SavedView {
|
|
179
424
|
id: string;
|
|
180
425
|
label: string;
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
export
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
426
|
+
/** What `onSave` handed you. Selecting the view applies it. */
|
|
427
|
+
snapshot?: SavedViewSnapshot;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
export interface PanelSavedViewsProps {
|
|
431
|
+
title?: ReactNode;
|
|
432
|
+
views?: readonly SavedView[];
|
|
433
|
+
/** Told which view was picked, after it has been applied. */
|
|
434
|
+
onValueChange?: (id: string) => void;
|
|
435
|
+
/**
|
|
436
|
+
* Called with everything needed to persist a view. Store it against an id and hand it back in
|
|
437
|
+
* `views` — selecting it puts the filters, sort and columns back.
|
|
438
|
+
*/
|
|
439
|
+
onSave?: (snapshot: SavedViewSnapshot) => void;
|
|
440
|
+
saveLabel?: ReactNode;
|
|
441
|
+
className?: string;
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
// ─── Filters ──────────────────────────────────────────────────────────────────
|
|
445
|
+
|
|
446
|
+
export interface FiltersProps {
|
|
447
|
+
/**
|
|
448
|
+
* A small line under the title explaining the section — Figma's
|
|
449
|
+
* "Show or hide columns in table view". Optional; most sections have none.
|
|
450
|
+
*
|
|
451
|
+
* It sits with the header rather than inside the fold, so it still reads when the group is shut.
|
|
452
|
+
*/
|
|
453
|
+
description?: ReactNode;
|
|
454
|
+
/** Collapsible via its `ConclusionHeader` title. Defaults to `true` when there is a title. */
|
|
455
|
+
collapsible?: boolean;
|
|
456
|
+
/** Initial open state when collapsible. Defaults to `true`, so nothing starts folded. */
|
|
457
|
+
defaultOpen?: boolean;
|
|
458
|
+
/**
|
|
459
|
+
* The controls, as `FormBuilder` fields — one JSX child per filter, exactly as a form is
|
|
460
|
+
* written. `Filters` reads each child's `name`, `label` and bounds to learn what it is:
|
|
461
|
+
*
|
|
462
|
+
* ```tsx
|
|
463
|
+
* <DataViews.Filters>
|
|
464
|
+
* <FormBuilder.MultiSelect name="status" label="Status" options={STATUS} />
|
|
465
|
+
* <FormBuilder.Slider name="total" label="Total" range min={0} max={15000} />
|
|
466
|
+
* </DataViews.Filters>
|
|
467
|
+
* ```
|
|
468
|
+
*
|
|
469
|
+
* Fields whose value has no filter meaning — `Checkbox`, `File`, `Custom` — are rendered but not
|
|
470
|
+
* collected; use `Filters.Custom` for a control of your own.
|
|
471
|
+
*/
|
|
472
|
+
children?: ReactNode;
|
|
473
|
+
title?: ReactNode;
|
|
474
|
+
clearLabel?: ReactNode;
|
|
475
|
+
className?: string;
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
export interface FilterControlProps {
|
|
479
|
+
path: string;
|
|
480
|
+
label?: ReactNode;
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* `DataViews.Filters.Presets` — one-click shortcuts for a slider or a date range, which
|
|
485
|
+
* FormBuilder has no field for.
|
|
486
|
+
*
|
|
487
|
+
* ```tsx
|
|
488
|
+
* <FormBuilder.Slider name="total" label="Total" range min={0} max={15000} />
|
|
489
|
+
* <DataViews.Filters.Presets for="total" items={[{ label: "Under $500", max: 500 }]} />
|
|
490
|
+
* ```
|
|
491
|
+
*/
|
|
492
|
+
export interface FilterPresetsProps {
|
|
493
|
+
/** The `name` of the field these apply to. */
|
|
494
|
+
for: string;
|
|
495
|
+
items: readonly import("../../utils/dataViews/types").Preset[];
|
|
496
|
+
className?: string;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
export interface FilterCustomProps extends FilterControlProps {
|
|
500
|
+
/** The escape hatch — render any control against this filter's value. */
|
|
501
|
+
render: (args: {
|
|
502
|
+
value: import("../../utils/dataViews/types").FilterValue | undefined;
|
|
503
|
+
setValue: (v: import("../../utils/dataViews/types").FilterValue | undefined) => void;
|
|
504
|
+
}) => ReactNode;
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
// ─── Pagination ───────────────────────────────────────────────────────────────
|
|
508
|
+
|
|
509
|
+
// ─── States ───────────────────────────────────────────────────────────────────
|
|
510
|
+
|