Skip to content

docs(fields): correct the four Cell Renderer imports and bring the blocks under the type gate#6119

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
yinlianghui-tw merged 1 commit into from
Aug 24, 2026
Merged

docs(fields): correct the four Cell Renderer imports and bring the blocks under the type gate #6119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions content/docs/fields/grid.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,12 +158,16 @@ const gridValue = [

## Cell Renderer

In tables/grids, displays row count:
In tables/grids, a `grid` value is shown as a compact placeholder, not as a
nested table. It has no named renderer export of its own — the component is
resolved by field type, which is the supported path for every type:

```plaintext
import { GridCellRenderer } from '@object-ui/fields';
```ts
import { getCellRenderer } from '@object-ui/fields';

const GridCell = getCellRenderer('grid');

// Renders: "5 rows"
// <GridCell value={rows} field={field} /> renders: [Grid]
```

## Full Grid Functionality
Expand Down
12 changes: 8 additions & 4 deletions content/docs/fields/object.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,16 @@ The object field stores data as parsed JSON:

## Cell Renderer

In tables/grids, displays formatted JSON preview:
In tables/grids, an `object` value is rendered by the JSON cell renderer —
`getCellRenderer('object')` resolves to this same component, shared with `json`,
`composite` and `record`:

```plaintext
import { ObjectCellRenderer } from '@object-ui/fields';
```ts
import { JsonCellRenderer } from '@object-ui/fields';

// Shows: [Object] or truncated JSON in read-only mode
// <JsonCellRenderer value={specs} field={field} /> renders single-line JSON,
// truncated to the column width with the full text in the cell's `title`.
// A null or empty value renders an em-dash instead.
```

## Schema Validation
Expand Down
11 changes: 7 additions & 4 deletions content/docs/fields/summary.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,12 +99,15 @@ interface SummaryFieldSchema {

## Cell Renderer

In tables/grids, displays with tabular numbers:
In tables/grids, a `summary` value is rendered by the formula cell renderer —
`getCellRenderer('summary')` resolves to this same component:

```plaintext
import { SummaryCellRenderer } from '@object-ui/fields';
```ts
import { FormulaCellRenderer } from '@object-ui/fields';

// Renders: 15,750.50 (formatted with proper precision)
// <FormulaCellRenderer value={15750.5} field={field} /> renders the computed
// value as monospace text: 15750.5
// A null or empty value renders an em-dash instead.
```

## Backend Implementation
Expand Down
12 changes: 8 additions & 4 deletions content/docs/fields/vector.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,12 +67,16 @@ const embedding: number[] = [

## Cell Renderer

In tables/grids, displays compact preview:
In tables/grids, a `vector` value is shown as a compact placeholder, not as its
components. It has no named renderer export of its own — the component is
resolved by field type, which is the supported path for every type:

```plaintext
import { VectorCellRenderer } from '@object-ui/fields';
```ts
import { getCellRenderer } from '@object-ui/fields';

const VectorCell = getCellRenderer('vector');

// Renders: [0.1234, -0.5678, 0.9012...] (768D)
// <VectorCell value={embedding} field={field} /> renders: [Vector]
```

## Vector Operations
Expand Down