Skip to content

Commit 72ee527

Browse files
authored
Merge pull request #222 from objectstack-ai/copilot/review-update-docs
2 parents cbaebbd + 2f2dbc6 commit 72ee527

30 files changed

Lines changed: 3237 additions & 5278 deletions

README.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -196,22 +196,49 @@ export default App
196196
197197
Object UI is a modular monorepo with packages designed for specific use cases:
198198
199+
### Core Packages
200+
199201
| Package | Description | Size |
200202
|---------|-------------|------|
201-
| **[@object-ui/cli](./packages/cli)** | CLI tool for building apps from JSON schemas | 25KB |
202203
| **[@object-ui/types](./packages/types)** | TypeScript definitions and protocol specs | 10KB |
203-
| **[@object-ui/core](./packages/core)** | Core logic, validation, registry, ObjectStack adapter | 20KB |
204+
| **[@object-ui/core](./packages/core)** | Core logic, validation, registry, expression evaluation | 20KB |
204205
| **[@object-ui/react](./packages/react)** | React bindings and `SchemaRenderer` | 15KB |
205206
| **[@object-ui/components](./packages/components)** | Standard UI components (Tailwind + Shadcn) | 50KB |
206-
| **[vscode-extension](./packages/vscode-extension)** | VSCode extension for schema development | 32KB |
207+
| **[@object-ui/fields](./packages/fields)** | Field renderers and registry | 12KB |
208+
| **[@object-ui/layout](./packages/layout)** | Layout components with React Router integration | 18KB |
207209
208-
**Plugins** (lazy-loaded):
209-
- `@object-ui/plugin-charts` - Chart components (Chart.js)
210-
- `@object-ui/plugin-editor` - Rich text editor components
211-
- `@object-ui/views` - ObjectStack-aware table and form components (core package)
210+
### CLI & Tools
212211
213-
**Developer Tools**:
214-
- **[VSCode Extension](./packages/vscode-extension)** - IntelliSense, live preview, validation, and snippets for Object UI schemas
212+
| Package | Description | Size |
213+
|---------|-------------|------|
214+
| **[@object-ui/cli](./packages/cli)** | CLI tool for building apps from JSON schemas | 25KB |
215+
| **[@object-ui/runner](./packages/runner)** | Universal application runner for testing schemas | 30KB |
216+
| **[vscode-extension](./packages/vscode-extension)** | VSCode extension with IntelliSense and live preview | 32KB |
217+
218+
### Data Adapters
219+
220+
| Package | Description | Size |
221+
|---------|-------------|------|
222+
| **[@object-ui/data-objectstack](./packages/data-objectstack)** | ObjectStack data adapter | 8KB |
223+
224+
### Plugins (Lazy-Loaded)
225+
226+
| Plugin | Description | Size |
227+
|--------|-------------|------|
228+
| **[@object-ui/plugin-aggrid](./packages/plugin-aggrid)** | AG Grid data grid integration | 150KB |
229+
| **[@object-ui/plugin-calendar](./packages/plugin-calendar)** | Calendar and event management | 25KB |
230+
| **[@object-ui/plugin-charts](./packages/plugin-charts)** | Chart components powered by Recharts | 80KB |
231+
| **[@object-ui/plugin-chatbot](./packages/plugin-chatbot)** | Chatbot interface components | 35KB |
232+
| **[@object-ui/plugin-dashboard](./packages/plugin-dashboard)** | Dashboard layouts and widgets | 22KB |
233+
| **[@object-ui/plugin-editor](./packages/plugin-editor)** | Rich text editor powered by Monaco | 120KB |
234+
| **[@object-ui/plugin-form](./packages/plugin-form)** | Advanced form components | 28KB |
235+
| **[@object-ui/plugin-gantt](./packages/plugin-gantt)** | Gantt chart visualization | 40KB |
236+
| **[@object-ui/plugin-grid](./packages/plugin-grid)** | Advanced data grid | 45KB |
237+
| **[@object-ui/plugin-kanban](./packages/plugin-kanban)** | Kanban boards with drag-and-drop | 100KB |
238+
| **[@object-ui/plugin-map](./packages/plugin-map)** | Map visualization | 60KB |
239+
| **[@object-ui/plugin-markdown](./packages/plugin-markdown)** | Markdown rendering | 30KB |
240+
| **[@object-ui/plugin-timeline](./packages/plugin-timeline)** | Timeline components | 20KB |
241+
| **[@object-ui/plugin-view](./packages/plugin-view)** | ObjectQL-integrated views (grid, form, detail) | 35KB |
215242
216243
## 🔌 Data Integration
217244

content/docs/guide/plugins.md

Lines changed: 181 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,60 +16,198 @@ Plugins are lazy-loaded component packages that:
1616

1717
## Official Plugins
1818

