You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/guide/schema-overview.md
+33-39Lines changed: 33 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
-
title: "Phase 2 Schemas Overview"
3
-
description: "Comprehensive overview of ObjectUI Phase 2 schemas for building enterprise applications"
2
+
title: "Schema Overview"
3
+
description: "Comprehensive overview of ObjectUI schemas for building enterprise applications"
4
4
---
5
5
6
-
# Phase 2 Schemas Overview
6
+
# Schema Overview
7
7
8
-
ObjectUI Phase 2 introduces powerful new schemas that enable you to build sophisticated enterprise applications with advanced features like theming, reporting, reusable components, and complex workflows. This guide provides an overview of all Phase 2 schemas and helps you get started quickly.
8
+
ObjectUI provides powerful schemas that enable you to build sophisticated enterprise applications with advanced features like theming, reporting, reusable components, and complex workflows. This guide provides an overview of all available schemas and helps you get started quickly.
9
9
10
-
## What's New in Phase 2?
10
+
## Key Capabilities
11
11
12
-
Phase 2 brings enterprise-grade capabilities to ObjectUI, making it easier to build production-ready applications:
12
+
ObjectUI includes enterprise-grade capabilities to build production-ready applications:
13
13
14
14
-**Application Structure** - Define complete multi-page applications with navigation
15
15
-**Dynamic Theming** - Brand your applications with custom themes and light/dark modes
@@ -90,7 +90,7 @@ const action: ActionSchema = {
90
90
-**`confirm`** - Confirmation dialogs
91
91
-**`dialog`** - Modal/dialog actions
92
92
93
-
**Advanced Features:**
93
+
**Key Features:**
94
94
- Action chaining (sequential/parallel)
95
95
- Conditional execution (if/then/else)
96
96
- Success/failure callbacks
@@ -168,7 +168,7 @@ const block: BlockSchema = {
168
168
169
169
## View Components
170
170
171
-
Phase 2 also includes enhanced view components:
171
+
ObjectUI also includes enhanced view components:
172
172
173
173
### [Detail View](/docs/components/detail-view)
174
174
Rich detail pages with sections, tabs, and related records.
@@ -186,7 +186,7 @@ Sort configuration with multiple fields.
186
186
187
187
### Package Installation
188
188
189
-
All Phase 2 schemas are included in `@object-ui/types`. Install it in your project:
189
+
All schemas are included in `@object-ui/types`. Install it in your project:
190
190
191
191
```bash
192
192
npm install @object-ui/types
@@ -235,7 +235,7 @@ if (result.success) {
235
235
236
236
## Quick Start Example
237
237
238
-
Here's a complete example showing how to build a simple CRM application using Phase 2 schemas:
238
+
Here's a complete example showing how to build a simple CRM application using ObjectUI schemas:
1.**Install package** - Add `@object-ui/types` to your project
343
337
```bash
344
338
npm install @object-ui/types@latest
345
339
```
346
340
347
-
2.**Add AppSchema** - Wrap your pages in an application structure (optional)
341
+
2.**Configure application** - Define your app structure with AppSchema (optional)
348
342
349
-
3.**Configure theme** - Add a ThemeSchema for consistent styling (optional)
343
+
3.**Set up theming** - Add a ThemeSchema for consistent styling (optional)
350
344
351
-
4.**Enhance actions** - Update critical actions to use new features like `confirm` and callbacks
345
+
4.**Implement actions** - Use advanced action features like `confirm` and callbacks
352
346
353
-
5.**Test thoroughly** - Verify all existing functionality works as expected
347
+
5.**Test your application** - Verify all functionality works as expected
354
348
355
349
## Learning Resources
356
350
357
351
### Documentation
358
352
-**[Implementation Guide](https://github.com/objectstack-ai/objectui/blob/main/packages/types/PHASE2_IMPLEMENTATION.md)** - Complete implementation details and technical specifications
359
-
-**[Quick Start Guide](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Step-by-step tutorial for getting started with Phase 2
353
+
-**[Quick Start Guide](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Step-by-step tutorial for getting started
360
354
361
355
### API Reference
362
356
-**[TypeScript Types](https://github.com/objectstack-ai/objectui/tree/main/packages/types/src)** - Browse all type definitions
-**[Test Suite](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - 40+ working examples demonstrating all Phase 2 features
360
+
-**[Test Suite](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - 40+ working examples demonstrating all features
367
361
368
362
## Getting Help
369
363
@@ -377,9 +371,9 @@ Phase 2 is fully backward compatible with Phase 1 schemas. You can:
377
371
378
372
## Next Steps
379
373
380
-
Ready to build with Phase 2? Here's what to do next:
374
+
Ready to build with ObjectUI? Here's what to do next:
381
375
382
376
1.**[Review schema documentation](/docs/core)** - Learn about each schema in detail
383
-
2.**[Try the Quick Start](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Build your first Phase 2 application
377
+
2.**[Try the Quick Start](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Build your first ObjectUI application
384
378
3.**[Explore examples](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - See real-world usage patterns
385
379
4.**[Join the community](https://github.com/objectstack-ai/objectui/discussions)** - Connect with other developers
0 commit comments