Skip to content
Klarhimmel UI

Changelog, compact list

Changelog, compact list previewChangelog, compact list preview

Install

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

A dense changelog: one row per change with date, a tag in words and a title that links to the entry. For a sidebar-sized "what is new" or a page that lists many releases.

Import

Import

import Block from '@/components/klarhimmel/blocks/changelog-compact';
Also called
  • changelog/compact
About
A dense changelog: one row per change with date, a tag in words and a title that links to the entry. For a sidebar-sized "what is new" or a page that lists many releases. A link at the end goes to the full list.
Category
What changed and when: dated entries with tags, or a compact list. New project? Set it up once: /get-started/installation.

Notes

When to use it

A dense list of recent changes with one row each, for a sidebar-sized what-is-new or a page that lists many releases. When entries need a paragraph of explanation, use changelog-timeline.

Writing for it

- A row is a date of 20 characters, a tag of 16 and a title of 120 that links to the entry. Write the title as the change itself, in the past or present tense but not both. - Take three to ten rows. The final link goes to the full list, so label it with where it leads. - Keep dates short, such as 12 Jun, when the list is recent. Add the year once it spans more than one.

Watch out for

Each row title is the link, so two rows with the same title are indistinguishable to someone using a links list. Make every title unique.

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 ChangelogCompact from '@/components/klarhimmel/blocks/changelog-compact';

export default function Section() {
  return (
    <Theme theme="brand">
      <BlockSurface>
        <ChangelogCompact props={{
          "eyebrow": "Name the topic",
          "title": "Say what this lists",
          "description": "Say in one line what the list covers.",
          "rows": [
            {
              "date": "1 Jan",
              "tag": "Name a tag",
              "title": "Say what changed, in one short line",
              "href": "#e1"
            },
            {
              "date": "1 Jan",
              "tag": "Name a tag",
              "title": "Say what changed, in one short line",
              "href": "#e2"
            },
            {
              "date": "1 Jan",
              "tag": "Name a tag",
              "title": "Say what changed, in one short line",
              "href": "#e3"
            },
            {
              "date": "1 Jan",
              "tag": "Name a tag",
              "title": "Say what changed, in one short line",
              "href": "#e4"
            },
            {
              "date": "1 Jan",
              "tag": "Name a tag",
              "title": "Say what changed",
              "href": "#e5"
            }
          ],
          "more": {
            "label": "Second action",
            "href": "#history"
          }
        }} />
      </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'Name the topic'Text, up to 60 characters.
titlestring'Say what this lists'Text, up to 120 characters.
descriptionstring'Say in one line what the list cover…'Text, up to 300 characters.
rows{ date, tag, title, href }[]5 itemsList of 3 to 10. Each item: date, tag, title, href.
moreLink{…}See the type.
headingLevel'1' | '2'-One of '1', '2'. Optional; empty is not rendered.