Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions packages/app-shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -613,8 +613,6 @@ pins (20) each have an independent cap. See the guide below for details.
See [User-Scoped State Persistence](../../content/docs/guide/user-state-persistence.md)
for the adapter contract, backend schema, and how to plug in your own backend.

<!-- release-metadata:v3.3.0 -->

## Command palette (⌘K)

`<ConsoleShell>` mounts a global ⌘K command palette for cross-app navigation and
Expand Down Expand Up @@ -771,15 +769,6 @@ import { PreviewBadge, getPlatformStage } from '@object-ui/app-shell';

Labels are localized under `topbar.stage.*` (`@object-ui/i18n`).

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/layout/app-shell)
Expand Down
11 changes: 0 additions & 11 deletions packages/auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,17 +207,6 @@ function MyComponent() {

> **⚠️ Security:** Preview mode should **never** be used in production environments.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📦 [npm package](https://www.npmjs.com/package/@object-ui/auth)
Expand Down
8 changes: 0 additions & 8 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,6 @@ await serve('app.json', { port: '3000', host: 'localhost' });
await init('my-app', { template: 'dashboard' });
```

## Compatibility

- **Node.js** ≥ 18
- **TypeScript** ≥ 5.0 (strict mode)
- **`@objectstack/spec`** ^3.3.0
- **`@objectstack/client`** ^3.3.0
- **Tailwind CSS** ≥ 3.4

## Links

- 📚 [Documentation](https://www.objectui.org/docs/utilities/cli)
Expand Down
11 changes: 0 additions & 11 deletions packages/collaboration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,17 +116,6 @@ Threaded comment component with @mentions:
/>
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📦 [npm package](https://www.npmjs.com/package/@object-ui/collaboration)
Expand Down
11 changes: 0 additions & 11 deletions packages/components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,17 +211,6 @@ registerRenderer('custom-button', CustomButton)

See [full documentation](https://objectui.org/docs/components) for detailed API reference.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/components)
Expand Down
10 changes: 0 additions & 10 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,16 +143,6 @@ This allows the core types and logic to be used in:

See [full documentation](https://objectui.org/docs/api) for detailed API reference.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/guide/architecture)
Expand Down
10 changes: 0 additions & 10 deletions packages/create-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,6 @@ pnpm create @object-ui/plugin my-plugin --description "My awesome plugin" --auth
pnpm test
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/guide/plugin-development)
Expand Down
10 changes: 0 additions & 10 deletions packages/data-objectstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,16 +470,6 @@ dataSource.clearCache();
dataSource.invalidateCache('users');
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/guide/data-source)
Expand Down
11 changes: 0 additions & 11 deletions packages/fields/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,17 +115,6 @@ Client-side hiding is UX only — gate authorization-sensitive values on the
server too. See
[`content/docs/fields/select.mdx`](../../content/docs/fields/select.mdx).

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/guide/fields)
Expand Down
11 changes: 0 additions & 11 deletions packages/i18n/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,17 +136,6 @@ isRTL('ar'); // true
isRTL('en'); // false
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📦 [npm package](https://www.npmjs.com/package/@object-ui/i18n)
Expand Down
11 changes: 0 additions & 11 deletions packages/layout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,17 +121,6 @@ All components accept `className` prop for Tailwind customization:

For detailed API documentation, visit the [Object UI Documentation](https://www.objectui.org/docs/layout/app-shell).

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/guide/layout)
Expand Down
11 changes: 0 additions & 11 deletions packages/mobile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,6 @@ const manifest = generatePWAManifest({ name: 'My App', themeColor: '#000' });
registerServiceWorker({ cacheStrategy: 'network-first' });
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📦 [npm package](https://www.npmjs.com/package/@object-ui/mobile)
Expand Down
11 changes: 0 additions & 11 deletions packages/permissions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,17 +121,6 @@ const store = createPermissionStore(permissionConfig);
store.check('read', 'orders'); // true | false
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📦 [npm package](https://www.npmjs.com/package/@object-ui/permissions)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-ai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,6 @@ Components auto-register with `ComponentRegistry`:
}
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-ai)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-calendar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,17 +254,6 @@ const schema: CalendarViewSchema = {
};
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-calendar)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,6 @@ By using lazy loading, the main application bundle stays lean:

This results in significantly faster initial page loads for applications that don't use charts on every page.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-charts)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,17 +211,6 @@ const aiSchema = {
| Stop/Reload | Stop cancels timer | Stop interrupts stream |
| Backend | None required | service-ai (IAIService) |

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-chatbot)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,17 +386,6 @@ file system, …) per the protocol-agnostic architecture rule.
> dashboards. If you still want a browser-local cache for a demo, do it
> in the parent inside `onSchemaChange`.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-dashboard)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-designer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,17 +129,6 @@ const { zoom, pan, resetView } = useCanvasPanZoom();
import { ConfirmDialog, Minimap, PropertyEditor, VersionHistory } from '@object-ui/plugin-designer';
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-designer)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-detail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,17 +240,6 @@ shared draft (`InlineEditProvider` from `@object-ui/react`), committed by
gate `InlineEditProvider.canEdit` when the record is approval-locked, so a
locked record hides its edit affordances instead of rejecting at Save.

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-detail)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,17 +105,6 @@ pnpm build
# The package will generate proper ESM and UMD builds with lazy loading preserved
```

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-editor)
Expand Down
11 changes: 0 additions & 11 deletions packages/plugin-form/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,17 +357,6 @@ The plugin includes these field components:
- Date picker
- File upload

<!-- release-metadata:v3.3.0 -->

## Compatibility

- **React:** 18.x or 19.x
- **Node.js:** ≥ 18
- **TypeScript:** ≥ 5.0 (strict mode)
- **`@objectstack/spec`:** ^3.3.0
- **`@objectstack/client`:** ^3.3.0
- **Tailwind CSS:** ≥ 3.4 (for packages with UI)

## Links

- 📚 [Documentation](https://www.objectui.org/docs/plugins/plugin-form)
Expand Down
Loading