Patrons
Glossary
A page or panel listing terms and definitions from the host's catalogue.
import { Glossary } from "@krizaka/ui/glossary";Les mots du commerce
- Ventes TTC
- Les ventes, toutes taxes comprises.
- Marge brute
- Les ventes moins le coût des produits vendus.
Web uniquement — React, depuis @krizaka/ui/glossary. Bêta : son API peut encore changer à une version mineure.
- Mobile · n/a. The native twin is a follow-up; present the same catalogue in a native list for now. → Description list
Pourquoi il est là. Akinaza's owner dashboard: a short reference for commerce terms alongside its explained figures.
Quand l’utiliser
- A page needs a reference list for the terms used in its figures.
- A host catalogue should be readable without opening each inline definition.
Quand ne pas l’utiliser
- A term needs a short inline explanation.À la place : Glossary term
- A record needs a general list of labels and values.À la place : Description list
Installation
Installer
npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcssStyles
@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";Importer
import { Glossary } from "@krizaka/ui/glossary";Exemples
A shop's terms
A small glossary that uses the same definitions as the inline terms.
Les mots du commerce
- Ventes TTC
- Les ventes, toutes taxes comprises.
- Marge brute
- Les ventes moins le coût des produits vendus.
Props
A page or panel listing the terms and definitions from the host's glossary catalogue.
| Prop | Type | Défaut | Description |
|---|---|---|---|
termsrequis | readonly GlossaryEntry[] | — | The terms and definitions from the host's catalogue, in the desired reading order. |
titlerequis | ReactNode | — | The section's visible heading. |
Accessibilité
- The heading labels the section; terms and definitions use a semantic description list.
- The block does not sort, translate or invent catalogue entries.
Bonnes pratiques
- Pass terms and definitions from the host's catalogue, in the reading order the host chooses.
- Give each entry a stable id.
Composants liés
Générée depuis le code de @krizaka/ui 3.63.1 : son meta.ts, ses exemples et ses types.Modifier cette documentation sur GitHub