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 in the row’s details prop. Details render below the property in a row spanning all three columns.

Nested properties#

Expand or collapse the address details below. The nested table spans the full width, and the following property returns to the normal three-column layout. The id row also shows a simple union inline.

Name

Type

Description

idrequired

string | number

A resource identifier accepting either a string or a number.

address

object

Mailing address for the resource.

Name	Type	Description
cityrequired	string	City name.
postalCode	string	Postal or ZIP code.

createdAt

string

Date and time when the resource was created.

<PropertiesTable>
  <PropertiesTable.Row name="id" type="string | number" required>
    A resource identifier accepting either a string or a number.
  </PropertiesTable.Row>
  <PropertiesTable.Row
    name="address"
    type="object"
    details={
      <Expandable title="properties" defaultOpen>
        <PropertiesTable>
          <PropertiesTable.Row name="city" type="string" required>
            City name.
          </PropertiesTable.Row>
          <PropertiesTable.Row name="postalCode" type="string">
            Postal or ZIP code.
          </PropertiesTable.Row>
        </PropertiesTable>
      </Expandable>
    }
  >
    Mailing address for the resource.
  </PropertiesTable.Row>
  <PropertiesTable.Row name="createdAt" type="string">
    Date and time when the resource was created.
  </PropertiesTable.Row>
</PropertiesTable>

Allowed types#

For complex alternatives, use an “Allowed types” expandable. Generated API docs use this label for oneOf and anyOf schemas with detailed alternatives.

Name

Type

Description

recipientrequired

oneOf

Select one of the supported recipient formats.

Name	Type	Description
User ID	string	Reference an existing user by their identifier.
New recipient	object	Supply contact details for a new recipient.

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
details	ReactNode	Expandable details rendered in a full-width row below the property.
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 27, 2026

Edit this page

PreviousPanel NextSteps