Skip to content

Commit 19e2ae3

Browse files
authored
Merge pull request #196 from objectstack-ai/copilot/add-view-controls-documentation
2 parents edf6ed4 + f465e29 commit 19e2ae3

6 files changed

Lines changed: 2240 additions & 9 deletions

File tree

‎content/docs/views/index.mdx‎

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ The Views package provides seamless integration with ObjectQL backends through s
1616

1717
## Components
1818

19-
The plugin provides three main components for building CRUD interfaces:
19+
The Views package provides seven comprehensive components for building data-driven interfaces:
2020

21-
### ObjectTable
21+
### CRUD Components
2222

23+
#### ObjectGrid
2324
Enterprise-grade table component with unified schema supporting both traditional CRUD and spreadsheet-like inline editing. Built on data-table foundation with automatic field type rendering.
2425

2526
**Features:**
@@ -29,21 +30,64 @@ Enterprise-grade table component with unified schema supporting both traditional
2930
- CSV export, column resizing, column reordering
3031
- Optional grid mode: inline editing, keyboard navigation, frozen columns (set `editable: true`)
3132

32-
**Single unified type:**
33-
- `type: 'object-grid'` - Supports both traditional and grid modes
33+
[Learn more about ObjectGrid →](/docs/views/object-grid)
3434

35-
[Learn more about ObjectTable →](/docs/views/object-grid)
36-
37-
### ObjectForm
35+
#### ObjectForm
3836
Smart forms with validation and schema integration. Supports both create and edit modes with automatic field generation.
3937

4038
[Learn more about ObjectForm →](/docs/views/object-form)
4139

42-
### ObjectView
40+
#### ObjectView
4341
Complete CRUD views combining list, detail, and edit modes in a single component. Ideal for building full-featured data management interfaces.
4442

4543
[Learn more about ObjectView →](/docs/views/object-view)
4644

45+
### Specialized Visualization Components
46+
47+
#### ObjectKanban
48+
Kanban board component for visualizing workflow stages with drag-and-drop functionality. Perfect for project management and pipeline visualization.
49+
50+
**Features:**
51+
- Auto-grouping by field (status, stage, etc.)
52+
- Drag-and-drop card movement
53+
- Column summaries and aggregations
54+
- Card customization
55+
56+
[Learn more about ObjectKanban →](/docs/views/object-kanban)
57+
58+
#### ObjectCalendar
59+
Calendar component for event and schedule management with multiple view modes (month/week/day).
60+
61+
**Features:**
62+
- Multiple view modes (month, week, day)
63+
- Multi-day event support
64+
- Color coding by category
65+
- Date range filtering
66+
67+
[Learn more about ObjectCalendar →](/docs/views/object-calendar)
68+
69+
#### ObjectGantt
70+
Gantt chart component for project timeline visualization with task dependencies and progress tracking.
71+
72+
**Features:**
73+
- Timeline visualization
74+
- Task dependencies
75+
- Progress tracking (0-100%)
76+
- Critical path highlighting
77+
78+
[Learn more about ObjectGantt →](/docs/views/object-gantt)
79+
80+
#### ObjectMap
81+
Interactive map component for geographic data visualization with location markers.
82+
83+
**Features:**
84+
- Interactive map with markers
85+
- Marker clustering
86+
- Custom popups
87+
- Auto-fit to bounds
88+
89+
[Learn more about ObjectMap →](/docs/views/object-map)
90+
4791
## Features
4892

4993
- **Schema-driven**: Automatically adapts to ObjectQL metadata

‎content/docs/views/meta.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
"object-grid",
55
"object-form",
66
"object-field",
7-
"object-view"
7+
"object-view",
8+
"object-kanban",
9+
"object-calendar",
10+
"object-gantt",
11+
"object-map"
812
]
913
}

0 commit comments

Comments
 (0)