TypeTable
TypeTable renders a compact four-column table : Prop, Type, Default, Description : with a Required chip on rows that need it. It's the primitive every "Props" or "API" section on this site is built with.
Basic use
| Prop | Type | Default | Description |
|---|---|---|---|
Variant |
string |
"info" |
One of info | tip | success | warning | danger. |
Title |
string? |
— |
Optional title above the body. |
ChildContent |
RenderFragment? |
— |
Body content. |
<TypeTable>
<TypeRow Name="Variant" Type="string" Default='"info"' Description="One of info | tip | success | warning | danger." />
<TypeRow Name="Title" Type="string?" Default="—" Description="Optional title above the body." />
<TypeRow Name="ChildContent" Type="RenderFragment?" Default="—" Description="Body content." />
</TypeTable>Required rows
Set Required="true" on a TypeRow to add the "Required" chip next to the prop name.
| Prop | Type | Default | Description |
|---|---|---|---|
HrefRequired |
string |
"#" |
Link target. Required : LinkCard is always a link. |
Title |
string? |
— |
Title, bold, primary color. |
External |
bool |
false |
Opens in a new tab when true. |
<TypeTable>
<TypeRow Name="Href" Type="string" Default='"#"' Required="true" Description="Link target. Required : LinkCard is always a link." />
<TypeRow Name="Title" Type="string?" Default="—" Description="Title, bold, primary color." />
<TypeRow Name="External" Type="bool" Default="false" Description="Opens in a new tab when true." />
</TypeTable>Not-just-for-props
The columns are labeled Prop / Type / Default / Description but nothing forces "type" to be a C# type. Use it wherever a four-column labelled-list would help : CLI commands, package families, framework primitives.
| Prop | Type | Default | Description |
|---|---|---|---|
init |
command |
— | Scaffold a fresh ShellDocs site OR augment an existing Blazor project. |
add |
command |
— | Scaffold a starter .md page from a template. |
dev |
command |
— | Start the dev server with hot-reload. |
build |
command |
— | Publish a static site. |
<TypeTable>
<TypeRow Name="init" Type="command" Description="Scaffold a fresh ShellDocs site OR augment an existing Blazor project." />
<TypeRow Name="add" Type="command" Description="Scaffold a starter .md page from a template." />
<TypeRow Name="dev" Type="command" Description="Start the dev server with hot-reload." />
<TypeRow Name="build" Type="command" Description="Publish a static site." />
</TypeTable>Rows with the same name
Rows are independent, so two can share a Name : overloads of a method, or one option described for two cases.
| Prop | Type | Default | Description |
|---|---|---|---|
SetLogo(url) |
method |
— | One image for both themes. |
SetLogo(light, dark) |
method |
— | An image per theme. |
Layout |
fence |
— | Set in the fence info string. |
Layout |
tag |
— | Set with the Layout attribute. |
<TypeTable>
<TypeRow Name="SetLogo(url)" Type="method" Description="One image for both themes." />
<TypeRow Name="SetLogo(light, dark)" Type="method" Description="An image per theme." />
<TypeRow Name="Layout" Type="fence" Description="Set in the fence info string." />
<TypeRow Name="Layout" Type="tag" Description="Set with the Layout attribute." />
</TypeTable>Empty state
If you render a TypeTable with no rows, it emits a single "No props documented." row rather than an empty grid : keeps the layout stable.
How it works
TypeRow doesn't render its own markup : it registers itself with the parent TypeTable via a cascading parameter in OnInitialized. The parent collects the row info and renders the table body. Consequence: rows must be direct children of TypeTable : wrapping them in a <div> breaks the cascading resolution.
Props
TypeTable
| Prop | Type | Default | Description |
|---|---|---|---|
ChildContent |
RenderFragment? |
— |
The TypeRow children. Must be direct descendants. |
TypeRow
| Prop | Type | Default | Description |
|---|---|---|---|
NameRequired |
string |
— | First column : prop / command / key name. Rendered as inline code. |
Type |
string |
— | Second column : type / category. Rendered as inline code when set, em-dash otherwise. |
Default |
string? |
— |
Third column : default value or fallback. Em-dash when empty. |
Description |
string? |
— |
Fourth column : free-text description. |
Required |
bool |
false |
When true, appends a Required chip to the Name cell. |