@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
|
@@ -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
|
+
|
|
@@ -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,31 @@ The public Props type is the source of these signatures. Defaults below are expl
|
|
|
21
21
|
|
|
22
22
|
``string | undefined`` · Optional
|
|
23
23
|
|
|
24
|
+
### rowLines
|
|
25
|
+
|
|
26
|
+
``boolean | undefined`` · Optional
|
|
27
|
+
|
|
28
|
+
### columnLines
|
|
29
|
+
|
|
30
|
+
``boolean | undefined`` · Optional
|
|
31
|
+
|
|
32
|
+
### density
|
|
33
|
+
|
|
34
|
+
``"compact" | "comfortable" | undefined`` · Optional
|
|
35
|
+
|
|
36
|
+
### headerSurface
|
|
37
|
+
|
|
38
|
+
``"plain" | "muted" | undefined`` · Optional
|
|
39
|
+
|
|
40
|
+
### rowHeaderSurface
|
|
41
|
+
|
|
42
|
+
``"plain" | "muted" | undefined`` · Optional
|
|
43
|
+
|
|
44
|
+
### striped
|
|
45
|
+
|
|
46
|
+
``boolean | undefined`` · Optional
|
|
47
|
+
|
|
48
|
+
### labels
|
|
49
|
+
|
|
50
|
+
``(Pick<DataExplorerLabels, "table" | "empty"> & Partial<Pick<DataExplorerLabels, "selection" | "selectRow">>) | undefined`` · Optional
|
|
51
|
+
|
|
@@ -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,9 @@ The public Props type is the source of these signatures. Defaults below are expl
|
|
|
21
21
|
|
|
22
22
|
``string | undefined`` · Optional
|
|
23
23
|
|
|
24
|
+
### children
|
|
25
|
+
|
|
26
|
+
``ReactNode`` · Optional
|
|
27
|
+
|
|
28
|
+
Content rendered inside the component.
|
|
29
|
+
|
|
@@ -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
|
+
|
|
@@ -11,9 +11,9 @@ 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
|
-
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-data/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
17
|
|
|
18
18
|
## API
|
|
19
19
|
|
|
@@ -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
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/data-explorer",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "GridUI React data explorer",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
@@ -27,22 +27,23 @@
|
|
|
27
27
|
"react-dom": "^19.2.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@gridui/button": "^
|
|
31
|
-
"@gridui/choice": "^1.
|
|
32
|
-
"@gridui/grid": "^3.
|
|
33
|
-
"@gridui/input": "^
|
|
34
|
-
"@gridui/interaction": "^1.
|
|
35
|
-
"@gridui/
|
|
30
|
+
"@gridui/button": "^5.1.0",
|
|
31
|
+
"@gridui/choice": "^1.3.0",
|
|
32
|
+
"@gridui/grid": "^3.1.0",
|
|
33
|
+
"@gridui/input": "^4.0.2",
|
|
34
|
+
"@gridui/interaction": "^1.3.0",
|
|
35
|
+
"@gridui/react-utils": "^1.1.0",
|
|
36
|
+
"@gridui/select": "^1.5.0",
|
|
36
37
|
"@gridui/style-utils": "^4.0.0",
|
|
37
|
-
"@gridui/table": "^3.
|
|
38
|
-
"@gridui/theme": "^
|
|
38
|
+
"@gridui/table": "^3.1.2",
|
|
39
|
+
"@gridui/theme": "^3.0.0",
|
|
39
40
|
"class-variance-authority": "0.7.1"
|
|
40
41
|
},
|
|
41
42
|
"devDependencies": {
|
|
42
43
|
"@gridui-internal/configuration": "0.0.0-internal",
|
|
43
|
-
"@gridui/inline-notice": "1.0.
|
|
44
|
+
"@gridui/inline-notice": "1.0.8",
|
|
44
45
|
"@jest/globals": "30.5.2",
|
|
45
|
-
"@storybook/react-vite": "10.6.
|
|
46
|
+
"@storybook/react-vite": "10.6.7",
|
|
46
47
|
"@types/jest": "30.0.0",
|
|
47
48
|
"@types/node": "26.6.6",
|
|
48
49
|
"@types/react": "19.3.0",
|
|
@@ -55,7 +56,6 @@
|
|
|
55
56
|
"scripts": {
|
|
56
57
|
"build": "node ../../scripts/compilation/package.ts",
|
|
57
58
|
"compile": "tsc --project tsconfig.json",
|
|
58
|
-
"test": "jest"
|
|
59
|
-
"coverage": "jest --coverage"
|
|
59
|
+
"test": "jest"
|
|
60
60
|
}
|
|
61
61
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|