Commerce
Transaction status badge
Succeeded, refunded, partially refunded or disputed, with an explanatory tooltip.
Available
Ports as-is
Examples
Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.
Transaction status badge
Rendered live from Storybook
Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.
Props
The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.
| Prop | Type | Default | Description |
|---|---|---|---|
status* | TransactionStatus | — | Undocumented — add TSDoc to the prop in the library. |
className | string | — | Undocumented — add TSDoc to the prop in the library. |
withTooltip | boolean | true | Wrap the pill in a tooltip explaining what the status means. |
tooltipOpen | boolean | — | Design-system escape hatch: force the tooltip open (or closed) so the revealed state is a static story rather than a hover path. |
Reference
Transcribed from the component audit. If this disagrees with the source, the source is right.
- Source
src/components/transactions/TransactionStatusBadge.tsx- Portability
- Copies across unchanged — only the utils import path moves.
- Notes
- Its colours are stock Tailwind palette values (emerald / red), not --success / --destructive, so it will not follow either token.