@gridui/data-explorer 1.2.3 → 1.4.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 +75 -5
- package/dist/data-explorer/data-explorer.d.ts +1 -6
- 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 +5 -0
- package/dist/data-explorer-filter-control/data-explorer-filter-control.d.ts +5 -0
- package/dist/data-explorer-filters/data-explorer-filters.d.ts +5 -0
- package/dist/data-explorer-pagination/data-explorer-pagination.d.ts +4 -2
- package/dist/data-explorer-provider/data-explorer-provider.d.ts +7 -0
- package/dist/data-explorer-search/data-explorer-search.d.ts +5 -0
- package/dist/data-explorer-sort/data-explorer-sort.d.ts +5 -0
- package/dist/data-explorer-table/column-layout.d.ts +28 -0
- package/dist/data-explorer-table/data-explorer-table.d.ts +5 -2
- package/dist/data-explorer-toolbar/data-explorer-toolbar.d.ts +5 -9
- package/dist/data-explorer-view/data-explorer-view.d.ts +6 -0
- package/dist/index.d.ts +17 -0
- package/dist/index.js +388 -388
- package/dist/index.js.map +4 -4
- package/dist/shared/controller.d.ts +26 -0
- package/dist/shared/explorer-context.d.ts +129 -77
- package/dist/shared/explorer-options.d.ts +22 -18
- package/dist/shared/labels.d.ts +2 -0
- package/dist/styles.css +1 -0
- package/docs/catalog.json +106 -8
- package/docs/reference/README.md +7 -0
- package/docs/reference/data-explorer-bulk-actions.md +5 -1
- 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 +5 -1
- 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 +29 -1
- package/docs/reference/data-explorer-toolbar.md +7 -1
- package/docs/reference/data-explorer-view.md +59 -0
- package/docs/reference/data-explorer.md +3 -3
- package/package.json +13 -13
- /package/dist/{data-explorer-toolbar → data-explorer-filters}/filter-editor.d.ts +0 -0
- /package/dist/{data-explorer → data-explorer-view}/style.d.ts +0 -0
- /package/dist/{data-explorer-toolbar/style.d.ts → shared/label-style.d.ts} +0 -0
|
@@ -1,14 +1,32 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
* @package Data Explorer
|
|
4
|
-
* @namespace Shared
|
|
5
|
-
* @description Explorer Context
|
|
6
|
-
*/
|
|
7
|
-
import type { ExplorerOptions } from "./explorer-options";
|
|
8
|
-
import { type DataExplorerState } from "./model";
|
|
9
|
-
export declare const useExplorerController: (options: ExplorerOptions) => {
|
|
10
|
-
busy: boolean;
|
|
1
|
+
import type { DataExplorerOptions } from "./explorer-options";
|
|
2
|
+
export declare const useExplorerController: (options: DataExplorerOptions) => {
|
|
11
3
|
tableId: string;
|
|
4
|
+
controller: {
|
|
5
|
+
busy: boolean;
|
|
6
|
+
state: import("./model").DataExplorerState;
|
|
7
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
8
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
9
|
+
view: {
|
|
10
|
+
rows: import("./model").DataExplorerRow[];
|
|
11
|
+
total: number;
|
|
12
|
+
page: number;
|
|
13
|
+
pageCount: number;
|
|
14
|
+
};
|
|
15
|
+
selectedRowIds: string[];
|
|
16
|
+
selectedRowIdSet: Set<string>;
|
|
17
|
+
pageIds: string[];
|
|
18
|
+
selectedPageCount: number;
|
|
19
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
20
|
+
setQuery: (query: string) => undefined;
|
|
21
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
22
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
23
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
24
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
25
|
+
};
|
|
26
|
+
busy: boolean;
|
|
27
|
+
state: import("./model").DataExplorerState;
|
|
28
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
29
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
12
30
|
view: {
|
|
13
31
|
rows: import("./model").DataExplorerRow[];
|
|
14
32
|
total: number;
|
|
@@ -16,14 +34,17 @@ export declare const useExplorerController: (options: ExplorerOptions) => {
|
|
|
16
34
|
pageCount: number;
|
|
17
35
|
};
|
|
18
36
|
selectedRowIds: string[];
|
|
37
|
+
selectedRowIdSet: Set<string>;
|
|
19
38
|
pageIds: string[];
|
|
20
39
|
selectedPageCount: number;
|
|
21
|
-
updateState: (changes: Partial<DataExplorerState>) => void;
|
|
22
|
-
|
|
40
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
41
|
+
setQuery: (query: string) => undefined;
|
|
42
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
43
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
44
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
45
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
23
46
|
rows: readonly import("./model").DataExplorerRow[];
|
|
24
|
-
|
|
25
|
-
state: DataExplorerState;
|
|
26
|
-
onStateChange: (state: DataExplorerState) => void;
|
|
47
|
+
onStateChange: (state: import("./model").DataExplorerState) => void;
|
|
27
48
|
filter?: import("./model").DataExplorerFilter | undefined;
|
|
28
49
|
columnSettings?: import("./features").DataExplorerColumnSettings | undefined;
|
|
29
50
|
columnSizing?: import("./features").DataExplorerColumnSizing | undefined;
|
|
@@ -39,27 +60,36 @@ export declare const useExplorerController: (options: ExplorerOptions) => {
|
|
|
39
60
|
}[] | undefined;
|
|
40
61
|
renderCell?: ((value: import("./model").DataExplorerValue | undefined, row: import("./model").DataExplorerRow, column: import("./model").DataExplorerColumn) => import("react").ReactNode) | undefined;
|
|
41
62
|
notice?: import("react").ReactNode;
|
|
42
|
-
labels
|
|
43
|
-
readonly table: string;
|
|
44
|
-
readonly search: string;
|
|
45
|
-
readonly sort: string;
|
|
46
|
-
readonly unsorted: string;
|
|
47
|
-
readonly ascending: string;
|
|
48
|
-
readonly descending: string;
|
|
49
|
-
readonly all: string;
|
|
50
|
-
readonly selection: string;
|
|
51
|
-
readonly selectPage: string;
|
|
52
|
-
readonly selectRow: (row: import("./model").DataExplorerRow) => string;
|
|
53
|
-
readonly selected: (count: number) => string;
|
|
54
|
-
readonly previous: string;
|
|
55
|
-
readonly next: string;
|
|
56
|
-
readonly page: (page: number, pages: number, total: number) => string;
|
|
57
|
-
readonly empty: string;
|
|
58
|
-
};
|
|
63
|
+
labels?: Partial<import("./explorer-options").DataExplorerLabels> | undefined;
|
|
59
64
|
};
|
|
60
65
|
export declare const explorerContext: import("react").Context<{
|
|
61
|
-
busy: boolean;
|
|
62
66
|
tableId: string;
|
|
67
|
+
controller: {
|
|
68
|
+
busy: boolean;
|
|
69
|
+
state: import("./model").DataExplorerState;
|
|
70
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
71
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
72
|
+
view: {
|
|
73
|
+
rows: import("./model").DataExplorerRow[];
|
|
74
|
+
total: number;
|
|
75
|
+
page: number;
|
|
76
|
+
pageCount: number;
|
|
77
|
+
};
|
|
78
|
+
selectedRowIds: string[];
|
|
79
|
+
selectedRowIdSet: Set<string>;
|
|
80
|
+
pageIds: string[];
|
|
81
|
+
selectedPageCount: number;
|
|
82
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
83
|
+
setQuery: (query: string) => undefined;
|
|
84
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
85
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
86
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
87
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
88
|
+
};
|
|
89
|
+
busy: boolean;
|
|
90
|
+
state: import("./model").DataExplorerState;
|
|
91
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
92
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
63
93
|
view: {
|
|
64
94
|
rows: import("./model").DataExplorerRow[];
|
|
65
95
|
total: number;
|
|
@@ -67,14 +97,17 @@ export declare const explorerContext: import("react").Context<{
|
|
|
67
97
|
pageCount: number;
|
|
68
98
|
};
|
|
69
99
|
selectedRowIds: string[];
|
|
100
|
+
selectedRowIdSet: Set<string>;
|
|
70
101
|
pageIds: string[];
|
|
71
102
|
selectedPageCount: number;
|
|
72
|
-
updateState: (changes: Partial<DataExplorerState>) => void;
|
|
73
|
-
|
|
103
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
104
|
+
setQuery: (query: string) => undefined;
|
|
105
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
106
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
107
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
108
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
74
109
|
rows: readonly import("./model").DataExplorerRow[];
|
|
75
|
-
|
|
76
|
-
state: DataExplorerState;
|
|
77
|
-
onStateChange: (state: DataExplorerState) => void;
|
|
110
|
+
onStateChange: (state: import("./model").DataExplorerState) => void;
|
|
78
111
|
filter?: import("./model").DataExplorerFilter | undefined;
|
|
79
112
|
columnSettings?: import("./features").DataExplorerColumnSettings | undefined;
|
|
80
113
|
columnSizing?: import("./features").DataExplorerColumnSizing | undefined;
|
|
@@ -90,27 +123,36 @@ export declare const explorerContext: import("react").Context<{
|
|
|
90
123
|
}[] | undefined;
|
|
91
124
|
renderCell?: ((value: import("./model").DataExplorerValue | undefined, row: import("./model").DataExplorerRow, column: import("./model").DataExplorerColumn) => import("react").ReactNode) | undefined;
|
|
92
125
|
notice?: import("react").ReactNode;
|
|
93
|
-
labels
|
|
94
|
-
readonly table: string;
|
|
95
|
-
readonly search: string;
|
|
96
|
-
readonly sort: string;
|
|
97
|
-
readonly unsorted: string;
|
|
98
|
-
readonly ascending: string;
|
|
99
|
-
readonly descending: string;
|
|
100
|
-
readonly all: string;
|
|
101
|
-
readonly selection: string;
|
|
102
|
-
readonly selectPage: string;
|
|
103
|
-
readonly selectRow: (row: import("./model").DataExplorerRow) => string;
|
|
104
|
-
readonly selected: (count: number) => string;
|
|
105
|
-
readonly previous: string;
|
|
106
|
-
readonly next: string;
|
|
107
|
-
readonly page: (page: number, pages: number, total: number) => string;
|
|
108
|
-
readonly empty: string;
|
|
109
|
-
};
|
|
126
|
+
labels?: Partial<import("./explorer-options").DataExplorerLabels> | undefined;
|
|
110
127
|
} | null>;
|
|
111
128
|
export declare const useExplorer: () => {
|
|
112
|
-
busy: boolean;
|
|
113
129
|
tableId: string;
|
|
130
|
+
controller: {
|
|
131
|
+
busy: boolean;
|
|
132
|
+
state: import("./model").DataExplorerState;
|
|
133
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
134
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
135
|
+
view: {
|
|
136
|
+
rows: import("./model").DataExplorerRow[];
|
|
137
|
+
total: number;
|
|
138
|
+
page: number;
|
|
139
|
+
pageCount: number;
|
|
140
|
+
};
|
|
141
|
+
selectedRowIds: string[];
|
|
142
|
+
selectedRowIdSet: Set<string>;
|
|
143
|
+
pageIds: string[];
|
|
144
|
+
selectedPageCount: number;
|
|
145
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
146
|
+
setQuery: (query: string) => undefined;
|
|
147
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
148
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
149
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
150
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
151
|
+
};
|
|
152
|
+
busy: boolean;
|
|
153
|
+
state: import("./model").DataExplorerState;
|
|
154
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
155
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
114
156
|
view: {
|
|
115
157
|
rows: import("./model").DataExplorerRow[];
|
|
116
158
|
total: number;
|
|
@@ -118,14 +160,17 @@ export declare const useExplorer: () => {
|
|
|
118
160
|
pageCount: number;
|
|
119
161
|
};
|
|
120
162
|
selectedRowIds: string[];
|
|
163
|
+
selectedRowIdSet: Set<string>;
|
|
121
164
|
pageIds: string[];
|
|
122
165
|
selectedPageCount: number;
|
|
123
|
-
updateState: (changes: Partial<DataExplorerState>) => void;
|
|
124
|
-
|
|
166
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
167
|
+
setQuery: (query: string) => undefined;
|
|
168
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
169
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
170
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
171
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
125
172
|
rows: readonly import("./model").DataExplorerRow[];
|
|
126
|
-
|
|
127
|
-
state: DataExplorerState;
|
|
128
|
-
onStateChange: (state: DataExplorerState) => void;
|
|
173
|
+
onStateChange: (state: import("./model").DataExplorerState) => void;
|
|
129
174
|
filter?: import("./model").DataExplorerFilter | undefined;
|
|
130
175
|
columnSettings?: import("./features").DataExplorerColumnSettings | undefined;
|
|
131
176
|
columnSizing?: import("./features").DataExplorerColumnSizing | undefined;
|
|
@@ -141,21 +186,28 @@ export declare const useExplorer: () => {
|
|
|
141
186
|
}[] | undefined;
|
|
142
187
|
renderCell?: ((value: import("./model").DataExplorerValue | undefined, row: import("./model").DataExplorerRow, column: import("./model").DataExplorerColumn) => import("react").ReactNode) | undefined;
|
|
143
188
|
notice?: import("react").ReactNode;
|
|
144
|
-
labels
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
readonly next: string;
|
|
158
|
-
readonly page: (page: number, pages: number, total: number) => string;
|
|
159
|
-
readonly empty: string;
|
|
189
|
+
labels?: Partial<import("./explorer-options").DataExplorerLabels> | undefined;
|
|
190
|
+
};
|
|
191
|
+
/** Share accepted state, derived rows and guarded commands with custom controls. */
|
|
192
|
+
export declare const useDataExplorer: () => {
|
|
193
|
+
busy: boolean;
|
|
194
|
+
state: import("./model").DataExplorerState;
|
|
195
|
+
columns: readonly import("./model").DataExplorerColumn[];
|
|
196
|
+
visibleColumns: import("./model").DataExplorerColumn[];
|
|
197
|
+
view: {
|
|
198
|
+
rows: import("./model").DataExplorerRow[];
|
|
199
|
+
total: number;
|
|
200
|
+
page: number;
|
|
201
|
+
pageCount: number;
|
|
160
202
|
};
|
|
203
|
+
selectedRowIds: string[];
|
|
204
|
+
selectedRowIdSet: Set<string>;
|
|
205
|
+
pageIds: string[];
|
|
206
|
+
selectedPageCount: number;
|
|
207
|
+
updateState: (changes: Partial<import("./model").DataExplorerState>) => void;
|
|
208
|
+
setQuery: (query: string) => undefined;
|
|
209
|
+
setFilterValue: (filterValue: string) => undefined;
|
|
210
|
+
setSort: (sort: import("./model").DataExplorerState["sort"]) => undefined;
|
|
211
|
+
setFilters: (filters: NonNullable<import("./model").DataExplorerState["filters"]>) => undefined;
|
|
212
|
+
updateSelection: (ids: readonly string[]) => void;
|
|
161
213
|
};
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
import type { DataExplorerColumnSettings, DataExplorerColumnSizing, DataExplorerDetails, DataExplorerFiltering } from "./features";
|
|
8
8
|
import type { DataExplorerColumn, DataExplorerFilter, DataExplorerRow, DataExplorerState, DataExplorerValue } from "./model";
|
|
9
9
|
import type { ReactNode } from "react";
|
|
10
|
-
export type
|
|
10
|
+
export type DataExplorerOptions = {
|
|
11
11
|
readonly rows: readonly DataExplorerRow[];
|
|
12
12
|
readonly columns: readonly DataExplorerColumn[];
|
|
13
13
|
readonly state: DataExplorerState;
|
|
@@ -28,23 +28,27 @@ export type ExplorerOptions = {
|
|
|
28
28
|
readonly renderCell?: ((value: DataExplorerValue | undefined, row: DataExplorerRow, column: DataExplorerColumn) => ReactNode) | undefined;
|
|
29
29
|
readonly busy?: boolean | undefined;
|
|
30
30
|
readonly notice?: ReactNode;
|
|
31
|
-
readonly labels
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
31
|
+
readonly labels?: Partial<DataExplorerLabels> | undefined;
|
|
32
|
+
};
|
|
33
|
+
export type DataExplorerLabels = {
|
|
34
|
+
readonly table: string;
|
|
35
|
+
readonly search: string;
|
|
36
|
+
readonly sort: string;
|
|
37
|
+
readonly unsorted: string;
|
|
38
|
+
readonly ascending: string;
|
|
39
|
+
readonly descending: string;
|
|
40
|
+
readonly all: string;
|
|
41
|
+
readonly selection: string;
|
|
42
|
+
readonly selectPage: string;
|
|
43
|
+
readonly selectRow: (row: DataExplorerRow) => string;
|
|
44
|
+
readonly selected: (count: number) => string;
|
|
45
|
+
readonly previous: string;
|
|
46
|
+
readonly next: string;
|
|
47
|
+
readonly page: (page: number, pages: number, total: number) => string;
|
|
48
|
+
readonly empty: string;
|
|
49
|
+
};
|
|
50
|
+
export type ExplorerOptions = DataExplorerOptions & {
|
|
51
|
+
readonly labels: DataExplorerLabels;
|
|
48
52
|
};
|
|
49
53
|
export type ExplorerPartOptions = {
|
|
50
54
|
readonly className?: string;
|
package/dist/styles.css
CHANGED
package/docs/catalog.json
CHANGED
|
@@ -1,17 +1,24 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/data-explorer",
|
|
4
|
-
"version": "1.
|
|
5
|
-
"category": "
|
|
4
|
+
"version": "1.4.0",
|
|
5
|
+
"category": "data",
|
|
6
6
|
"description": "GridUI React data explorer",
|
|
7
|
-
"usage": "DataExplorer,
|
|
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.",
|
|
8
8
|
"documentation": [
|
|
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": [
|
|
@@ -139,10 +236,11 @@
|
|
|
139
236
|
"@gridui/data-explorer/styles.css"
|
|
140
237
|
],
|
|
141
238
|
"examples": [
|
|
142
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
143
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
144
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
145
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
146
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
239
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/bulk-actions.mdx",
|
|
240
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/columns-details.mdx",
|
|
241
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/conditions.mdx",
|
|
242
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/getting-started.mdx",
|
|
243
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/local-data.mdx",
|
|
244
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/data-explorer/stories/data-explorer.stories.tsx"
|
|
147
245
|
]
|
|
148
246
|
}
|
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)
|
|
@@ -11,7 +11,7 @@ import "@gridui/theme/styles.css";
|
|
|
11
11
|
import "@gridui/data-explorer/styles.css";
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
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
15
|
|
|
16
16
|
## API
|
|
17
17
|
|
|
@@ -21,3 +21,7 @@ The public Props type is the source of these signatures. Defaults below are expl
|
|
|
21
21
|
|
|
22
22
|
``string | undefined`` · Optional
|
|
23
23
|
|
|
24
|
+
### labels
|
|
25
|
+
|
|
26
|
+
``Pick<DataExplorerLabels, "selected" | "selectPage"> | undefined`` · Optional
|
|
27
|
+
|
|
@@ -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
|
+
|
|
@@ -11,7 +11,7 @@ import "@gridui/theme/styles.css";
|
|
|
11
11
|
import "@gridui/data-explorer/styles.css";
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
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
15
|
|
|
16
16
|
## API
|
|
17
17
|
|
|
@@ -21,3 +21,7 @@ The public Props type is the source of these signatures. Defaults below are expl
|
|
|
21
21
|
|
|
22
22
|
``string | undefined`` · Optional
|
|
23
23
|
|
|
24
|
+
### labels
|
|
25
|
+
|
|
26
|
+
``Pick<DataExplorerLabels, "page" | "next" | "previous"> | undefined`` · Optional
|
|
27
|
+
|