Products

Product details sidebar

The metadata rail on a product detail screen — price, dates, access.

Available

Needs mock props

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.

Product details sidebar

Rendered live from Storybook

Open

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
`product`*	`Product`	—	Undocumented — add TSDoc to the prop in the library.
`productIndex`	`number`	`0`	Position of the product in its list. Only used to space the fallback dates apart when the product carries no `createdAt` / `updatedAt`.
`layers`	`string[]`	`[]`	Layer names this product appears in. Replaces `useProductLayers().getProductLayers(id)`. Empty renders an em dash.
`tiers`	`ProductAccessTier[]`	`[]`	Access tiers, used to name the tier behind an "Included" product.
`status`	`ProductStatus`	`"Active"`	Publication state. Was derived from a hash of the product id — see below.
`lifetimeEarnings`	`number`	`0`	Gross lifetime revenue for this product, in whole currency units.
`lastUpdatedLabel`	`string`	—	Overrides the computed "Last updated" line.
`dateCreatedLabel`	`string`	—	Overrides the computed "Date created" line.
`now`	`Date`	`PRODUCT_DETAILS_DEFAULT_NOW`	Reference "today" for the date fallbacks.
`currencySymbol`	`string`	`"$"`	Prefix on money. BTS prices in AUD, hence the bare `$`.
`onEdit`	`() => void`	—	Edit was chosen from the overflow menu.
`defaultMenuOpen`	`boolean`	—	Uncontrolled seed for the overflow menu, so the open menu is a snapshot.
`menuOpen`	`boolean`	—	Controlled overflow menu state.
`onMenuOpenChange`	`(open: boolean) => void`	—	Undocumented — add TSDoc to the prop in the library.
`className`	`string`	—	Undocumented — add TSDoc to the prop in the library.

Reference

Transcribed from the component audit. If this disagrees with the source, the source is right.

Source: src/components/products/ProductDetailsSidebar.tsx
Portability: Needs its app dependencies replaced by props before it renders in isolation.
Notes: Takes a now value so relative dates hold still.