Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

ApiTable

A compact reference of property contracts.

Preview

Live preview

Changes apply to this preview only.

Button
Every prop accepted by Button, with its type and default value.
NameTypeDefaultDescription
variant"primary" | "secondary" | "danger""primary"Semantic colour of the action. It maps to the same token in every preset.
appearance"solid" | "soft" | "outline" | "ghost" | "glass""solid"Visual weight of the button without changing its meaning.
size"xs" | "sm" | "md" | "lg" | "xl" | "xxl""md"Control height and horizontal padding. md matches the default form controls.
childrenRequiredReactNode—Visible label. Provide an aria-label instead when the button is icon-only.
loadingbooleanfalseShows a spinner, disables the control and sets aria-busy.
startIconReactNode—Decorative icon rendered before the label; it is hidden from assistive technology.
onClick(event: MouseEvent) => void—Native click handler. The button does not intercept the event.
fullWidthbooleanfalseStretches the button to the inline size of its container.
iconOnlyDeprecatedbooleanfalseUse the icon-only variant instead. The prop remains for one major version.

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Compact reference

density sm tightens the row padding for a reference that sits next to other content.

Open preview

Deprecated props

Deprecated rows keep their description and receive a badge; the name is struck through so the migration is visible in a diff.

Open preview

Empty reference

An empty rows array renders a single full-width cell instead of an empty table body.

Open preview

Usage

Provide accurate types, defaults and descriptions; an empty default is not proof of runtime behavior.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluApiTableRow

Type source
PimoluApiTableRow public API
NameTypeDefaultDescription
nameRequiredstring—Prop, token or event name.
typeRequiredReactNode—Accepted type, rendered as code.
defaultReactNode—Default value, rendered as code. Omit when there is none.
requiredboolean | undefined—Marks the row as required with a visible badge.
descriptionRequiredReactNode—Description of the row.
deprecatedboolean | undefined—Marks the row as deprecated with a visible badge.
nameRequired

string

No default extracted.

Prop, token or event name.

typeRequired

ReactNode

No default extracted.

Accepted type, rendered as code.

default

ReactNode

No default extracted.

Default value, rendered as code. Omit when there is none.

required

boolean | undefined

No default extracted.

Marks the row as required with a visible badge.

descriptionRequired

ReactNode

No default extracted.

Description of the row.

deprecated

boolean | undefined

No default extracted.

Marks the row as deprecated with a visible badge.

PimoluApiTableProps

Type source
PimoluApiTableProps public API
NameTypeDefaultDescription
rowsRequiredPimoluApiTableRow[]—Public Pimolu prop; see the source declaration for details.
titleReactNode—Optional title displayed above the table.
captionReactNode—Optional caption attached to the table element.
densityPimoluApiTableDensity | undefined"md"Row density. Defaults to "md".
emptyMessageReactNode"No API entries."Message shown when rows is empty. Defaults to "No API entries."
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
onChangeChangeEventHandler<HTMLDivElement, Element> | undefined—Standard React/HTML attribute.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
childrenReactNode—Standard React/HTML attribute.
onClickMouseEventHandler<HTMLDivElement> | undefined—Standard React/HTML attribute.
rowsRequired

PimoluApiTableRow[]

No default extracted.

Public Pimolu prop; see the source declaration for details.

title

ReactNode

No default extracted.

Optional title displayed above the table.

caption

ReactNode

No default extracted.

Optional caption attached to the table element.

density

PimoluApiTableDensity | undefined

Default: "md"

Row density. Defaults to "md".

emptyMessage

ReactNode

Default: "No API entries."

Message shown when rows is empty. Defaults to "No API entries."

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

onChange

ChangeEventHandler<HTMLDivElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

children

ReactNode

No default extracted.

Standard React/HTML attribute.

onClick

MouseEventHandler<HTMLDivElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • Keep row/column headings and contained scrolling available on small screens.
Read the accessibility guide →