ui/build/data-renderer/data-renderer.types

Interfaces

DataRendererProps

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:33

The public strategy-router contract.

Omit renderer for automatic relationship/datatype routing. Supplying it is the one explicit override path; rendererProps carries only renderer-specific configuration while the router continues to own field state and the standard control frame.

Extends

• FieldRendererProps

Properties

class?

optional class?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:18

Inherited from

FieldRendererProps.class

disabled?

optional disabled?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:9

Inherited from

FieldRendererProps.disabled

field

field: CollectionField;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:5

Inherited from

FieldRendererProps.field

id?

optional id?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:7

Inherited from

FieldRendererProps.id

locale?

optional locale?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:17

Inherited from

FieldRendererProps.locale

mode?

optional mode?: "display" | "edit";

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:8

Inherited from

FieldRendererProps.mode

onPendingChange?

optional onPendingChange?: (pending) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:13

Prevent submission while this control is still preparing its value (for example, an upload).

Parameters

Parameter	Type
pending	boolean

Returns

void

Inherited from

FieldRendererProps.onPendingChange

onRowChange?

optional onRowChange?: (patch) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:16

Parameters

Parameter	Type
patch	Record<string, unknown>

Returns

void

Inherited from

FieldRendererProps.onRowChange

onValueChange?

optional onValueChange?: (value) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:11

Parameters

Parameter	Type
value	unknown

Returns

void

Inherited from

FieldRendererProps.onValueChange

placeholder?

optional placeholder?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:10

Inherited from

FieldRendererProps.placeholder

relationOptions?

optional relationOptions?: CollectionRelationOptions<CollectionRecord>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:37

Contextual option-set configuration for the automatic relationship strategy.

renderer?

optional renderer?: FieldRendererComponent;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:34

rendererProps?

optional rendererProps?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:35

row?

optional row?: Record<string, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:15

Full matrix/form row when the renderer needs sibling fields.

Inherited from

FieldRendererProps.row

value

value: unknown;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:6

Inherited from

FieldRendererProps.value

---

FieldRendererProps

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:4

Props every datatype renderer receives from the strategy router.

Extended by

• DataRendererProps
• FormattedValueRendererProps

Properties

class?

optional class?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:18

disabled?

optional disabled?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:9

field

field: CollectionField;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:5

id?

optional id?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:7

locale?

optional locale?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:17

mode?

optional mode?: "display" | "edit";

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:8

onPendingChange?

optional onPendingChange?: (pending) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:13

Prevent submission while this control is still preparing its value (for example, an upload).

Parameters

Parameter	Type
pending	boolean

Returns

void

onRowChange?

optional onRowChange?: (patch) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:16

Parameters

Parameter	Type
patch	Record<string, unknown>

Returns

void

onValueChange?

optional onValueChange?: (value) => void;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:11

Parameters

Parameter	Type
value	unknown

Returns

void

placeholder?

optional placeholder?: string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:10

row?

optional row?: Record<string, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:15

Full matrix/form row when the renderer needs sibling fields.

value

value: unknown;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:6

Type Aliases

FieldRendererCallerProps

type FieldRendererCallerProps<TRendererProps> = Omit<TRendererProps, keyof FieldRendererProps>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:25

Props a template may configure after the strategy router injects the standard field context.

Type Parameters

Type Parameter
TRendererProps

---

FieldRendererComponent

type FieldRendererComponent = Component<never>;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:21

A template-selected datatype renderer. Its concrete props are inferred at the authored callsite.

---

FieldRendererPropsOf

type FieldRendererPropsOf<TRenderer, TFallback> = TRenderer extends Component<infer TProps> ? TProps extends never ? TFallback : TProps : TFallback;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:23

Resolve the concrete props of a template-selected renderer, with a surface-specific fallback.

Type Parameters

Type Parameter	Default type
TRenderer	-
TFallback extends FieldRendererProps	FieldRendererProps