Docs nav

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

• Mobile · n/a. Documentation is read on the sites, not inside an app.
• Bureau · n/a. A public site's page, not a window of the Mac app.

Pourquoi il est là. Groups the pages in the documentation sidebar.

Installation

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

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

import { DocsNav } from "@krizaka/ui/docs-nav";

Exemples

Props

Accessibilité

• A nav named by label; the current page carries aria-current="page".
• Groups are native details: they work without script.

Clavier

Bonnes pratiques

• Titles of one line: shorten them, the page's own title says the rest.
• No icon and no emoji: the active page is the only thing that stands out.

Composants liés

• Docs layoutA documentation page in the site's frame: the pages, the article and its contents on a wide screen; on a phone the pages fold into a disclosure above the article.
• Table of contentsThe sections of a reading page: sticky beside the content on a wide screen, a row of chips that scrolls sideways on a phone, the section being read marked — with TocLayout to place it.
• Docs article pageA documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.

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