Skip to content

Commit cd6462d

Browse files
Copilothotlong
andcommitted
Remove all CRUD references from documentation per ObjectStack protocol
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent fd039bc commit cd6462d

File tree

5 files changed

+23
-44
lines changed

5 files changed

+23
-44
lines changed

docs/COMPONENT_MAPPING_GUIDE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
| 组件 | 类型 | 用途 |
4545
|------|------|------|
4646
| **data-table** | 复杂组件 | 带排序/过滤/分页的高级表格 |
47-
| **crud** | 复杂组件 | 完整的CRUD操作界面 |
4847
| **timeline** | 复杂组件 | 时间线/甘特图 |
4948
| **filter-builder** | 复杂组件 | 可视化查询构建器 |
5049
| **chatbot** | 复杂组件 | 对话机器人界面 |
@@ -197,7 +196,7 @@ function UserTable() {
197196
✅ 已有大量React组件代码
198197

199198
### 使用ObjectUI渲染器(推荐)
200-
快速构建CRUD界面
199+
快速构建数据管理界面
201200
✅ 配置驱动,易于维护
202201
✅ 需要动态UI(从服务端获取配置)
203202
✅ 低代码/无代码平台

docs/DEVELOPMENT_ROADMAP_2026.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ This roadmap details ObjectUI's development plan for 2026, with a focus on impro
2222

2323
## Q1 2026: Core Feature Enhancement (Jan-Mar)
2424

25-
### Theme: View & Form Protocol Enhancement, CRUD Convenience Components Strengthening
25+
### Theme: View & Form Protocol Enhancement, Data Management Features
2626

27-
**Milestone**: CRUD Convenience Components reach enterprise-grade standards
28-
29-
**Note**: CRUD components are ObjectUI extension components (not part of ObjectStack standard protocol), designed to simplify data management interface development.
27+
**Milestone**: Data management components reach enterprise-grade standards
3028

3129
### New Components (8)
3230

@@ -212,7 +210,7 @@ This roadmap details ObjectUI's development plan for 2026, with a focus on impro
212210

213211
### Theme: ObjectStack Protocol Core
214212

215-
**Milestone**: Support automatic generation of complete CRUD interfaces from Object definitions
213+
**Milestone**: Support automatic generation of complete data management interfaces from Object definitions
216214

217215
### Core Components (6)
218216

@@ -721,7 +719,7 @@ Upload UI screenshot → Visual recognition → Generate Schema → Manual refin
721719
### Q2 2026 Checkpoint
722720

723721
- ✅ Component count: 90+
724-
-CRUD Convenience Components: 100%
722+
-Data Management Components: 100%
725723
- ✅ Object Protocol: 80%
726724
- ✅ Test coverage: 75%
727725
- ✅ Weekly NPM downloads: 1000+
@@ -743,7 +741,7 @@ Upload UI screenshot → Visual recognition → Generate Schema → Manual refin
743741

744742
2026 is a critical year for ObjectUI to evolve from "usable" to "excellent":
745743

746-
**Q1**: Fill gaps, enhance CRUD
744+
**Q1**: Fill gaps, enhance data management
747745
**Q2**: Core breakthrough, Object Protocol
748746
**Q3**: Mobile-first, user experience
749747
**Q4**: Ecosystem prosperity, developer happiness

docs/EVALUATION_INDEX.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,6 @@ This directory contains the complete component evaluation and development planni
106106
| **Test Coverage** | 60% |
107107
| **Bundle Size** | 50KB (gzip) |
108108

109-
**Note**: CRUD are ObjectUI's Convenience Components, not part of the ObjectStack standard protocol. True CRUD operations will be implemented through the Object protocol.
110-
111109
### 2026 Targets
112110

113111
| Metric | Q2 Target | Q4 Target |
@@ -123,7 +121,7 @@ This directory contains the complete component evaluation and development planni
123121
## 🚀 Priority Roadmap
124122

125123
### Q1 2026 (Jan-Mar) - ✅ Core Refinement
126-
**Focus**: View and Form protocol refinement, CRUD Convenience Components enhancement
124+
**Focus**: View and Form protocol refinement, data management component enhancement
127125

128126
**New Components**:
129127
- BulkEditDialog (Bulk editing)

docs/OBJECTSTACK_COMPONENT_EVALUATION.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ObjectUI adopts **two independent but complementary component systems**:
3333
#### 2. Object Components
3434
- **Positioning**: Automatically generate UI from ObjectStack Object definitions
3535
- **Data Source**: Driven by Object definitions (.object.yml files)
36-
- **Advantages**: Zero-config CRUD, automatic relationship handling, type safety, strong maintainability
36+
- **Advantages**: Zero-config data management, automatic relationship handling, type safety, strong maintainability
3737
- **Examples**: `object-table`, `object-form`, `object-list`
3838
- **Current Status**: 0 components, Q2 2026 planned 📝
3939

@@ -52,7 +52,7 @@ ObjectUI adopts a clear three-layer component architecture:
5252
│ - Business logic wrapper, supports expressions, │
5353
│ data binding, validation │
5454
│ - Examples: InputRenderer, FormRenderer, │
55-
CRUDRenderer
55+
DataTableRenderer
5656
└─────────────────────────────────────────────────────┘
5757
↓ uses
5858
┌─────────────────────────────────────────────────────┐
@@ -113,7 +113,7 @@ ObjectUI adopts a clear three-layer component architecture:
113113

114114
**Characteristics**:
115115
- Automatically generate UI from ObjectStack Object definitions
116-
- Zero-config CRUD (automatically generated from Object.fields)
116+
- Zero-config data management (automatically generated from Object.fields)
117117
- Intelligently handle relationship fields (lookup/master-detail)
118118
- Data source: Object definitions + ObjectQL
119119

@@ -140,7 +140,7 @@ ObjectUI adopts a clear three-layer component architecture:
140140
| **Flexibility** | High (fully customizable) | Medium (constrained by Object) |
141141
| **Development Speed** | Medium (requires manual config) | Fast (zero-config) |
142142
| **Maintainability** | Schema needs sync maintenance | UI auto-updates when Object changes |
143-
| **Use Cases** | Custom dashboards, complex interactions | Standard CRUD, rapid prototyping |
143+
| **Use Cases** | Custom dashboards, complex interactions | Standard data management, rapid prototyping |
144144

145145
---
146146

@@ -322,26 +322,16 @@ toggle-group, tooltip
322322

323323
### 3.1 Protocol Type Implementation Status
324324

325-
**Note**: CRUD is not an independent ObjectStack Protocol type, but a Convenience Component provided by ObjectUI that combines View and Form Protocol functionality to simplify data management interface construction.
326-
327325
| Protocol Type | Status | Completion | Core Components | Description |
328326
|----------|------|--------|----------|------|
329327
| **View** | ✅ Implemented | 100% | list, table, data-table, kanban, calendar, timeline, card, grid | All 8 view types implemented |
330328
| **Form** | ✅ Implemented | 100% | form + 17 form controls | Complete validation engine |
331329
| **Page** | 🚧 Partially implemented | 70% | page, container, grid, tabs | Missing routing integration |
332330
| **Menu** | 🚧 Partially implemented | 60% | navigation-menu, sidebar, breadcrumb | Missing permission control |
333-
| **Object** | 📝 Planned | 0% | - | Q2 2026 planned (includes CRUD operations) |
331+
| **Object** | 📝 Planned | 0% | - | Q2 2026 planned |
334332
| **App** | 📝 Planned | 0% | - | Q2 2026 planned |
335333
| **Report** | 📝 Planned | 0% | - | Q3 2026 planned |
336334

337-
### 3.1.1 ObjectUI Extension Components
338-
339-
ObjectUI provides additional Convenience Components beyond standard Protocol:
340-
341-
| Component Type | Status | Completion | Core Components | Description |
342-
|----------|------|--------|----------|------|
343-
| **CRUD Components** | 🚧 Partially implemented | 80% | data-table, form, dialog | Convenience Components combining View+Form, missing batch operations |
344-
345335
### 3.2 View Protocol Detailed Support
346336

347337
| View Type | Component | Status | Features |
@@ -355,9 +345,7 @@ ObjectUI provides additional Convenience Components beyond standard Protocol:
355345
| **detail** | `page` + `form` || Read-only detail page |
356346
| **form** | `form` || Multi-step, conditional fields, dynamic validation |
357347

358-
### 3.3 CRUD Component Feature Support
359-
360-
**Note**: CRUD Components are extension components provided by ObjectUI (not standard ObjectStack Protocol), used to simplify data management interface development. They combine View Protocol (data-table) and Form Protocol (form) functionality.
348+
### 3.3 Data Management Feature Support
361349

362350
| Feature | Status | Implementation Component | Description |
363351
|------|------|----------|------|
@@ -511,9 +499,7 @@ export function InputRenderer({ schema }: RendererProps<InputSchema>) {
511499

512500
### 5.1 High Priority Missing Components
513501

514-
#### CRUD Operation Enhancement
515-
516-
**Note**: The following components enhance ObjectUI's CRUD Convenience Components. True CRUD operation support will be implemented in Q2 2026 through the Object Protocol.
502+
#### Data Management Enhancement
517503

518504
| Component | Priority | Purpose | Effort |
519505
|------|--------|------|--------|
@@ -633,7 +619,7 @@ All components are currently responsive, but require specialized mobile optimiza
633619

634620
### 6.1 Q1 2026 (Jan-Mar) - Core Enhancement ✅ Partially Complete
635621

636-
**Goal**: Enhance View and Form Protocol support, strengthen CRUD Convenience Components
622+
**Goal**: Enhance View and Form Protocol support, strengthen data management components
637623

638624
| Task | Time | Owner | Status |
639625
|------|------|--------|------|
@@ -645,7 +631,7 @@ All components are currently responsive, but require specialized mobile optimiza
645631
| Component documentation | 2 weeks | TBD | 🚧 In progress |
646632

647633
**Deliverables**:
648-
-CRUD Convenience Components functionality at 100%
634+
-Data management components functionality at 100%
649635
- ✅ Form components cover common business scenarios
650636
- ✅ Storybook documentation covers all components
651637

@@ -670,7 +656,7 @@ All components are currently responsive, but require specialized mobile optimiza
670656

671657
**Milestones**:
672658
- ✅ Object Component System: 10 core components
673-
- ✅ Support auto-generating UI from Object definitions (zero-config CRUD)
659+
- ✅ Support auto-generating UI from Object definitions (zero-config data management)
674660
- ✅ Support lookup and master-detail relationship fields
675661
- ✅ Support all ObjectQL field types
676662
- ✅ Platform Basic Components: 84 components (+8 additions)
@@ -790,7 +776,7 @@ All components are currently responsive, but require specialized mobile optimiza
790776
| Dimension | ObjectUI | Formily |
791777
|------|----------|---------|
792778
| Positioning | Full-stack UI | Form-focused |
793-
| Protocol Scope | Wide (Page/View/CRUD) | Narrow (Form) |
779+
| Protocol Scope | Wide (Page/View/Form) | Narrow (Form) |
794780
| Backend Integration | ObjectStack | Any |
795781
| Complexity | Simple | Complex |
796782

docs/OBJECTSTACK_COMPONENT_EVALUATION_EN.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document provides a comprehensive evaluation of ObjectUI's frontend compone
1414

1515
-**76 renderer components** implemented across 8 categories
1616
-**60 Shadcn UI base components** integrated as design system foundation
17-
- 🚧 **Protocol Support**: View (100%), Form (100%), CRUD (80%), Object (planned)
17+
- 🚧 **Protocol Support**: View (100%), Form (100%), Object (planned)
1818
- 📊 **Component Coverage**: Basic features 100%, Advanced features 85%
1919
- 🎯 **Code Quality**: Average 80-150 lines per renderer, maintaining clean architecture
2020

@@ -80,19 +80,17 @@ This document provides a comprehensive evaluation of ObjectUI's frontend compone
8080
| **Form** | ✅ Implemented | 100% | form + 17 form controls | Complete validation engine |
8181
| **Page** | 🚧 Partial | 70% | page, container, grid, tabs | Missing routing integration |
8282
| **Menu** | 🚧 Partial | 60% | navigation-menu, sidebar, breadcrumb | Missing permission control |
83-
| **Object** | 📝 Planned | 0% | - | Q2 2026 target (includes CRUD operations) |
83+
| **Object** | 📝 Planned | 0% | - | Q2 2026 target |
8484
| **App** | 📝 Planned | 0% | - | Q2 2026 target |
8585
| **Report** | 📝 Planned | 0% | - | Q3 2026 target |
8686

87-
**Note**: The "CRUD" component in ObjectUI is a convenience wrapper (not an official ObjectStack protocol type) that combines View and Form protocols to simplify data management interfaces.
88-
8987
---
9088

9189
## Component Gaps Analysis
9290

9391
### High Priority Missing Components
9492

95-
#### CRUD Enhancements
93+
#### Data Management Enhancements
9694
- **BulkEditDialog**: Edit multiple records at once (3 days)
9795
- **ExportWizard**: Export data to CSV/Excel/JSON (2 days)
9896
- **InlineEditCell**: Direct table cell editing (2 days)
@@ -113,7 +111,7 @@ This document provides a comprehensive evaluation of ObjectUI's frontend compone
113111
## 2026 Development Roadmap
114112

115113
### Q1 2026 (Jan-Mar): Core Feature Completion
116-
**Focus**: Perfect CRUD & Form protocols
114+
**Focus**: Perfect Form protocols and data management features
117115

118116
**Deliverables**:
119117
- ✅ 8 new components (BulkEdit, TagsInput, Stepper, Export, etc.)
@@ -196,7 +194,7 @@ This document provides a comprehensive evaluation of ObjectUI's frontend compone
196194
| Dimension | ObjectUI | Formily |
197195
|-----------|----------|---------|
198196
| Scope | Full-stack UI | Form-focused |
199-
| Protocol Range | Broad (Page/View/CRUD) | Narrow (Form) |
197+
| Protocol Range | Broad (Page/View/Form) | Narrow (Form) |
200198
| Backend Integration | ObjectStack | Any |
201199
| Complexity | Simple | Complex |
202200

0 commit comments

Comments
 (0)