CmdocsComponents
TypeTable
Document props, configuration options, and API parameters.
TypeTable
TypeTable displays typed property documentation — great for documenting configuration options, component props, and API parameters.
Basic Usage
Prop
Type
<TypeTable
type={{
name: {
type: "string",
description: "The name of your documentation site.",
required: true,
},
description: {
type: "string",
description: "A short description for SEO meta tags.",
},
theme: {
type: "ThemeConfig",
description: "Theme configuration including colors and dark mode.",
},
}}
/>With Default Values
Use the default field to show what value a property uses when not specified.
Prop
Type
<TypeTable
type={{
darkMode: {
type: "boolean",
description: "Enable dark mode toggle.",
default: "true",
},
layout: {
type: "'docs' | 'notebook'",
description: "Page layout style.",
default: "'docs'",
},
}}
/>Complex Types
You can document complex or union types using string descriptions.
Prop
Type
Props
Prop
Type
How is this guide?