Skip to main content

Interface: FieldHint

Defined in: packages/core/src/catalog.types.ts:33

How an editing surface should treat one field of a block's schema. core reads data and decides nothing else about the field.

Example​

import type { FieldHint } from "@nubbin/core";

const live: FieldHint = { data: { revalidate: 5 } };
const frozen: FieldHint = {};

Properties​

control?​

optional control?: string

Defined in: packages/core/src/catalog.types.ts:45

Names the control an editing surface renders for the field — "link" for a string holding a destination. Core validates the path and reads nothing else: an unrecognised name falls back to the field's kind, so a hint never breaks an editor that predates it.

data?​

optional data?: FieldHintData

Defined in: packages/core/src/catalog.types.ts:39

Marks the field as resolved at render rather than frozen at compile. Legal only on a path addressing a single value — a path containing [], or one nesting inside another data path, fails registration.