Skip to content
Klarhimmel UI

Price list

Price list previewPrice list preview

Install

npx shadcn add https://ui.klarhimmel.com/r/price-list.json
DetailsAbout, usage, props and more

A menu or a list of services with prices: named groups (with an optional note such as serving hours), each item a name, a dotted leader and a price on one line, a short…

Import

Import

import Block from '@/components/klarhimmel/blocks/price-list';
Also called
  • pricing/list
About
A menu or a list of services with prices: named groups (with an optional note such as serving hours), each item a name, a dotted leader and a price on one line, a short description and up to three tags.
Category
Plans and prices: tiers, a single plan, a toggle or a comparison table. New project? Set it up once: /get-started/installation.

Notes

When to use it

A menu or a list of services where each line is one thing with one price: a café or restaurant menu, a bakery's loaves, a salon's or barber's services, class passes. Use pricing-tiers or pricing-rows for plans someone signs up to.

Writing for it

- Group by what a visitor looks for first (Breakfast, Lunch; Cuts, Colour) and put serving hours or a duration in the group note, 120 characters. - Write the price as it is said at the counter, without a currency on every line ('9.50'), and name the currency once in the note under the list. - Tags hold 24 characters and at most three per item, for facts that decide an order such as Vegan, New or 45 min. Leave them empty otherwise.

Watch out for

An item without a price keeps its dotted leader short and shows no number, which reads as 'ask'; say so in the description. Groups sit two to a row, and three to a row in very wide containers when there are 3, 5 or 6 of them; a single group spans the full width, so give it a second group or keep it short.

Usage

The block in a page, with its default content (long lists shortened). Every prop is in the table below.

section.tsx
import { Theme } from '@/components/klarhimmel/theme/style';
import { BlockSurface } from '@/components/klarhimmel/blocks/surface';
import PriceList from '@/components/klarhimmel/blocks/price-list';

export default function Section() {
  return (
    <Theme theme="brand">
      <BlockSurface>
        <PriceList props={{
          "eyebrow": "Section name",
          "title": "Say what the list covers",
          "description": "Say in a sentence or two how the items are made or served, and what to ask abou…",
          "groups": [
            {
              "title": "First group",
              "note": "Say when it is available",
              "items": [
                {
                  "name": "Name the first item",
                  "description": "Say what it is made of, in a short line.",
                  "price": "00.00",
                  "tags": [
                    "A tag"
                  ]
                }
              ]
            }
          ],
          "note": "Say what the prices include or exclude.",
          "link": {
            "label": "",
            "href": ""
          }
        }} />
      </BlockSurface>
    </Theme>
  );
}

Props

The type, default and text limit of every prop. On a real page, over-limit text is kept and checkSections flags it (Installation, Check a page before you ship); this live preview shows the default until it fits. The panel above edits all props.

PropTypeDefaultDescription
eyebrowstring'Section name'Text, up to 60 characters.
titlestring'Say what the list covers'Text, up to 120 characters.
descriptionstring'Say in a sentence or two how the it…'Text, up to 300 characters.
groups{ title, note, items }[]3 itemsList of 1 to 6. Each item: title, note, items.
notestring'Say what the prices include or excl…'Text, up to 200 characters.
linkLink{…}Optional; empty is not rendered.
headingLevel'1' | '2'-One of '1', '2'. Optional; empty is not rendered.