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
4 changes: 4 additions & 0 deletions content/docs/core/app-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ const app: AppComponentSchema = {

## Properties

The tables in this section describe `AppComponentSchema`, declared by
`@object-ui/types` (`packages/types/src/app.ts`). They group its properties by
topic; the declaration remains the complete list.

### Basic Configuration

| Property | Type | Description |
Expand Down
5 changes: 5 additions & 0 deletions content/docs/core/report-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ const salesReport: ReportComponentSchema = {

## Properties

The tables in this section describe `ReportComponentSchema`, declared by
`@object-ui/types` (`packages/types/src/reports.ts`) and imported by name in the
example above. They group its properties by topic; the declaration remains the
complete list.

### Basic Configuration

| Property | Type | Description |
Expand Down
4 changes: 3 additions & 1 deletion content/docs/guide/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,9 @@ would be the same "validates, then does nothing" shape this whole area is about.

## Configuring the system

`NotificationProvider`'s `config` is the spec `NotificationConfigSchema`:
`NotificationProvider`'s `config` is `NotificationSystemConfig`, declared by
`@object-ui/react` (`packages/react/src/context/NotificationContext.tsx`) and
normalized by `resolveNotificationConfig`:

| Key | Default | Effect |
|---|---|---|
Expand Down
6 changes: 5 additions & 1 deletion content/docs/plugins/plugin-charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,11 @@ const schema = {
}
```

### Properties
### BarChartSchema

Declared by `@object-ui/plugin-charts` (`packages/plugin-charts/src/types.ts`).
It extends `BaseSchema`, so the shared component properties are available on a
`bar-chart` node as well as the ones below.

| Property | Type | Default | Description |
|----------|------|---------|-------------|
Expand Down
6 changes: 5 additions & 1 deletion content/docs/plugins/plugin-editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ const schema = {
}
```

### Properties
### CodeEditorSchema

Declared by `@object-ui/plugin-editor` (`packages/plugin-editor/src/types.ts`).
It extends `BaseSchema`, so the shared component properties are available on a
`code-editor` node as well as the ones below.

| Property | Type | Default | Description |
|----------|------|---------|-------------|
Expand Down
8 changes: 7 additions & 1 deletion content/docs/plugins/plugin-markdown.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,13 @@ const schema = {
}
```

### Properties
### MarkdownSchema

Declared by `@object-ui/plugin-markdown`
(`packages/plugin-markdown/src/types.ts`) — the plugin ships its own copy of
this name, so read it there rather than the same-named interface in
`@object-ui/types`. It extends `BaseSchema`, so the shared component properties
are available on a `markdown` node as well as the ones below.

| Property | Type | Default | Description |
|----------|------|---------|-------------|
Expand Down
4 changes: 4 additions & 0 deletions content/docs/plugins/plugin-report.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ shape.

## The authoring shape

The authoring shape is `Report`, declared by `@objectstack/spec/ui`
(`ReportSchema`) and shipped as `json-schema/ui/Report.json` — the same
declaration `defineReport` validates against.

| Key | Type | Meaning |
| --------------- | --------------------------------- | ------------------------------------------------------------------------------ |
| `name` | `string` (required) | Identifier, at least 2 characters. |
Expand Down