Skip to content

Commit 12b1047

Browse files
committed
docs(frontend): spell the SDK ObjectUI, as the rest of the site does
Claude-Session: https://claude.ai/code/session_01L9qibzngYyRjmvNxjkfVyd Co-authored-by: Claude <noreply@anthropic.com>
1 parent 773055d commit 12b1047

10 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎content/docs/frontend/cli.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ it writes.
308308
"children": {
309309
"type": "card",
310310
"title": "Hello World",
311-
"children": { "type": "text", "content": "Welcome to Object UI!" }
311+
"children": { "type": "text", "content": "Welcome to ObjectUI!" }
312312
}
313313
}
314314
```
@@ -323,7 +323,7 @@ children:
323323
title: Hello World
324324
children:
325325
type: text
326-
content: Welcome to Object UI!
326+
content: Welcome to ObjectUI!
327327
```
328328
329329
### File-system routing

‎content/docs/frontend/component-registry.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Component Registry"
33
---
44

5-
The Component Registry is Object UI's system for mapping schema types to React components. Understanding the registry is key to extending Object UI with custom components.
5+
The Component Registry is ObjectUI's system for mapping schema types to React components. Understanding the registry is key to extending ObjectUI with custom components.
66

77
## Overview
88

‎content/docs/frontend/fields.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Field Registry"
33
---
44

5-
Object UI uses a **Field Registry** system to decouple the core engine from specific UI implementations of fields. This allows for rich extensibility and plugin support.
5+
ObjectUI uses a **Field Registry** system to decouple the core engine from specific UI implementations of fields. This allows for rich extensibility and plugin support.
66

77
## Concept
88

@@ -66,7 +66,7 @@ Once registered, you can simply use the new type in your JSON schema.
6666

6767
## Standard Fields
6868

