@gridui/data-explorer 1.3.0 → 1.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/README.md +79 -12
- package/dist/data-explorer/data-explorer.d.ts +1 -0
- package/dist/data-explorer-bulk-actions/data-explorer-bulk-actions.d.ts +4 -2
- package/dist/data-explorer-column-visibility/data-explorer-column-visibility.d.ts +11 -0
- package/dist/data-explorer-filter-control/data-explorer-filter-control.d.ts +11 -0
- package/dist/data-explorer-filters/data-explorer-filters.d.ts +11 -0
- package/dist/{data-explorer-toolbar → data-explorer-filters}/filter-editor.d.ts +1 -1
- package/dist/data-explorer-pagination/data-explorer-pagination.d.ts +4 -2
- package/dist/data-explorer-provider/data-explorer-provider.d.ts +13 -0
- package/dist/data-explorer-search/data-explorer-search.d.ts +11 -0
- package/dist/data-explorer-sort/data-explorer-sort.d.ts +11 -0
- package/dist/data-explorer-table/data-explorer-table.d.ts +4 -2
- package/dist/data-explorer-toolbar/data-explorer-toolbar.d.ts +5 -3
- package/dist/data-explorer-view/data-explorer-view.d.ts +12 -0
- package/dist/{data-explorer → data-explorer-view}/style.d.ts +1 -1
- package/dist/index.d.ts +17 -0
- package/dist/index.js +314 -372
- package/dist/index.js.map +4 -4
- package/dist/shared/controller.d.ts +32 -0
- package/dist/shared/explorer-context.d.ts +126 -71
- package/dist/shared/explorer-options.d.ts +22 -18
- package/dist/{data-explorer-toolbar/style.d.ts → shared/label-style.d.ts} +2 -2
- package/dist/shared/labels.d.ts +8 -0
- package/dist/styled.js +8 -0
- package/dist/styles.css +2911 -0
- package/dist/styles.local.css +114 -0
- package/docs/catalog.json +99 -1
- package/docs/reference/README.md +7 -0
- package/docs/reference/data-explorer-bulk-actions.md +4 -0
- package/docs/reference/data-explorer-column-visibility.md +27 -0
- package/docs/reference/data-explorer-filter-control.md +27 -0
- package/docs/reference/data-explorer-filters.md +23 -0
- package/docs/reference/data-explorer-pagination.md +4 -0
- package/docs/reference/data-explorer-provider.md +97 -0
- package/docs/reference/data-explorer-search.md +27 -0
- package/docs/reference/data-explorer-sort.md +27 -0
- package/docs/reference/data-explorer-table.md +4 -0
- package/docs/reference/data-explorer-toolbar.md +6 -0
- package/docs/reference/data-explorer-view.md +59 -0
- package/docs/reference/data-explorer.md +1 -1
- package/package.json +33 -15
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/*! tailwindcss v4.3.5 | MIT License | https://tailwindcss.com */
|
|
2
|
+
@layer properties;
|
|
3
|
+
@layer theme, base, components, utilities;
|
|
4
|
+
@layer theme {
|
|
5
|
+
:root, :host {
|
|
6
|
+
--spacing: 0.25rem;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
@layer utilities {
|
|
10
|
+
.gridui-u-data-explorer--m-0 {
|
|
11
|
+
margin: 0px;
|
|
12
|
+
}
|
|
13
|
+
.gridui-u-data-explorer--flex {
|
|
14
|
+
display: flex;
|
|
15
|
+
}
|
|
16
|
+
.gridui-u-data-explorer--min-h-11 {
|
|
17
|
+
min-height: calc(var(--spacing) * 11);
|
|
18
|
+
}
|
|
19
|
+
.gridui-u-data-explorer--w-gridui-16 {
|
|
20
|
+
width: var(--gridui-space-16);
|
|
21
|
+
}
|
|
22
|
+
.gridui-u-data-explorer--min-w-0 {
|
|
23
|
+
min-width: 0px;
|
|
24
|
+
}
|
|
25
|
+
.gridui-u-data-explorer--flex-\[1_1_10rem\] {
|
|
26
|
+
flex: 1 1 10rem;
|
|
27
|
+
}
|
|
28
|
+
.gridui-u-data-explorer--shrink-0 {
|
|
29
|
+
flex-shrink: 0;
|
|
30
|
+
}
|
|
31
|
+
.gridui-u-data-explorer--cursor-col-resize {
|
|
32
|
+
cursor: col-resize;
|
|
33
|
+
}
|
|
34
|
+
.gridui-u-data-explorer--cursor-pointer {
|
|
35
|
+
cursor: pointer;
|
|
36
|
+
}
|
|
37
|
+
.gridui-u-data-explorer--touch-none {
|
|
38
|
+
touch-action: none;
|
|
39
|
+
}
|
|
40
|
+
.gridui-u-data-explorer--flex-col {
|
|
41
|
+
flex-direction: column;
|
|
42
|
+
}
|
|
43
|
+
.gridui-u-data-explorer--flex-wrap {
|
|
44
|
+
flex-wrap: wrap;
|
|
45
|
+
}
|
|
46
|
+
.gridui-u-data-explorer--items-center {
|
|
47
|
+
align-items: center;
|
|
48
|
+
}
|
|
49
|
+
.gridui-u-data-explorer--items-end {
|
|
50
|
+
align-items: flex-end;
|
|
51
|
+
}
|
|
52
|
+
.gridui-u-data-explorer--justify-between {
|
|
53
|
+
justify-content: space-between;
|
|
54
|
+
}
|
|
55
|
+
.gridui-u-data-explorer--gap-gridui-4 {
|
|
56
|
+
gap: var(--gridui-space-4);
|
|
57
|
+
}
|
|
58
|
+
.gridui-u-data-explorer--gap-gridui-8 {
|
|
59
|
+
gap: var(--gridui-space-8);
|
|
60
|
+
}
|
|
61
|
+
.gridui-u-data-explorer--gap-gridui-16 {
|
|
62
|
+
gap: var(--gridui-space-16);
|
|
63
|
+
}
|
|
64
|
+
.gridui-u-data-explorer--border {
|
|
65
|
+
border-style: var(--tw-border-style);
|
|
66
|
+
border-width: 1px;
|
|
67
|
+
}
|
|
68
|
+
.gridui-u-data-explorer--border-s {
|
|
69
|
+
border-inline-start-style: var(--tw-border-style);
|
|
70
|
+
border-inline-start-width: 1px;
|
|
71
|
+
}
|
|
72
|
+
.gridui-u-data-explorer--border-solid {
|
|
73
|
+
--tw-border-style: solid;
|
|
74
|
+
border-style: solid;
|
|
75
|
+
}
|
|
76
|
+
.gridui-u-data-explorer--border-border {
|
|
77
|
+
border-color: var(--gridui-border);
|
|
78
|
+
}
|
|
79
|
+
.gridui-u-data-explorer--bg-background {
|
|
80
|
+
background-color: var(--gridui-background);
|
|
81
|
+
}
|
|
82
|
+
.gridui-u-data-explorer--p-gridui-16 {
|
|
83
|
+
padding: var(--gridui-space-16);
|
|
84
|
+
}
|
|
85
|
+
.gridui-u-data-explorer--pt-gridui-16 {
|
|
86
|
+
padding-top: var(--gridui-space-16);
|
|
87
|
+
}
|
|
88
|
+
.gridui-u-data-explorer--type-caption {
|
|
89
|
+
font: var(--gridui-type-caption);
|
|
90
|
+
font-family: var(--gridui-font-body);
|
|
91
|
+
letter-spacing: normal;
|
|
92
|
+
}
|
|
93
|
+
.gridui-u-data-explorer--text-foreground {
|
|
94
|
+
color: var(--gridui-foreground);
|
|
95
|
+
}
|
|
96
|
+
.gridui-u-data-explorer--text-muted {
|
|
97
|
+
color: var(--gridui-muted);
|
|
98
|
+
}
|
|
99
|
+
.gridui-u-data-explorer--\[\&_label\]\:min-h-11 label {
|
|
100
|
+
min-height: calc(var(--spacing) * 11);
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
@property --tw-border-style {
|
|
104
|
+
syntax: "*";
|
|
105
|
+
inherits: false;
|
|
106
|
+
initial-value: solid;
|
|
107
|
+
}
|
|
108
|
+
@layer properties {
|
|
109
|
+
@supports ((-webkit-hyphens: none) and (not (margin-trim: block))) or ((-moz-orient: inline) and (not (color:rgb(from red r g b)))) {
|
|
110
|
+
*, ::before, ::after, ::backdrop {
|
|
111
|
+
--tw-border-style: solid;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
package/docs/catalog.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/data-explorer",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.5.0",
|
|
5
5
|
"category": "data",
|
|
6
6
|
"description": "GridUI React data explorer",
|
|
7
7
|
"usage": "DataExplorer belongs to Data because it coordinates generic dataset exploration through Core controls, Layout regions, and DataTable. Composer and ApprovalPanel remain Dashboard task compositions. See task workspace compositions for controlled state, callbacks, and application responsibilities.",
|
|
@@ -9,9 +9,16 @@
|
|
|
9
9
|
"README.md",
|
|
10
10
|
"docs/reference/README.md",
|
|
11
11
|
"docs/reference/data-explorer-bulk-actions.md",
|
|
12
|
+
"docs/reference/data-explorer-column-visibility.md",
|
|
13
|
+
"docs/reference/data-explorer-filter-control.md",
|
|
14
|
+
"docs/reference/data-explorer-filters.md",
|
|
12
15
|
"docs/reference/data-explorer-pagination.md",
|
|
16
|
+
"docs/reference/data-explorer-provider.md",
|
|
17
|
+
"docs/reference/data-explorer-search.md",
|
|
18
|
+
"docs/reference/data-explorer-sort.md",
|
|
13
19
|
"docs/reference/data-explorer-table.md",
|
|
14
20
|
"docs/reference/data-explorer-toolbar.md",
|
|
21
|
+
"docs/reference/data-explorer-view.md",
|
|
15
22
|
"docs/reference/data-explorer.md"
|
|
16
23
|
],
|
|
17
24
|
"exports": [
|
|
@@ -45,11 +52,26 @@
|
|
|
45
52
|
"kind": "type",
|
|
46
53
|
"importPath": "@gridui/data-explorer"
|
|
47
54
|
},
|
|
55
|
+
{
|
|
56
|
+
"name": "DataExplorerColumnVisibility",
|
|
57
|
+
"kind": "component",
|
|
58
|
+
"importPath": "@gridui/data-explorer"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "DataExplorerColumnVisibilityProps",
|
|
62
|
+
"kind": "type",
|
|
63
|
+
"importPath": "@gridui/data-explorer"
|
|
64
|
+
},
|
|
48
65
|
{
|
|
49
66
|
"name": "DataExplorerCondition",
|
|
50
67
|
"kind": "type",
|
|
51
68
|
"importPath": "@gridui/data-explorer"
|
|
52
69
|
},
|
|
70
|
+
{
|
|
71
|
+
"name": "DataExplorerController",
|
|
72
|
+
"kind": "type",
|
|
73
|
+
"importPath": "@gridui/data-explorer"
|
|
74
|
+
},
|
|
53
75
|
{
|
|
54
76
|
"name": "DataExplorerDetails",
|
|
55
77
|
"kind": "type",
|
|
@@ -60,6 +82,16 @@
|
|
|
60
82
|
"kind": "type",
|
|
61
83
|
"importPath": "@gridui/data-explorer"
|
|
62
84
|
},
|
|
85
|
+
{
|
|
86
|
+
"name": "DataExplorerFilterControl",
|
|
87
|
+
"kind": "component",
|
|
88
|
+
"importPath": "@gridui/data-explorer"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"name": "DataExplorerFilterControlProps",
|
|
92
|
+
"kind": "type",
|
|
93
|
+
"importPath": "@gridui/data-explorer"
|
|
94
|
+
},
|
|
63
95
|
{
|
|
64
96
|
"name": "DataExplorerFilterDefinition",
|
|
65
97
|
"kind": "type",
|
|
@@ -75,6 +107,26 @@
|
|
|
75
107
|
"kind": "type",
|
|
76
108
|
"importPath": "@gridui/data-explorer"
|
|
77
109
|
},
|
|
110
|
+
{
|
|
111
|
+
"name": "DataExplorerFilters",
|
|
112
|
+
"kind": "component",
|
|
113
|
+
"importPath": "@gridui/data-explorer"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "DataExplorerFiltersProps",
|
|
117
|
+
"kind": "type",
|
|
118
|
+
"importPath": "@gridui/data-explorer"
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "DataExplorerLabels",
|
|
122
|
+
"kind": "type",
|
|
123
|
+
"importPath": "@gridui/data-explorer"
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
"name": "DataExplorerOptions",
|
|
127
|
+
"kind": "type",
|
|
128
|
+
"importPath": "@gridui/data-explorer"
|
|
129
|
+
},
|
|
78
130
|
{
|
|
79
131
|
"name": "DataExplorerPagination",
|
|
80
132
|
"kind": "component",
|
|
@@ -90,11 +142,41 @@
|
|
|
90
142
|
"kind": "type",
|
|
91
143
|
"importPath": "@gridui/data-explorer"
|
|
92
144
|
},
|
|
145
|
+
{
|
|
146
|
+
"name": "DataExplorerProvider",
|
|
147
|
+
"kind": "component",
|
|
148
|
+
"importPath": "@gridui/data-explorer"
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"name": "DataExplorerProviderProps",
|
|
152
|
+
"kind": "type",
|
|
153
|
+
"importPath": "@gridui/data-explorer"
|
|
154
|
+
},
|
|
93
155
|
{
|
|
94
156
|
"name": "DataExplorerRow",
|
|
95
157
|
"kind": "type",
|
|
96
158
|
"importPath": "@gridui/data-explorer"
|
|
97
159
|
},
|
|
160
|
+
{
|
|
161
|
+
"name": "DataExplorerSearch",
|
|
162
|
+
"kind": "component",
|
|
163
|
+
"importPath": "@gridui/data-explorer"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "DataExplorerSearchProps",
|
|
167
|
+
"kind": "type",
|
|
168
|
+
"importPath": "@gridui/data-explorer"
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"name": "DataExplorerSort",
|
|
172
|
+
"kind": "component",
|
|
173
|
+
"importPath": "@gridui/data-explorer"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "DataExplorerSortProps",
|
|
177
|
+
"kind": "type",
|
|
178
|
+
"importPath": "@gridui/data-explorer"
|
|
179
|
+
},
|
|
98
180
|
{
|
|
99
181
|
"name": "DataExplorerState",
|
|
100
182
|
"kind": "type",
|
|
@@ -124,6 +206,21 @@
|
|
|
124
206
|
"name": "DataExplorerValue",
|
|
125
207
|
"kind": "type",
|
|
126
208
|
"importPath": "@gridui/data-explorer"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"name": "DataExplorerView",
|
|
212
|
+
"kind": "component",
|
|
213
|
+
"importPath": "@gridui/data-explorer"
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "DataExplorerViewProps",
|
|
217
|
+
"kind": "type",
|
|
218
|
+
"importPath": "@gridui/data-explorer"
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "useDataExplorer",
|
|
222
|
+
"kind": "function",
|
|
223
|
+
"importPath": "@gridui/data-explorer"
|
|
127
224
|
}
|
|
128
225
|
],
|
|
129
226
|
"styles": [
|
|
@@ -138,6 +235,7 @@
|
|
|
138
235
|
"@gridui/table/styles.css",
|
|
139
236
|
"@gridui/data-explorer/styles.css"
|
|
140
237
|
],
|
|
238
|
+
"styledImport": "@gridui/data-explorer/styled",
|
|
141
239
|
"examples": [
|
|
142
240
|
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/bulk-actions.mdx",
|
|
143
241
|
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/columns-details.mdx",
|
package/docs/reference/README.md
CHANGED
|
@@ -3,6 +3,13 @@
|
|
|
3
3
|
|
|
4
4
|
- [DataExplorer](data-explorer.md)
|
|
5
5
|
- [DataExplorerBulkActions](data-explorer-bulk-actions.md)
|
|
6
|
+
- [DataExplorerColumnVisibility](data-explorer-column-visibility.md)
|
|
7
|
+
- [DataExplorerFilterControl](data-explorer-filter-control.md)
|
|
8
|
+
- [DataExplorerFilters](data-explorer-filters.md)
|
|
6
9
|
- [DataExplorerPagination](data-explorer-pagination.md)
|
|
10
|
+
- [DataExplorerProvider](data-explorer-provider.md)
|
|
11
|
+
- [DataExplorerSearch](data-explorer-search.md)
|
|
12
|
+
- [DataExplorerSort](data-explorer-sort.md)
|
|
7
13
|
- [DataExplorerTable](data-explorer-table.md)
|
|
8
14
|
- [DataExplorerToolbar](data-explorer-toolbar.md)
|
|
15
|
+
- [DataExplorerView](data-explorer-view.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerColumnVisibility
|
|
3
|
+
|
|
4
|
+
Public DataExplorerColumnVisibility 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 { DataExplorerColumnVisibility } 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-data/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
|
+
|
|
24
|
+
### label
|
|
25
|
+
|
|
26
|
+
``string | undefined`` · Optional
|
|
27
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerFilterControl
|
|
3
|
+
|
|
4
|
+
Public DataExplorerFilterControl 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 { DataExplorerFilterControl } 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-data/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
|
+
|
|
24
|
+
### allLabel
|
|
25
|
+
|
|
26
|
+
``string`` · Required
|
|
27
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerFilters
|
|
3
|
+
|
|
4
|
+
Public DataExplorerFilters 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 { DataExplorerFilters } 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-data/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
|
+
### labels
|
|
21
|
+
|
|
22
|
+
``{ readonly add: string; readonly remove: (index: number) => string; readonly field: string; readonly operator: string; readonly value: string; readonly operators: Readonly<Record<DataExplorerFilterOperator, string>>; } | undefined`` · Optional
|
|
23
|
+
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerProvider
|
|
3
|
+
|
|
4
|
+
Public DataExplorerProvider 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 { DataExplorerProvider } 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-data/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
|
+
### rows
|
|
21
|
+
|
|
22
|
+
``readonly DataExplorerRow[]`` · Required
|
|
23
|
+
|
|
24
|
+
### columns
|
|
25
|
+
|
|
26
|
+
``readonly DataExplorerColumn[]`` · Required
|
|
27
|
+
|
|
28
|
+
### state
|
|
29
|
+
|
|
30
|
+
``DataExplorerState`` · Required
|
|
31
|
+
|
|
32
|
+
### onStateChange
|
|
33
|
+
|
|
34
|
+
``(state: DataExplorerState): void`` · Required
|
|
35
|
+
|
|
36
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
37
|
+
|
|
38
|
+
### filter
|
|
39
|
+
|
|
40
|
+
``DataExplorerFilter | undefined`` · Optional
|
|
41
|
+
|
|
42
|
+
### columnSettings
|
|
43
|
+
|
|
44
|
+
``DataExplorerColumnSettings | undefined`` · Optional
|
|
45
|
+
|
|
46
|
+
### columnSizing
|
|
47
|
+
|
|
48
|
+
``DataExplorerColumnSizing | undefined`` · Optional
|
|
49
|
+
|
|
50
|
+
### details
|
|
51
|
+
|
|
52
|
+
``DataExplorerDetails | undefined`` · Optional
|
|
53
|
+
|
|
54
|
+
### filtering
|
|
55
|
+
|
|
56
|
+
``DataExplorerFiltering | undefined`` · Optional
|
|
57
|
+
|
|
58
|
+
### pageSize
|
|
59
|
+
|
|
60
|
+
``number | undefined`` · Optional
|
|
61
|
+
|
|
62
|
+
### selectedIds
|
|
63
|
+
|
|
64
|
+
``readonly string[] | undefined`` · Optional
|
|
65
|
+
|
|
66
|
+
### onSelectionChange
|
|
67
|
+
|
|
68
|
+
``(ids: readonly string[]): void`` · Optional
|
|
69
|
+
|
|
70
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
71
|
+
|
|
72
|
+
### actions
|
|
73
|
+
|
|
74
|
+
``readonly { readonly label: string; readonly onAction: (ids: readonly string[]) => void; readonly disabled?: boolean; }[] | undefined`` · Optional
|
|
75
|
+
|
|
76
|
+
### renderCell
|
|
77
|
+
|
|
78
|
+
``((value: DataExplorerValue | undefined, row: DataExplorerRow, column: DataExplorerColumn) => ReactNode) | undefined`` · Optional
|
|
79
|
+
|
|
80
|
+
### busy
|
|
81
|
+
|
|
82
|
+
``boolean | undefined`` · Optional
|
|
83
|
+
|
|
84
|
+
### notice
|
|
85
|
+
|
|
86
|
+
``ReactNode`` · Optional
|
|
87
|
+
|
|
88
|
+
### labels
|
|
89
|
+
|
|
90
|
+
``Partial<DataExplorerLabels> | undefined`` · Optional
|
|
91
|
+
|
|
92
|
+
### children
|
|
93
|
+
|
|
94
|
+
``ReactNode`` · Optional
|
|
95
|
+
|
|
96
|
+
Content rendered inside the component.
|
|
97
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerSearch
|
|
3
|
+
|
|
4
|
+
Public DataExplorerSearch 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 { DataExplorerSearch } 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-data/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
|
+
|
|
24
|
+
### label
|
|
25
|
+
|
|
26
|
+
``string`` · Required
|
|
27
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerSort
|
|
3
|
+
|
|
4
|
+
Public DataExplorerSort 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 { DataExplorerSort } 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-data/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
|
+
|
|
24
|
+
### labels
|
|
25
|
+
|
|
26
|
+
``Pick<DataExplorerLabels, "sort" | "unsorted" | "ascending" | "descending">`` · Required
|
|
27
|
+
|
|
@@ -45,3 +45,7 @@ The public Props type is the source of these signatures. Defaults below are expl
|
|
|
45
45
|
|
|
46
46
|
``boolean | undefined`` · Optional
|
|
47
47
|
|
|
48
|
+
### labels
|
|
49
|
+
|
|
50
|
+
``(Pick<DataExplorerLabels, "table" | "empty"> & Partial<Pick<DataExplorerLabels, "selection" | "selectRow">>) | undefined`` · Optional
|
|
51
|
+
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# DataExplorerView
|
|
3
|
+
|
|
4
|
+
Public DataExplorerView 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 { DataExplorerView } 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-data/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
|
+
### children
|
|
21
|
+
|
|
22
|
+
``ReactNode`` · Optional
|
|
23
|
+
|
|
24
|
+
Content rendered inside the component.
|
|
25
|
+
|
|
26
|
+
### onFocus
|
|
27
|
+
|
|
28
|
+
``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
|
|
29
|
+
|
|
30
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
31
|
+
|
|
32
|
+
### onBlur
|
|
33
|
+
|
|
34
|
+
``(event: FocusEvent<HTMLElement, Element>): void`` · Optional
|
|
35
|
+
|
|
36
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
37
|
+
|
|
38
|
+
### onChange
|
|
39
|
+
|
|
40
|
+
``(event: ChangeEvent<HTMLElement, Element>): void`` · Optional
|
|
41
|
+
|
|
42
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
43
|
+
|
|
44
|
+
### onSubmit
|
|
45
|
+
|
|
46
|
+
``(event: SubmitEvent<HTMLElement>): void`` · Optional
|
|
47
|
+
|
|
48
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
49
|
+
|
|
50
|
+
### onClick
|
|
51
|
+
|
|
52
|
+
``(event: MouseEvent<HTMLElement, MouseEvent>): void`` · Optional
|
|
53
|
+
|
|
54
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
55
|
+
|
|
56
|
+
### label
|
|
57
|
+
|
|
58
|
+
``string`` · Required
|
|
59
|
+
|
|
@@ -125,5 +125,5 @@ Called when the corresponding interaction occurs; inspect the arguments in Actio
|
|
|
125
125
|
|
|
126
126
|
### labels
|
|
127
127
|
|
|
128
|
-
``
|
|
128
|
+
``Partial<DataExplorerLabels> & DataExplorerLabels`` · Required
|
|
129
129
|
|