Sites
The Krizaka family as data: every site (the company, the products, the open-source projects, GitHub) with its address, kind, status, mark and repository, and the family's words in English and French — read by the bar's family switcher and the common footer.
Web only — React, from @krizaka/ui/sites. Beta: its API may still change in a minor version.
Why it is here. The family's adoption (NAV-SYS): the data behind NavBar.Family and SiteFooter on every Krizaka site.
When to use
- To list or link the sites of the Krizaka family anywhere: a products page, an open-source hub, a README generator.
- To know a site's status (released, coming soon, under construction) without writing it again.
When not to use
- To draw the family in a bar:
NavBar.Familyalready reads it.Use instead: Nav bar - To draw the family at the bottom of a page:
SiteFooteralready reads it.Use instead: Site footer - For a site's own pages and sections: they belong to the site, not to the family.
Installation
Install
npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcssStyles
@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";Import
import { sites, siteGroups, siteById, sitesByGroup, familyLabels } from "@krizaka/ui/sites";Examples
The family
Every site, grouped as the bar and the footer show it: name, address, status and its one line.
Krizaka
- Krizakawww.krizaka.com
The company: our products, our open source, our story.
Products
Open source
- Krizaka UIui.krizaka.com
Components, tokens, icons and charts — web and React Native.
- Krizaka Javajava.krizaka.com
Spring Boot building blocks on Maven Central.
GitHub
- GitHubgithub.com/krizaka
Every repository, in the open.
In French
The family's words in French (familyLabels.fr): names, addresses and statuses stay; the lines translate.
- Orazaka
- L’IA souveraine, sur vos propres serveurs.
- Orochia
- Une plateforme vidéo pour les créateurs.
- Yasakia· Bientôt
- L’app de rencontre où l’on se parle d’abord.
- Yororis· En construction
- Un espace d’écoute avec un visage et une voix.
Props
This module has no component props: see the import and the preview above.
Accessibility
- Plain data: the components that render it own the semantics (named lists,
aria-currenton the current site, statuses in words). - Every site has a name and a one-line description, so a mark is always decorative beside its words.
Best practices
- Never type a family address, status or one-line description in an app: a new or renamed site is one release of @krizaka/ui, and every bar and footer follow.
- Pass
familyLabels[locale](en, fr) to the components, or your own translation of the sameFamilyLabelsshape. - Say a status in words: “Coming soon” for an upcoming product, “Under construction” for one being built — never beta or a waiting list.
Related components
Generated from the code of @krizaka/ui 3.11.0: its meta.ts, its examples and its types.Edit this documentation on GitHub