Repository navigation
Add documentation for ObjectKanban, ObjectCalendar, ObjectGantt, and ObjectMap view controls #196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -16,10 +16,11 @@ The Views package provides seamless integration with ObjectQL backends through s | |||
|
|
||||
| ## Components | ||||
|
|
||||
| The plugin provides three main components for building CRUD interfaces: | ||||
| The Views package provides seven comprehensive components for building data-driven interfaces: | ||||
|
|
||||
| ### ObjectTable | ||||
| ### CRUD Components | ||||
|
|
||||
| #### ObjectGrid | ||||
| 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. | ||||
|
|
||||
| **Features:** | ||||
|
|
@@ -29,21 +30,64 @@ Enterprise-grade table component with unified schema supporting both traditional | |||
| - CSV export, column resizing, column reordering | ||||
| - Optional grid mode: inline editing, keyboard navigation, frozen columns (set `editable: true`) | ||||
|
|
||||
| **Single unified type:** | ||||
| - `type: 'object-grid'` - Supports both traditional and grid modes | ||||
| [Learn more about ObjectGrid →](/docs/views/object-grid) | ||||
|
|
||||
| [Learn more about ObjectTable →](/docs/views/object-grid) | ||||
|
|
||||
| ### ObjectForm | ||||
| #### ObjectForm | ||||
| Smart forms with validation and schema integration. Supports both create and edit modes with automatic field generation. | ||||
|
|
||||
| [Learn more about ObjectForm →](/docs/views/object-form) | ||||
|
|
||||
| ### ObjectView | ||||
| #### ObjectView | ||||
| Complete CRUD views combining list, detail, and edit modes in a single component. Ideal for building full-featured data management interfaces. | ||||
|
|
||||
| [Learn more about ObjectView →](/docs/views/object-view) | ||||
|
|
||||
| ### Specialized Visualization Components | ||||
|
|
||||
| #### ObjectKanban | ||||
| Kanban board component for visualizing workflow stages with drag-and-drop functionality. Perfect for project management and pipeline visualization. | ||||
|
|
||||
| **Features:** | ||||
| - Auto-grouping by field (status, stage, etc.) | ||||
| - Drag-and-drop card movement | ||||
| - Column summaries and aggregations | ||||
| - Card customization | ||||
|
|
||||
| [Learn more about ObjectKanban →](/docs/views/object-kanban) | ||||
|
|
||||
| #### ObjectCalendar | ||||
| Calendar component for event and schedule management with multiple view modes (month/week/day). | ||||
|
|
||||
| **Features:** | ||||
| - Multiple view modes (month, week, day) | ||||
| - Multi-day event support | ||||
| - Color coding by category | ||||
| - Date range filtering | ||||
|
|
||||
| [Learn more about ObjectCalendar →](/docs/views/object-calendar) | ||||
|
|
||||
| #### ObjectGantt | ||||
| Gantt chart component for project timeline visualization with task dependencies and progress tracking. | ||||
|
|
||||
| **Features:** | ||||
| - Timeline visualization | ||||
| - Task dependencies | ||||
| - Progress tracking (0-100%) | ||||
| - Critical path highlighting | ||||
|
|
||||
| [Learn more about ObjectGantt →](/docs/views/object-gantt) | ||||
|
|
||||
| #### ObjectMap | ||||
| Interactive map component for geographic data visualization with location markers. | ||||
|
|
||||
| **Features:** | ||||
| - Interactive map with markers | ||||
| - Marker clustering | ||||
| - Custom popups | ||||
| - Auto-fit to bounds | ||||
|
||||
| - Auto-fit to bounds |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation mentions "Marker clustering" and "Custom popups" as features of ObjectMap, but the necessary configuration fields (
enableClustering) and props (renderPopup) don't exist in the actual implementation. These features are not currently available.