Krizaka
Documentation

Status page

Where things stand: the overall state in words and colour, each service on its line, the incidents — or, for what is not built yet, its progress and how to hear about it.

WebBêtaModèles

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

Quand l’utiliser

  • A service status page.
  • An « under construction » page that says honestly what is coming.

Quand ne pas l’utiliser

Installation

Installer

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

Styles

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

Importer

import { StatusPage } from "@krizaka/ui/status-page";

Exemples

Status

Three services, one slower than usual.

Status

How things are running

All systems operationalChecked 2 min ago
  • krizaka.comOperational
  • OrochiaOperational
  • Video deliverySlower than usual

Under construction

Yazakia on its way: progress and how to hear about it.

Yazakia

On its way

Meet by talking first. The first build reaches testers this winter.

In constructionUpdated this week

Props

A status page — or an « under construction » one: the overall state, each service, then incidents or progress.

PropTypeDéfautDescription
staterequisServiceState—The overall state.
stateLabelrequisReactNode—The overall state, in words (All systems operational).
titlerequisReactNode—The page's h1 (Status, Yazakia is on its way).
asideReactNode—Beside the hero: a bird (the pigeon that delivers, the duck that builds).
back{ href: string; label: string; }—The way back.
checkedReactNode—When it was checked (Checked 2 min ago).
eyebrowReactNode—A mono line above the title.
leadReactNode—One sentence under it.
linkAsLinkComponent—The app's link component (Next's Link).
servicesreadonly { id: string; name: ReactNode; state: ServiceState; label: ReactNode; }[]—The services and their states, in words: { id, name, state, label }.
servicesLabelstringServicesThe services list's accessible name (Services).

Accessibilité

  • The overall state is a status region.
  • Each service says its state in words beside its dot.

Bonnes pratiques

  • Always say the state in words; the colour only repeats it.
  • Under construction: show progress and a way to follow, never a fake screen.
  • 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