19-
Object UI provides four official plugins for common use cases:
19+
Object UI provides 14+ official plugins for common use cases:
2020

21-
### [@object-ui/plugin-editor](../plugins/plugin-editor.md)
21+
### Data Visualization & Dashboards
2222

23-
Code editor component powered by Monaco Editor (VS Code's editor).
23+
#### [@object-ui/plugin-charts](../plugins/plugin-charts.md)
2424

25-
- Syntax highlighting for 100+ languages
26-
- IntelliSense and code completion
27-
- Multiple themes
25+
Data visualization components powered by Recharts.
26+
27+
- Bar, line, area, and pie charts
28+
- Responsive design
29+
- Customizable colors
30+
- Lazy-loaded (~80 KB)
31+
32+
[Read full documentation →](../plugins/plugin-charts.md)
33+
34+
---
35+
36+
#### [@object-ui/plugin-dashboard](../plugins/plugin-dashboard.md)
37+
38+
Dashboard layouts with metric cards and widgets.
39+
40+
- Dashboard grid layouts
41+
- Metric/KPI cards with trends
42+
- Widget system
43+
- Lazy-loaded (~22 KB)
44+
45+
[Read full documentation →](../plugins/plugin-dashboard.md)
46+
47+
---
48+
49+
#### [@object-ui/plugin-timeline](../plugins/plugin-timeline.md)
50+
51+
Timeline component with multiple layout variants.
52+
53+
- Vertical, horizontal layouts
54+
- Customizable markers
55+
- Date formatting
2856
- Lazy-loaded (~20 KB)
2957

30-
[Read full documentation →](../plugins/plugin-editor.md)
58+
[Read full documentation →](../plugins/plugin-timeline.md)
3159

3260
---
3361

34-
### [@object-ui/plugin-charts](../plugins/plugin-charts.md)
62+
#### [@object-ui/plugin-gantt](../plugins/plugin-gantt.md)
3563

36-
Data visualization components powered by Recharts.
64+
Gantt chart for project visualization.
3765

38-
- Bar, line, area, and pie charts
39-
- Responsive design
40-
- Customizable colors
41-
- Lazy-loaded (~540 KB)
66+
- Task dependencies
67+
- Progress tracking
68+
- ObjectQL integration
69+
- Lazy-loaded (~40 KB)
4270

43-
[Read full documentation →](../plugins/plugin-charts.md)
71+
[Read full documentation →](../plugins/plugin-gantt.md)
4472

4573
---
4674

47-
### [@object-ui/plugin-kanban](../plugins/plugin-kanban.md)
75+
#### [@object-ui/plugin-calendar](../plugins/plugin-calendar.md)
4876

49-
Kanban board component with drag-and-drop powered by @dnd-kit.
77+
Calendar visualization for events.
5078

51-
- Drag and drop cards between columns
52-
- Column limits (WIP limits)
53-
- Card badges for status/priority
54-
- Lazy-loaded (~100-150 KB)
79+
- Month/week/day views
80+
- Event management
81+
- ObjectQL integration
82+
- Lazy-loaded (~25 KB)
5583

56-
[Read full documentation →](../plugins/plugin-kanban.md)
84+
[Read full documentation →](../plugins/plugin-calendar.md)
5785

5886
---
5987

60-
### [@object-ui/plugin-markdown](../plugins/plugin-markdown.md)
88+
#### [@object-ui/plugin-map](../plugins/plugin-map.md)
89+
90+
Map visualization with markers.
91+
92+
- Interactive maps
93+
- Location markers
94+
- ObjectQL integration
95+
- Lazy-loaded (~60 KB)
96+
97+
[Read full documentation →](../plugins/plugin-map.md)
98+
99+
---
100+
101+
### Data Management
102+
103+
#### [@object-ui/plugin-grid](../plugins/plugin-grid.md)
104+
105+
Advanced data grid with sorting, filtering, and pagination.
106+
107+
- Column sorting and filtering
108+
- Pagination controls
109+
- Row selection
110+
- Lazy-loaded (~45 KB)
111+
112+
[Read full documentation →](../plugins/plugin-grid.md)
113+
114+
---
115+
116+
#### [@object-ui/plugin-aggrid](../plugins/plugin-aggrid.md)
117+
118+
Enterprise data grid powered by AG Grid.
119+
120+
- Advanced filtering
121+
- Row editing
122+
- Multiple themes
123+
- Lazy-loaded (~150 KB)
124+
125+
[Read full documentation →](../plugins/plugin-aggrid.md)
126+
127+
---
128+
129+
#### [@object-ui/plugin-form](../plugins/plugin-form.md)
130+
131+
Advanced form builder with validation.
132+
133+
- Multi-step forms
134+
- Field validation
135+
- Custom field types
136+
- Lazy-loaded (~28 KB)
137+
138+
[Read full documentation →](../plugins/plugin-form.md)
139+
140+
---
141+
142+
#### [@object-ui/plugin-view](../plugins/plugin-view.md)
143+
144+
ObjectQL-integrated views for automatic CRUD.
145+
146+
- Auto-generated forms and grids
147+
- CRUD operations
148+
- Field mapping
149+
- Lazy-loaded (~35 KB)
150+
151+
[Read full documentation →](../plugins/plugin-view.md)
152+
153+
---
154+
155+
### Content & Editing
156+
157+
#### [@object-ui/plugin-editor](../plugins/plugin-editor.md)
158+
159+
Code editor component powered by Monaco Editor.
160+
161+
- Syntax highlighting for 100+ languages
162+
- IntelliSense and code completion
163+
- Multiple themes
164+
- Lazy-loaded (~120 KB)
165+
166+
[Read full documentation →](../plugins/plugin-editor.md)
167+
168+
---
169+
170+
#### [@object-ui/plugin-markdown](../plugins/plugin-markdown.md)
61171

62172
Markdown renderer with GitHub Flavored Markdown support.
63173

64174
- GitHub Flavored Markdown
65175
- XSS protection
66176
- Code syntax highlighting
67-
- Lazy-loaded (~100-200 KB)
177+
- Lazy-loaded (~30 KB)
68178

69179
[Read full documentation →](../plugins/plugin-markdown.md)
70180

71181
---
72182

183+
#### [@object-ui/plugin-chatbot](../plugins/plugin-chatbot.md)
184+
185+
Chat interface component.
186+
187+
- Message history
188+
- User and assistant roles
189+
- Timestamps and avatars
190+
- Lazy-loaded (~35 KB)
191+
192+
[Read full documentation →](../plugins/plugin-chatbot.md)
193+
194+
---
195+
196+
### Workflows & Tasks
197+
198+
#### [@object-ui/plugin-kanban](../plugins/plugin-kanban.md)
199+
200+
Kanban board component with drag-and-drop powered by @dnd-kit.
201+
202+
- Drag and drop cards between columns
203+
- Column limits (WIP limits)
204+
- Card badges for status/priority
205+
- Lazy-loaded (~100 KB)
206+
207+
[Read full documentation →](../plugins/plugin-kanban.md)
208+
209+
---
210+
73211
## How Plugins Work
74212

75213
### Lazy Loading Architecture
@@ -99,12 +237,22 @@ export const CodeEditorRenderer = (props) => (
99237

100238
### Bundle Impact
101239

102-
| Plugin | Initial Load | Lazy Load |
103-
|--------|-------------|-----------|
104-
| plugin-editor | ~0.2 KB | ~20 KB |
105-
| plugin-charts | ~0.2 KB | ~540 KB |
106-
| plugin-kanban | ~0.2 KB | ~100-150 KB |
107-
| plugin-markdown | ~0.2 KB | ~100-200 KB |
240+
| Plugin | Initial Load | Lazy Load | Description |
241+
|--------|-------------|-----------|-------------|
242+
| plugin-editor | ~0.2 KB | ~120 KB | Monaco editor |
243+
| plugin-charts | ~0.2 KB | ~80 KB | Recharts visualization |
244+
| plugin-kanban | ~0.2 KB | ~100 KB | Drag-and-drop board |
245+
| plugin-markdown | ~0.2 KB | ~30 KB | Markdown rendering |
246+
| plugin-aggrid | ~0.2 KB | ~150 KB | AG Grid data grid |
247+
| plugin-dashboard | ~0.2 KB | ~22 KB | Dashboard layouts |
248+
| plugin-form | ~0.2 KB | ~28 KB | Form builder |
249+
| plugin-grid | ~0.2 KB | ~45 KB | Data grid |
250+
| plugin-view | ~0.2 KB | ~35 KB | ObjectQL views |
251+
| plugin-timeline | ~0.2 KB | ~20 KB | Timeline layouts |
252+
| plugin-chatbot | ~0.2 KB | ~35 KB | Chat interface |
253+
| plugin-calendar | ~0.2 KB | ~25 KB | Calendar views |
254+
| plugin-gantt | ~0.2 KB | ~40 KB | Gantt charts |
255+
| plugin-map | ~0.2 KB | ~60 KB | Map visualization |
108256

109257
Without lazy loading, all this code would be in your main bundle!
110258

@@ -127,6 +275,10 @@ import '@object-ui/plugin-editor'
127275
import '@object-ui/plugin-charts'
128276
import '@object-ui/plugin-kanban'
129277
import '@object-ui/plugin-markdown'
278+
import '@object-ui/plugin-dashboard'
279+
import '@object-ui/plugin-form'
280+
import '@object-ui/plugin-grid'
281+
// ... import other plugins as needed
130282
```
131283

132284
Now all plugin components are available in your schemas!

0 commit comments

Comments
 (0)