Components

Properties table

Document parameters and schema fields in tables.

Use PropertiesTable with PropertiesTable.Row children to document parameters, response fields, and component properties. Each row shows a name, type, and description, with optional required and deprecated badges.

Basic usage#

Name	Type	Description
idrequired	string	Unique identifier for the resource.
limit	integer	Maximum number of records to return. Default: 20

<PropertiesTable>
  <PropertiesTable.Row name="id" type="string" required>
    Unique identifier for the resource.
  </PropertiesTable.Row>
  <PropertiesTable.Row name="limit" type="integer" default="20">
    Maximum number of records to return.
  </PropertiesTable.Row>
</PropertiesTable>

Use separate headings and tables for headers, path parameters, query parameters, and cookies. For nested objects, place an Expandable containing another table inside a row's description.

Row properties#

Name	Type	Description
namerequired	string	Property or parameter name.
type	string \| number \| boolean \| null	Type label. HTML entities in string values are decoded before rendering.
default	string \| number \| boolean \| null	Default value, displayed below the description.
required	boolean	Shows a required badge. Default: false
deprecated	boolean	Shows a deprecated badge. Default: false
children	ReactNode	Property description and any nested content.

Inline parameter names#

Use Param to render inline parameter names as code:

Set limit and offset together for pagination.

Set <Param>limit</Param> and <Param>offset</Param> together for pagination.

Last updated on Sep 5, 2026

PreviousPanel NextSteps