AI agents: fetch the documentation index at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.
Type table
Display structured property and type reference tables.
Use the TypeTable component to document object shapes, API responses, and component props in a structured table.
Basic usage
Pass a type object where each key is a field name and the value describes its type, description, and constraints:
<TypeTable
type={{
id: {
description: "Unique project identifier.",
type: "string",
required: true,
},
name: {
description: "Display name of the project.",
type: "string",
required: true,
},
slug: {
description: "URL-safe project slug.",
type: "string",
required: true,
},
customDomain: {
description: "Custom domain if configured.",
type: "string",
required: false,
},
createdAt: {
description: "ISO 8601 timestamp of project creation.",
type: "string",
required: true,
},
}}
/>With default values
When any field includes a default property, a Default column appears automatically:
<TypeTable
type={{
appearance: {
description: "Initial color mode for the site.",
type: '"system" | "light" | "dark"',
default: '"system"',
required: false,
},
lang: {
description: "Default language for code blocks.",
type: "string",
default: '"plaintext"',
required: false,
},
toc: {
description: "Show a table of contents on each page.",
type: "boolean",
default: "true",
required: false,
},
}}
/>Field options
Each field in the type object supports these properties: