Field
Document API properties, configuration keys, or schema definitions inline with the Field component.
The <Field> component is a clean way to document specific settings, configuration parameters, or API properties. It renders a clean border, monospace parameter details, type tags, and indicators that show whether the parameter is required.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
name | string | Required | The name of the property, variable, or option in monospace code style. |
type | string | undefined | The type representation of the property (e.g. 'string', 'number', 'boolean'). |
required | boolean | false | When true, shows a red 'required' tag next to the type. |
description | string | undefined | Optional summary text. You can also pass the description directly as children for formatted content. |
children | ReactNode | undefined | The body description explaining what the field is for. |
Last updated on October 18, 2026
