Expandables

Use the expandable component to toggle nested object properties in API documentation, showing child fields for request and response objects.

Use expandables to show and hide nested content within response fields. They are particularly useful for displaying complex object properties in API documentation.

• user (User Object)

<ResponseField name="user" type="User Object">
  <Expandable title="properties">
    <ResponseField name="full_name" type="string">
      The full name of the user
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      Whether the user is over 21 years old
    </ResponseField>
  </Expandable>
</ResponseField>

• title (string) — The name of the object you are showing.

• defaultOpen (boolean) — Set to true for the expandable to open when the page loads.

• className (string) — Additional CSS classes to apply to the expandable.

• Format code
• Components overview
• Accordions