Search documentation

Type to search.

Navigate · Enter to open · Esc to close

On this page
Settings
NameValue
timeout3000
retrytrue
View code
import Table from "@chitrank2050/monoline-docs/components/Table.astro";

<Table
  caption="Settings"
  columns={[
    { key: "name", label: "Name", format: "code" },
    { key: "value", label: "Value" },
  ]}
  rows={[
    { name: "timeout", value: 3000 },
    { name: "retry", value: true },
  ]}
/>

Usage

Import Table from @chitrank2050/monoline-docs/components/Table.astro. Column keys read values from each row. Labels and content are supplied by the author; props, variables, queries and other structured data use the same component. Set format: "code" for code cells. Missing and null values display an em dash.

Compact

Use variant="compact" when the content needs less cell padding. The default has the standard documentation spacing.

Compact settings
NameValueDescription
timeout3000Request timeout in milliseconds.
retrytrueRetry failed requests.
View code
import Table from "@chitrank2050/monoline-docs/components/Table.astro";

<Table
  caption="Compact settings"
  variant="compact"
  columns={[
    { key: "name", label: "Name", format: "code" },
    { key: "value", label: "Value" },
    { key: "description", label: "Description" },
  ]}
  rows={[
    {
      name: "timeout",
      value: 3000,
      description: "Request timeout in milliseconds.",
    },
    {
      name: "retry",
      value: true,
      description: "Retry failed requests.",
    },
  ]}
/>

Props reference

Use variant="reference" for technical fields. Define a Default column for props; use a Required column for type fields. Both use the same Table and visual variant.

Disclosure props
NameTypeDefaultDescription
openbooleanfalseWhether the disclosure starts expanded.
titlestring—The disclosure label.
View code
import Table from "@chitrank2050/monoline-docs/components/Table.astro";

<Table
  variant="reference"
  caption="Disclosure props"
  columns={[
    { key: "name", label: "Name", format: "code" },
    { key: "type", label: "Type", format: "code" },
    { key: "default", label: "Default", format: "code" },
    { key: "description", label: "Description" },
  ]}
  rows={[
    {
      name: "open",
      type: "boolean",
      default: "false",
      description: "Whether the disclosure starts expanded.",
    },
  ]}
/>

Type reference

Record fields
NameTypeRequiredDescription
idstringYesUnique record identifier.
labelstringNoOptional display label.
View code
import Table from "@chitrank2050/monoline-docs/components/Table.astro";

<Table
  variant="reference"
  caption="Record fields"
  columns={[
    { key: "name", label: "Name", format: "code" },
    { key: "type", label: "Type", format: "code" },
    { key: "required", label: "Required", format: "code" },
    { key: "description", label: "Description" },
  ]}
  rows={[
    {
      name: "id",
      type: "string",
      required: "Yes",
      description: "Unique record identifier.",
    },
  ]}
/>

API reference

Table props
NameTypeDescription
columns{ key, label, format? }[]Required. Unique keys, display labels and optional text/code format.
rowsRecord<string, Cell>[]Required. Cells accept strings, numbers, booleans, null or undefined.
captionstringRequired accessible table description.
variantdefault | compact | referenceDefault, compact spacing, or reference layout for technical fields.

Accessibility

The first column supplies row headings; column headings and captions use native table semantics. Overflow remains keyboard-scrollable. Cell content is escaped text.

Use this same component for API props, type fields and other tabular data by supplying the appropriate columns.