# Changelog, timeline

- **[Sections](/blocks/)**
- **[Changelog](/blocks/changelog/)**
- **Changelog, timeline**

A changelog as a vertical timeline: each entry has a date (with an optional version), a title, a paragraph, tags in words and a short list of changes.

## Import

- **CLI**

  ```
  npx shadcn add https://ui.klarhimmel.com/r/changelog-timeline.json
  ```
- **Import**

  ```
  import Block from '@/components/klarhimmel/blocks/changelog-timeline';
  ```

Also called

- changelog/timeline

- **About**: A changelog as a vertical timeline: each entry has a date (with an optional version), a title, a paragraph, tags in words and a short list of changes. Entries are articles with the date as a time heading.
- **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 release history told as a vertical timeline, for a changelog page where each change deserves a paragraph. For a short what-is-new strip, `changelog-compact` is lighter.
- **Writing for it**: - Each entry takes a date written as you want it shown, an optional version of 12 characters, a body of 300 and up to five bullet changes. Newest first reads best.
- Tags are words such as New or Fix, up to three per entry. They are never colour alone, so keep them to one word.
- The block holds two to six entries. Link the rest through the closing link instead of adding a long tail here.
- **Watch out for**: Every entry is an article with its date as a time heading. Dates are plain text, so keep one format across entries or the timeline reads as unsorted.

## Pairs well with

- **[Hero, minimal](/blocks/hero/minimal)**
- **[Changelog, compact list](/blocks/changelog/compact)**
- **[Call to action, minimal](/blocks/cta/minimal)**

## 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 ChangelogTimeline from '@/components/klarhimmel/blocks/changelog-timeline';

export default function Section() {
  return (
    <Theme theme="brand">
      <BlockSurface>
        <ChangelogTimeline props={{
          "eyebrow": "Name the topic",
          "title": "Say what the list shows",
          "description": "Say in one or two sentences how the list is ordered and grouped.",
          "entries": [
            {
              "date": "00 Month 0000",
              "version": "2.4",
              "title": "Name the change",
              "tags": [
                "Name a tag"
              ],
              "body": "Say in one or two sentences what changed and what difference it makes to them.",
              "changes": [
                "Name a first detail of the change, in a line",
                "Name a second detail of the change"
              ]
            },
            {
              "date": "00 Month 0000",
              "version": "2.3",
              "title": "Name the change",
              "tags": [
                "Name a tag",
                "Name a tag"
              ],
              "body": "Say in one or two sentences what changed and what difference it makes, and what else was fixed.",
              "changes": [
                "Name a first detail of the change",
                "Name a second detail of the change"
              ]
            }
          ],
          "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.

- **eyebrow**: Text, up to 60 characters.
- **title**: Text, up to 120 characters.
- **description**: Text, up to 300 characters.
- **entries**: List of 2 to 6. Each item: date, version (optional), title, body, tags, changes.
- **more**: See the type.
- **headingLevel**: One of '1', '2'. Optional; empty is not rendered.

[Previous](/blocks/changelog/compact)

[Next](/blocks/blog/cards)