69-
Object UI comes with built-in support for the standard [ObjectStack Protocol](https://github.com/objectstack-ai/objectstack/tree/main/packages/spec) types:
69+
ObjectUI comes with built-in support for the standard [ObjectStack Protocol](https://github.com/objectstack-ai/objectstack/tree/main/packages/spec) types:
7070

7171
| Type | Description |
7272
|---|---|

‎content/docs/frontend/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Custom front-end"
3-
description: "Three ways to build your own UI on ObjectStack: a React page inside the Console, your own front-end over the Client SDK, or your own React app rendering metadata with the Object UI SDK"
3+
description: "Three ways to build your own UI on ObjectStack: a React page inside the Console, your own front-end over the Client SDK, or your own React app rendering metadata with the ObjectUI SDK"
44
---
55

66
ObjectStack gives you three ways to build UI the Console does not draw for you. Pick by where the
@@ -10,14 +10,14 @@ UI runs and who renders it.
1010
| --- | --- | --- |
1111
| Add a custom page to an ObjectStack app | [React pages](/docs/ui/react-pages): the page source is metadata | Inside the Console |
1212
| Read and write ObjectStack data from your own front-end | [Client SDK](/docs/api/client-sdk) (`@objectstack/client`) | Your app, any framework |
13-
| Render ObjectStack views, forms and dashboards in your own React app | The Object UI SDK, below | Your React app |
13+
| Render ObjectStack views, forms and dashboards in your own React app | The ObjectUI SDK, below | Your React app |
1414

1515
The first path is metadata like any other page, so it is documented with [Views & Apps](/docs/ui).
16-
The rest of this section is the Object UI SDK.
16+
The rest of this section is the ObjectUI SDK.
1717

18-
## The Object UI SDK
18+
## The ObjectUI SDK
1919

20-
The Object UI SDK is the set of MIT-licensed `@object-ui/*` packages that render ObjectStack
20+
The ObjectUI SDK is the set of MIT-licensed `@object-ui/*` packages that render ObjectStack
2121
JSON schemas inside your own React app. JSON metadata goes in, and accessible, themeable
2222
components built with Tailwind CSS, Shadcn UI and Radix primitives come out.
2323

‎content/docs/frontend/meta.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"title": "Custom Front-end",
33
"pages": [
44
"index",
5-
"---Object UI SDK---",
5+
"---ObjectUI SDK---",
66
"quick-start",
77
"building-crud-app",
88
"architecture-overview",

‎content/docs/frontend/plugin-development.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Custom Plugin Development"
33
---
44

5-
This page builds a **front-end** plugin for the Object UI SDK. To extend the ObjectStack server
5+
This page builds a **front-end** plugin for the ObjectUI SDK. To extend the ObjectStack server
66
with a runtime plugin, see [Plugin development](/docs/plugins/development).
77

88
This guide walks you through creating custom ObjectUI plugins — from scaffolding to publishing. Plugins extend ObjectUI with new view types, field widgets, or complex interactive components while keeping your application bundle lean through lazy loading.

‎content/docs/frontend/plugins/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: "UI plugins"
3-
description: "Lazy-loaded @object-ui/plugin-* packages that add views, charts, editors and chat to the Object UI SDK"
3+
description: "Lazy-loaded @object-ui/plugin-* packages that add views, charts, editors and chat to the ObjectUI SDK"
44
---
55

6-
These are **front-end** plugins: npm packages that register extra renderers in the Object UI SDK.
6+
These are **front-end** plugins: npm packages that register extra renderers in the ObjectUI SDK.
77
They are not the server-side runtime plugins that extend the ObjectStack kernel, which are documented
88
under [Plugins & Packages](/docs/plugins).
99

10-
Object UI supports a powerful plugin system that allows you to extend the framework with additional components. Plugins are separate packages that load on-demand, keeping your main application bundle small while providing rich functionality.
10+
ObjectUI supports a powerful plugin system that allows you to extend the framework with additional components. Plugins are separate packages that load on-demand, keeping your main application bundle small while providing rich functionality.
1111

1212
## Overview
1313

@@ -21,7 +21,7 @@ Plugins are lazy-loaded component packages that:
2121

2222
## Official Plugins
2323

24-
Object UI provides 14+ official plugins for common use cases:
24+
ObjectUI provides 14+ official plugins for common use cases:
2525

2626
### Data Visualization & Dashboards
2727

@@ -561,4 +561,4 @@ export function registerComponents() {
561561
1. Install official plugins you need
562562
2. Try creating a custom plugin
563563
3. Share your plugins with the community
564-
4. Contribute new plugins to Object UI
564+
4. Contribute new plugins to ObjectUI

‎content/docs/frontend/plugins/plugin-list.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: "Plugin List"
3-
description: "ListView plugin for Object UI - unified view component with view type switching"
3+
description: "ListView plugin for ObjectUI - unified view component with view type switching"
44
---
55

66
## @object-ui/plugin-list
77

8-
ListView plugin for Object UI - unified view component with view type switching
8+
ListView plugin for ObjectUI - unified view component with view type switching
99

1010
## Installation
1111

‎content/docs/frontend/renderers.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "Renderer types"
3-
description: "The renderer types the Object UI component packages register, for apps that render their own JSON with the SDK"
3+
description: "The renderer types the ObjectUI component packages register, for apps that render their own JSON with the SDK"
44
---
55

66
<Callout type="warn" title="SDK only">
7-
These types exist only inside an app that renders JSON with the Object UI SDK. None of them is in
7+
These types exist only inside an app that renders JSON with the ObjectUI SDK. None of them is in
88
`sdui.manifest.json`, so an ObjectStack page cannot use them. The components a page can hold are in the
99
[component reference](/docs/ui/components).
1010
</Callout>

‎content/docs/frontend/schema-rendering.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Schema Rendering"
33
---
44

5-
Object UI's schema rendering system is the core mechanism that transforms JSON configurations into live React components. This guide explains how it works and how to use it effectively.
5+
ObjectUI's schema rendering system is the core mechanism that transforms JSON configurations into live React components. This guide explains how it works and how to use it effectively.
66

77
## Overview
88

@@ -12,7 +12,7 @@ The schema rendering engine follows a simple principle:
1212
JSON Schema → SchemaRenderer → React Components → Beautiful UI
1313
```
1414

15-
Every visual element in Object UI starts as a JSON object that describes what should be rendered, not how it should be rendered.
15+
Every visual element in ObjectUI starts as a JSON object that describes what should be rendered, not how it should be rendered.
1616

1717
## The SchemaRenderer Component
1818

@@ -225,7 +225,7 @@ Use arrays for multiple items:
225225

226226
## Expression System
227227

228-
Object UI includes a powerful expression system for dynamic behavior:
228+
ObjectUI includes a powerful expression system for dynamic behavior:
229229

230230
### Simple Expressions
231231

0 commit comments

Comments
 (0)