@izumisy-tailor/tailor-data-viewer 0.1.0 → 0.1.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 +10 -10
- package/package.json +1 -1
- package/src/types/table-metadata.ts +0 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Tailor Data Viewer
|
|
2
2
|
|
|
3
3
|
A React component library for building data exploration interfaces with GraphQL backend support. Provides a tab-based spreadsheet-like UI for viewing and managing table data with relation navigation.
|
|
4
4
|
|
|
@@ -17,11 +17,11 @@ A React component library for building data exploration interfaces with GraphQL
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npm install @tailor-
|
|
20
|
+
npm install @izumisy-tailor/tailor-data-viewer
|
|
21
21
|
# or
|
|
22
|
-
pnpm add @tailor-
|
|
22
|
+
pnpm add @izumisy-tailor/tailor-data-viewer
|
|
23
23
|
# or
|
|
24
|
-
yarn add @tailor-
|
|
24
|
+
yarn add @izumisy-tailor/tailor-data-viewer
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
### Peer Dependencies
|
|
@@ -37,9 +37,9 @@ npm install react react-dom
|
|
|
37
37
|
### Basic Setup
|
|
38
38
|
|
|
39
39
|
```tsx
|
|
40
|
-
import { DataViewer, SavedViewProvider } from "@tailor-
|
|
41
|
-
import type { TableMetadataMap } from "@tailor-
|
|
42
|
-
import "@tailor-
|
|
40
|
+
import { DataViewer, SavedViewProvider } from "@izumisy-tailor/tailor-data-viewer/component";
|
|
41
|
+
import type { TableMetadataMap } from "@izumisy-tailor/tailor-data-viewer/generator";
|
|
42
|
+
import "@izumisy-tailor/tailor-data-viewer/styles/theme.css";
|
|
43
43
|
|
|
44
44
|
// Your table metadata (generated from Tailor Platform schema)
|
|
45
45
|
const tableMetadata: TableMetadataMap = {
|
|
@@ -80,7 +80,7 @@ import {
|
|
|
80
80
|
SearchFilterForm,
|
|
81
81
|
useTableData,
|
|
82
82
|
useColumnState,
|
|
83
|
-
} from "@tailor-
|
|
83
|
+
} from "@izumisy-tailor/tailor-data-viewer/component";
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
### Generating Table Metadata
|
|
@@ -88,7 +88,7 @@ import {
|
|
|
88
88
|
Use the metadata generator to create type-safe metadata from your Tailor Platform schema:
|
|
89
89
|
|
|
90
90
|
```tsx
|
|
91
|
-
import { generateTableMetadata } from "@tailor-
|
|
91
|
+
import { generateTableMetadata } from "@izumisy-tailor/tailor-data-viewer/generator";
|
|
92
92
|
|
|
93
93
|
// From your GraphQL schema types
|
|
94
94
|
const metadata = generateTableMetadata(schemaTypes);
|
|
@@ -236,7 +236,7 @@ The library uses Tailwind CSS classes. Import the base theme or provide your own
|
|
|
236
236
|
|
|
237
237
|
```css
|
|
238
238
|
/* Option 1: Import included theme */
|
|
239
|
-
@import "@tailor-
|
|
239
|
+
@import "@izumisy-tailor/tailor-data-viewer/styles/theme.css";
|
|
240
240
|
|
|
241
241
|
/* Option 2: Use with Tailor app-shell */
|
|
242
242
|
@import "@tailor-platform/app-shell/theme.css";
|
package/package.json
CHANGED