@gridui/data-explorer 1.2.1 → 1.2.2
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/README.md +2 -0
- package/docs/catalog.json +8 -2
- package/docs/reference/README.md +8 -0
- package/docs/reference/data-explorer-bulk-actions.md +23 -0
- package/docs/reference/data-explorer-pagination.md +23 -0
- package/docs/reference/data-explorer-table.md +23 -0
- package/docs/reference/data-explorer-toolbar.md +23 -0
- package/docs/reference/data-explorer.md +129 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -83,3 +83,5 @@ their defaults. New features are opt-in and use the same native table and styles
|
|
|
83
83
|
|
|
84
84
|
All optional feature labels are caller-owned. Remote paging, authorization,
|
|
85
85
|
query serialization and persistence remain application responsibilities.
|
|
86
|
+
|
|
87
|
+
[Component reference](docs/reference/README.md) contains focused API pages for each public component.
|
package/docs/catalog.json
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/data-explorer",
|
|
4
|
-
"version": "1.2.
|
|
4
|
+
"version": "1.2.2",
|
|
5
5
|
"category": "dashboard",
|
|
6
6
|
"description": "GridUI React data explorer",
|
|
7
7
|
"usage": "DataExplorer, Composer, and ApprovalPanel belong to Dashboard because they coordinate multiple lower-package contracts. See task workspace compositions for controlled state, callbacks, and application responsibilities.",
|
|
8
8
|
"documentation": [
|
|
9
|
-
"README.md"
|
|
9
|
+
"README.md",
|
|
10
|
+
"docs/reference/README.md",
|
|
11
|
+
"docs/reference/data-explorer-bulk-actions.md",
|
|
12
|
+
"docs/reference/data-explorer-pagination.md",
|
|
13
|
+
"docs/reference/data-explorer-table.md",
|
|
14
|
+
"docs/reference/data-explorer-toolbar.md",
|
|
15
|
+
"docs/reference/data-explorer.md"
|
|
10
16
|
],
|
|
11
17
|
"exports": [
|
|
12
18
|
{
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
<!-- Generated by pnpm docs:storybook. -->
|
|
2
|
+
# Component reference
|
|
3
|
+
|
|
4
|
+
- [DataExplorer](data-explorer.md)
|
|
5
|
+
- [DataExplorerBulkActions](data-explorer-bulk-actions.md)
|
|
6
|
+
- [DataExplorerPagination](data-explorer-pagination.md)
|
|
7
|
+
- [DataExplorerTable](data-explorer-table.md)
|
|
8
|
+
- [DataExplorerToolbar](data-explorer-toolbar.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerBulkActions
|
|
3
|
+
|
|
4
|
+
Public DataExplorerBulkActions component from @gridui/data-explorer. See the package guide for its composition contract.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/data-explorer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DataExplorerBulkActions } from "@gridui/data-explorer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/data-explorer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
## API
|
|
17
|
+
|
|
18
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
19
|
+
|
|
20
|
+
### className
|
|
21
|
+
|
|
22
|
+
``string | undefined`` · Optional
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerPagination
|
|
3
|
+
|
|
4
|
+
Public DataExplorerPagination component from @gridui/data-explorer. See the package guide for its composition contract.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/data-explorer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DataExplorerPagination } from "@gridui/data-explorer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/data-explorer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
## API
|
|
17
|
+
|
|
18
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
19
|
+
|
|
20
|
+
### className
|
|
21
|
+
|
|
22
|
+
``string | undefined`` · Optional
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerTable
|
|
3
|
+
|
|
4
|
+
Public DataExplorerTable component from @gridui/data-explorer. See the package guide for its composition contract.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/data-explorer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DataExplorerTable } from "@gridui/data-explorer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/data-explorer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
## API
|
|
17
|
+
|
|
18
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
19
|
+
|
|
20
|
+
### className
|
|
21
|
+
|
|
22
|
+
``string | undefined`` · Optional
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerToolbar
|
|
3
|
+
|
|
4
|
+
Public DataExplorerToolbar component from @gridui/data-explorer. See the package guide for its composition contract.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/data-explorer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DataExplorerToolbar } from "@gridui/data-explorer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/data-explorer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
## API
|
|
17
|
+
|
|
18
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
19
|
+
|
|
20
|
+
### className
|
|
21
|
+
|
|
22
|
+
``string | undefined`` · Optional
|
|
23
|
+
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorer
|
|
3
|
+
|
|
4
|
+
Combines a table with searching, filtering, selection, and pagination controls. Use it for managing a collection of records.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/data-explorer`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { DataExplorer } from "@gridui/data-explorer";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/data-explorer/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-dashboard/data-explorer/stories/data-explorer.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### rows
|
|
59
|
+
|
|
60
|
+
``readonly DataExplorerRow[]`` · Required
|
|
61
|
+
|
|
62
|
+
### columns
|
|
63
|
+
|
|
64
|
+
``readonly DataExplorerColumn[]`` · Required
|
|
65
|
+
|
|
66
|
+
### state
|
|
67
|
+
|
|
68
|
+
``DataExplorerState`` · Required
|
|
69
|
+
|
|
70
|
+
### onStateChange
|
|
71
|
+
|
|
72
|
+
``(state: DataExplorerState): void`` · Required
|
|
73
|
+
|
|
74
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
75
|
+
|
|
76
|
+
### filter
|
|
77
|
+
|
|
78
|
+
``DataExplorerFilter | undefined`` · Optional
|
|
79
|
+
|
|
80
|
+
### columnSettings
|
|
81
|
+
|
|
82
|
+
``DataExplorerColumnSettings | undefined`` · Optional
|
|
83
|
+
|
|
84
|
+
### columnSizing
|
|
85
|
+
|
|
86
|
+
``DataExplorerColumnSizing | undefined`` · Optional
|
|
87
|
+
|
|
88
|
+
### details
|
|
89
|
+
|
|
90
|
+
``DataExplorerDetails | undefined`` · Optional
|
|
91
|
+
|
|
92
|
+
### filtering
|
|
93
|
+
|
|
94
|
+
``DataExplorerFiltering | undefined`` · Optional
|
|
95
|
+
|
|
96
|
+
### pageSize
|
|
97
|
+
|
|
98
|
+
``number | undefined`` · Optional
|
|
99
|
+
|
|
100
|
+
### selectedIds
|
|
101
|
+
|
|
102
|
+
``readonly string[] | undefined`` · Optional
|
|
103
|
+
|
|
104
|
+
### onSelectionChange
|
|
105
|
+
|
|
106
|
+
``(ids: readonly string[]): void`` · Optional
|
|
107
|
+
|
|
108
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
109
|
+
|
|
110
|
+
### actions
|
|
111
|
+
|
|
112
|
+
``readonly { readonly label: string; readonly onAction: (ids: readonly string[]) => void; readonly disabled?: boolean; }[] | undefined`` · Optional
|
|
113
|
+
|
|
114
|
+
### renderCell
|
|
115
|
+
|
|
116
|
+
``((value: DataExplorerValue | undefined, row: DataExplorerRow, column: DataExplorerColumn) => ReactNode) | undefined`` · Optional
|
|
117
|
+
|
|
118
|
+
### busy
|
|
119
|
+
|
|
120
|
+
``boolean | undefined`` · Optional
|
|
121
|
+
|
|
122
|
+
### notice
|
|
123
|
+
|
|
124
|
+
``ReactNode`` · Optional
|
|
125
|
+
|
|
126
|
+
### labels
|
|
127
|
+
|
|
128
|
+
``{ readonly table: string; readonly search: string; readonly sort: string; readonly unsorted: string; readonly ascending: string; readonly descending: string; readonly all: string; readonly selection: string; readonly selectPage: string; readonly selectRow: (row: DataExplorerRow) => string; readonly selected: (count: number) => string; readonly previous: string; readonly next: string; readonly page: (page: number, pages: number, total: number) => string; readonly empty: string; }`` · Required
|
|
129
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/data-explorer",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.2",
|
|
4
4
|
"description": "GridUI React data explorer",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@gridui/button": "^4.0.0",
|
|
31
|
-
"@gridui/choice": "^1.2.
|
|
31
|
+
"@gridui/choice": "^1.2.5",
|
|
32
32
|
"@gridui/grid": "^2.3.6",
|
|
33
|
-
"@gridui/input": "^
|
|
33
|
+
"@gridui/input": "^3.0.0",
|
|
34
34
|
"@gridui/interaction": "^1.2.1",
|
|
35
|
-
"@gridui/select": "^1.
|
|
35
|
+
"@gridui/select": "^1.2.0",
|
|
36
36
|
"@gridui/style-utils": "^3.0.0",
|
|
37
37
|
"@gridui/table": "^2.0.1",
|
|
38
38
|
"@gridui/theme": "^2.5.3",
|