Properties

Build a compact, consistent API reference for an MDX component.

colorstringrequired

The accent colour used by the component.

<Properties>
<Property name="color" required type="string">
  The accent colour used by the component.
</Property>
</Properties>

Properties groups Property entries into a concise API reference. It gives each prop a clear name, type, required state, and explanation, so reference sections stay consistent across all component pages.

Document the API that readers use

Use one Property per public prop. Mark required values explicitly and explain defaults, precedence rules, or constraints in the description. The badges prop is useful for short metadata such as a version or platform note.

theme"light" | "dark"optionalv2.0

Chooses the appearance. It defaults to light.

tokenstring

An access token. The required badge is hidden because the surrounding text already communicates the requirement.

Use normal Markdown headings and prose for the conceptual explanation; reserve this component for the final, scannable prop reference.

Describe a rollout policy

Mix required state, version metadata, and rich descriptions to make a compact reference section feel more like a useful API contract.

strategy"preview" | "instant"requiredv2.4

Use preview to require a final approval before publishing.

reviewersstring[]optional

The people who receive the preview link. It defaults to an empty list.

notifybooleanoptional

Sends a completion message to each reviewer. It defaults to true.

<Properties>
<Property
  badges={<Badge variant="outline">v2.4</Badge>}
  name="strategy"
  required
  type='"preview" | "instant"'
>
  Use <code>preview</code> to require a final approval before publishing.
</Property>
<Property name="reviewers" type="string[]">
  The people who receive the preview link. It defaults to an empty list.
</Property>
<Property name="notify" type="boolean">
  Sends a completion message to each reviewer. It defaults to <code>true</code>.
</Property>
</Properties>

Properties

childrenReactNodeoptional

The Property entries rendered in the reference section.

classNamestringoptional

Extra classes applied to the outer Properties section.

nameReactNoderequired

A Property name, usually the public prop name.

typeReactNodeoptional

An optional type label displayed next to the property name.

requiredbooleanoptional

Marks a Property as required. It defaults to false.

showRequiredbooleanoptional

Shows the required or optional state badge. It defaults to true.

badgesReactNodeoptional

Additional inline badges displayed beside the property's type and state.

childrenReactNodeoptional

The explanatory content for an individual Property.

classNamestringoptional

Extra classes applied to an individual Property entry.