Krizaka
Documentation

Changelog page

What changed and why: each entry with its date and version sticking beside it, its changes by kind in words and colour, its reasons under it.

WebBêtaModèles

Web uniquement — React, depuis @krizaka/ui/changelog-page. Bêta : son API peut encore changer à une version mineure.

Quand l’utiliser

  • Release notes, a product's changelog, a decisions log.
  • Any history read newest first.

Quand ne pas l’utiliser

  • For the decisions of one product, compared.À la place : Decision list
  • For where things stand now.À la place : Status page

Installation

Installer

npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcss

Styles

@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";

Importer

import { ChangelogPage } from "@krizaka/ui/changelog-page";

Exemples

Krizaka UI releases

Two releases with their changes by kind.

Krizaka UI

What changed

Every release, newest first — and why, when it was a decision.

  1. 2.6.0

    Page blocks

    • AddedPage, PageHero, CardGrid, LinkCard, ArgumentCard and seven more blocks.
    • ChangedThe blocks' stylesheet is imported once by the app.
  2. 2.4.0

    Data and media

    • AddedDataTable, Combobox, DatePicker, VideoPlayer.
    • FixedA live line chart no longer hides its line.

Props

A changelog: entries with a sticky date and version, changes by kind, the reasons under them.

PropTypeDéfautDescription
entriesrequisreadonly ChangelogEntry[]—The entries, newest first.
kindLabelsrequisRecord<ChangeKind, string>—The words of the kinds: { added: "Added", … }.
logLabelrequisstring—The log's accessible name (Changes).
titlerequisReactNode—The page's h1.
actionsReactNode—In the hero: a subscribe action, the feed.
back{ href: string; label: string; }—The way back.
eyebrowReactNode—A mono line above the title.
leadReactNode—One sentence under it.
linkAsLinkComponent—The app's link component (Next's Link).

Accessibilité

  • The log is a named ordered list; each date a time with its ISO value.
  • Kinds are words, not only colours.

Bonnes pratiques

  • Newest first; one entry per release.
  • Say the kind of each change (added, changed, fixed, removed) — the colour only repeats it.
  • Words and content arrive as props; the motion is the platform's ([data-reveal], still under reduced motion).

Générée depuis le code de @krizaka/ui 2.10.0 : son meta.ts, ses exemples et ses types.Modifier cette documentation sur GitHub

Sur cette page