Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

Result

A checkout outcome with a meaningful next action.

Preview

Live preview

Changes apply to this preview only.

Checkout

A success screen that confirms the order and gives one obvious next step.

Order confirmed

Order #4822 is being prepared. A confirmation was sent to amelie@example.com.

Payment

The error variant is announced immediately and offers a way to recover.

Maintenance

A warning result explains a temporary limitation without treating it as a failure.

Read-only mode

We are migrating the database. You can browse everything, but changes are paused until 04:00 UTC.

Invitation

A neutral information result for an expired link.

This invitation has expired

Ask an administrator to send a new invitation; the workspace has not changed.

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.

Statuses

The status drives the icon surface, the accent and the live role.

Open preview

With actions

Primary and secondary actions sit under the description.

Open preview

Checkout

A checkout composition using Result.

Open preview

Usage

Differentiate success, pending and failure using explicit text and useful recovery paths.

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.

PimoluResultProps

Type source
PimoluResultProps public API
NameTypeDefaultDescription
status"success" | "warning" | "error" | "info" | undefined"info"Outcome conveyed by the screen.
titleRequiredReactNode—Prominent outcome heading.
descriptionReactNode—Optional supporting text.
iconReactNode—Decorative status icon, hidden from assistive technology.
actionsReactNode—Primary and secondary actions.
onChangeChangeEventHandler<HTMLDivElement, Element> | undefined—Standard React/HTML attribute.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
classNamestring | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
onClickMouseEventHandler<HTMLDivElement> | undefined—Standard React/HTML attribute.
status

"success" | "warning" | "error" | "info" | undefined

Default: "info"

Outcome conveyed by the screen.

titleRequired

ReactNode

No default extracted.

Prominent outcome heading.

description

ReactNode

No default extracted.

Optional supporting text.

icon

ReactNode

No default extracted.

Decorative status icon, hidden from assistive technology.

actions

ReactNode

No default extracted.

Primary and secondary actions.

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.

className

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.

onClick

MouseEventHandler<HTMLDivElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • Keep outcome text readable without color or icon recognition.
Read the accessibility guide →