Skip to content

Commit 7ece09e

Browse files
Copilothotlong
andcommitted
Add comprehensive UI component design system (input, display, layout)
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 25f4c45 commit 7ece09e

93 files changed

Lines changed: 3143 additions & 25 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/references/data/field.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Field protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { AddressSchema, ComputedFieldCacheSchema, CurrencyConfigSchema, CurrencyValueSchema, DataQualityRulesSchema, FieldSchema, FieldTypeSchema, FileAttachmentConfigSchema, LocationCoordinatesSchema, SelectOptionSchema, VectorConfigSchema } from '@objectstack/spec/data';
16-
import type { Address, ComputedFieldCache, CurrencyConfig, CurrencyValue, DataQualityRules, Field, FieldType, FileAttachmentConfig, LocationCoordinates, SelectOption, VectorConfig } from '@objectstack/spec/data';
15+
import { AddressSchema, ComputedFieldCacheSchema, CurrencyConfigSchema, CurrencyValueSchema, DataQualityRulesSchema, FieldSchema, FieldTypeSchema, FileAttachmentConfigSchema, LocationCoordinatesSchema, VectorConfigSchema } from '@objectstack/spec/data';
16+
import type { Address, ComputedFieldCache, CurrencyConfig, CurrencyValue, DataQualityRules, Field, FieldType, FileAttachmentConfig, LocationCoordinates, VectorConfig } from '@objectstack/spec/data';
1717

1818
// Validate data
1919
const result = AddressSchema.parse(data);
@@ -57,9 +57,5 @@ const result = AddressSchema.parse(data);
5757

5858
---
5959

60-
## SelectOption
61-
62-
---
63-
6460
## VectorConfig
6561

content/docs/references/ui/component.mdx

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,39 @@ description: Component protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { PageCardPropsSchema, PageHeaderPropsSchema, PageTabsPropsSchema, RecordDetailsPropsSchema, RecordHighlightsPropsSchema, RecordRelatedListPropsSchema } from '@objectstack/spec/ui';
16-
import type { PageCardProps, PageHeaderProps, PageTabsProps, RecordDetailsProps, RecordHighlightsProps, RecordRelatedListProps } from '@objectstack/spec/ui';
15+
import { AlertPropsSchema, BottomNavigationPropsSchema, DataTablePropsSchema, EmptyStatePropsSchema, FloatingActionButtonPropsSchema, KanbanBoardPropsSchema, PageCardPropsSchema, PageHeaderPropsSchema, PageTabsPropsSchema, PullToRefreshPropsSchema, RecordDetailsPropsSchema, RecordHighlightsPropsSchema, RecordRelatedListPropsSchema, TreeViewPropsSchema } from '@objectstack/spec/ui';
16+
import type { AlertProps, BottomNavigationProps, DataTableProps, EmptyStateProps, FloatingActionButtonProps, KanbanBoardProps, PageCardProps, PageHeaderProps, PageTabsProps, PullToRefreshProps, RecordDetailsProps, RecordHighlightsProps, RecordRelatedListProps, TreeViewProps } from '@objectstack/spec/ui';
1717

1818
// Validate data
19-
const result = PageCardPropsSchema.parse(data);
19+
const result = AlertPropsSchema.parse(data);
2020
```
2121

2222
---
2323

24+
## AlertProps
25+
26+
---
27+
28+
## BottomNavigationProps
29+
30+
---
31+
32+
## DataTableProps
33+
34+
---
35+
36+
## EmptyStateProps
37+
38+
---
39+
40+
## FloatingActionButtonProps
41+
42+
---
43+
44+
## KanbanBoardProps
45+
46+
---
47+
2448
## PageCardProps
2549

2650
---
@@ -33,6 +57,10 @@ const result = PageCardPropsSchema.parse(data);
3357

3458
---
3559

60+
## PullToRefreshProps
61+
62+
---
63+
3664
## RecordDetailsProps
3765

3866
---
@@ -43,3 +71,7 @@ const result = PageCardPropsSchema.parse(data);
4371

4472
## RecordRelatedListProps
4573

74+
---
75+
76+
## TreeViewProps
77+

content/docs/references/ui/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ This section contains all protocol schemas for the ui layer of ObjectStack.
1313
<Card href="./chart" title="Chart" description="Source: packages/spec/src/ui/chart.zod.ts" />
1414
<Card href="./component" title="Component" description="Source: packages/spec/src/ui/component.zod.ts" />
1515
<Card href="./dashboard" title="Dashboard" description="Source: packages/spec/src/ui/dashboard.zod.ts" />
16+
<Card href="./display" title="Display" description="Source: packages/spec/src/ui/display.zod.ts" />
17+
<Card href="./input" title="Input" description="Source: packages/spec/src/ui/input.zod.ts" />
18+
<Card href="./layout" title="Layout" description="Source: packages/spec/src/ui/layout.zod.ts" />
1619
<Card href="./page" title="Page" description="Source: packages/spec/src/ui/page.zod.ts" />
1720
<Card href="./report" title="Report" description="Source: packages/spec/src/ui/report.zod.ts" />
1821
<Card href="./theme" title="Theme" description="Source: packages/spec/src/ui/theme.zod.ts" />

content/docs/references/ui/meta.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
"chart",
77
"component",
88
"dashboard",
9+
"display",
10+
"input",
11+
"layout",
912
"page",
1013
"report",
1114
"theme",
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/AccordionProps",
3+
"definitions": {
4+
"AccordionProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/AlertProps",
3+
"definitions": {
4+
"AlertProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/AutocompleteProps",
3+
"definitions": {
4+
"AutocompleteProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/AvatarGroupProps",
3+
"definitions": {
4+
"AvatarGroupProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/AvatarProps",
3+
"definitions": {
4+
"AvatarProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$ref": "#/definitions/BadgeProps",
3+
"definitions": {
4+
"BadgeProps": {}
5+
},
6+
"$schema": "http://json-schema.org/draft-07/schema#"
7+
}

0 commit comments

Comments
 (0)