Typetable

Document API properties and types in a clean table format.

Usage

tsx

<TypeTable
  data={{
    title: { type: "string", required: true, description: "page title" },
    description: { type: "string", description: "page description" },
    order: { type: "number", default: "0", description: "sort order" },
  }}
/>

Example

prop	type	default
`title`	string	-
`description?`	string	-
`order?`	number	0

Click a row to expand the description.

Features

Shows property name, type, default, and description
Indicates required properties with ? marker
Expandable rows for descriptions
Clean compact design
Works in MDX

Props

prop	type	default
`data`	Record<string, TypeInfo>	-

Typeinfo

prop	type	default
`type`	string	-
`required?`	boolean	-
`default?`	string	-
`description?`	ReactNode	-

Document API properties and types in a clean table format.

Usage

tsx

<TypeTable
  data={{
    title: { type: "string", required: true, description: "page title" },
    description: { type: "string", description: "page description" },
    order: { type: "number", default: "0", description: "sort order" },
  }}
/>

Example

prop	type	default
`title`	string	-
`description?`	string	-
`order?`	number	0

Click a row to expand the description.

Features

Shows property name, type, default, and description
Indicates required properties with ? marker
Expandable rows for descriptions
Clean compact design
Works in MDX

Props

prop	type	default
`data`	Record<string, TypeInfo>	-

Typeinfo

prop	type	default
`type`	string	-
`required?`	boolean	-
`default?`	string	-
`description?`	ReactNode	-