Skip to content

docs(plugin-dashboard): teach the adapter as renderer context, not a schema key (objectui#8468) #8857

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.

Sign up for GitHub

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
os-zhuang merged 2 commits into from
Sep 9, 2026
+42 −8
Merged

docs(plugin-dashboard): teach the adapter as renderer context, not a schema key (objectui#8468) #8857

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f455b8
docs(plugin-dashboard): teach the adapter as renderer context, not a …
claude Sep 9, 2026
2231007
docs(plugin-dashboard): split the provider wiring into its own fence …
claude Sep 9, 2026
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
50 changes: 42 additions & 8 deletions packages/plugin-dashboard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,17 +271,19 @@ it has no row in the spec's expression carriage map, so a `${…}` written in
read live data is one of the `object-*` types above — they resolve the spec's
per-element `dataSource` binding and query the object themselves.

```typescript
import { createObjectStackAdapter } from '@object-ui/data-objectstack';
**The adapter is not a schema key.** A schema is a serialisable document; a live
adapter is an object with methods, so it cannot travel in one. An `object-*`
widget reads its adapter from React context — `useContext(SchemaRendererContext)`
at `src/ObjectMetricWidget.tsx:159`, with an explicit `dataSource` prop taking
precedence when the host renders the widget directly.

const dataSource = createObjectStackAdapter({
baseUrl: 'https://api.example.com',
token: 'your-auth-token'
});
So the document stays plain data — every value in it survives `JSON.stringify`:

const schema = {
```typescript
import type { DashboardComponentSchema } from '@object-ui/types';

const schema: DashboardComponentSchema = {
type: 'dashboard',
dataSource,
widgets: [
{
type: 'metric-card',
Expand All @@ -293,6 +295,38 @@ const schema = {
};
```

The adapter is installed once, above the whole tree, and every `object-*` widget
underneath reads it from context:

```tsx
import { SchemaRendererProvider, SchemaRenderer } from '@object-ui/react';
import { createObjectStackAdapter } from '@object-ui/data-objectstack';
import '@object-ui/plugin-dashboard';
import type { DashboardComponentSchema } from '@object-ui/types';

// The document from the block above.
declare const schema: DashboardComponentSchema;

const dataSource = createObjectStackAdapter({
baseUrl: 'https://api.example.com',
token: 'your-auth-token'
});

export const App = () => (
<SchemaRendererProvider dataSource={dataSource}>
<SchemaRenderer schema={schema} />
</SchemaRendererProvider>
);
```

> A `dataSource` key **does** mean something on a schema node, but it is not this:
> it is the spec's element **binding** (`PageComponentSchema.dataSource`) — a
> declarative descriptor such as `{ object: 'orders', view: 'my_view' }`, resolved
> against the host and mapped onto the widget's own keys by the `object-*`
> registry shells in `src/index.tsx`. It belongs on the widget that reads it, not
> on the dashboard node, and a live adapter written into that slot wires nothing
> up — it is a different kind of thing wearing the same name.

## Dashboard-level filters

A dashboard can declare top-level filters — a date range and any number of
Expand Down