ナビゲーションドロワー
プロダクトの行き先を、先頭側の端のパネルにセクションやグループでまとめて並べます。大きい画面ではコンテンツの横に、コンパクトな画面ではコンテンツの上に重ねて表示し、アイコンの列まで折りたたむこともできます。
- カテゴリ
- ナビゲーション
- トークン
comp.navigation-drawer- レベル
- 合成
- 構成要素
- Modal layer
- Web
tanrei-navigation-drawerschedule - SwiftUI
TanreiNavigationDrawerschedule - Jetpack Compose
TanreiNavigationDrawerschedule - Flutter
TanreiNavigationDrawerschedule - React Native
NavigationDrawerschedule
生成元 docs/status/status.json, specs/navigation-drawer.spec.json
仕様は改訂済み、各プラットフォームは追従待ち
このページは、仕様の現在の形のナビゲーションドロワーを説明しています。collapsible のドロワーはアイコンの列まで狭まり、これがナビゲーションレールの代わりになります。折りたたんだドロワーは、展開したドロワーからラベルがなくなっただけのもので、各項目をアイコンの後ろで切った形です。メニューボタンでまた広がり、どのアイコンも位置を変えません。行き先の badge のテキストは trailingText になって控えめに描かれ、trailing スロットにはグリフを置けます。badge は、アイコンに付けるバッジになりました。group の項目で、入れ子の行き先を開閉できます。項目の高さは 48 で、メニューの項目と同じです。responsive を付けると、ウィンドウの幅がドロワーの表示のしかたを選びます。href を持つ行き先はリンクで、revealSelected と scrollOffset によってドロワーはサイトのサイドバーになります。Web コンポーネントはすでにこのすべてに対応しており、デモもそれを示しています。SwiftUI、Compose、Flutter、React Native は上の表で「追従待ち」です。追従するまでは以前の版(項目の高さ 44、badge は項目の末尾のテキスト、折りたたんだ形、グループ、リンクの行き先、幅に応じた表示はなく、ナビゲーションレールは別のコンポーネント)を提供しており、これらの例もその版のものです。 コンパクトな density、行き先にもなるグループ(selectableGroups)、絞り込みの入力欄(filterable)はさらに新しく、今のところ Web だけです。
2 つのセクションを持つスタンダードのドロワー
折りたためるドロワー:メニューボタンでアイコンの列に折りたたみます。折りたたんだセルは名前をツールチップで示します
リンクの行き先:ドロワーの value が今のページを示し、reveal-selected がそれを含むグループを開きます
行を絞り込めるドロワー:入力欄に入力するか、ページのどこかで / を押して入力欄に移ります
コンパクトなドロワー:ポインターで使うツール向けに、項目の高さ 32、グリフ 16。入れ子のアイコンはグループのラベルの位置にそろいます
行き先にもなるグループ:selectable-groups を付けると、グループの行はそれを選び、シェブロンが開閉します
ナビゲーションドロワーが持つ項目は 5 種類です。destination(行き先)は、アイコン(省略可)、ラベル、末尾の内容(省略可)でできた 1 行の項目で、href を持つとリンクになります。group(グループ)は、中の行き先やグループを開閉する行です。section(セクション)は行き先やグループをまとめるもので、title(Web では headline)(見出し)と、前に引く divider(区切り線)を持てます。セクションは入れ子にできず、グループはセクションを持てません。header-button(最初のものがメニューボタン)と main-action はヘッダーに置きます。Web では子要素の <tanrei-navigation-drawer-item>、<tanrei-navigation-drawer-group>、<tanrei-navigation-drawer-section> と、header-button と main-action のスロットに入れるアイコンだけの <tanrei-button> と <tanrei-main-action-button> です。追従待ちのプラットフォームは、行き先とセクションをそれぞれの流儀で受け取ります。SwiftUI では TanreiNavigationDrawerItem と TanreiNavigationDrawerSection のビュー、Compose では同じ名前の呼び出し、Flutter では children: に並べた TanreiNavigationDrawerDestination と TanreiNavigationDrawerSection、React Native では配列 items の中の行き先とセクションの要素です。React Native のセクションは、自分の items を持つことで行き先と見分けられます。
選択は、行き先の値によってドロワーが持ちます。行き先がどのセクションにあってもかまいません。change と reselect はナビゲーションバーと同じです。Compose にはドロワー全体の値がなく、今の項目に利用者側で selected を付け、その onClick が change と reselect を兼ねます。Flutter は番号で選び、番号はセクションをまたいで読み上げ順に数えます。
href を持つ行き先はリンクであり、ボタンではありません。ブラウザーはほかのリンクと同じようにたどり、ドロワーは押されただけではそれを選択しません。どの行き先が今の場所かは、移った先のページが伝えます。ドロワーの value に、その行き先の値を、値がなければ書かれたとおりの href を設定します。リンクをふつうに実行したときにも change と reselect は発火します。どちらも href を持ち、キャンセルできるので、クライアントサイドのルーターはここで遷移を引き取れます。リンクの行き先は、今のところ Web で使えます。
グループの行はグループを開閉するだけで、何も選びません。グループがそれ自体ひとつの場所でもあるとき(サイトでセクションの概要ページがある、選ぶとフォルダーの中身を表示する、など)は、ドロワーに selectableGroups を付け、グループに value か href を与えます。するとグループの行は行き先の行と同じようにそれを選び、シェブロンはグループを開閉する独立した操作部品になります。どちらも持たないグループは、これまでどおり開閉するだけです。行き先にもなるグループは、今のところ Web で使えます。
density は既定の regular か compact です。compact は項目の高さ 32、グリフ 16 で、アイコンの列も狭く、行き先の多いドロワーをポインターで使うツール向けです。コンパクトな密度は、今のところ Web で使えます。
filterable を設定すると、項目の上に絞り込みの入力欄を描きます。入力した文字をラベルに含む行だけにドロワーが絞り込まれ、それを含むグループは絞り込みの間だけ開きます。入力欄を空にすると、ドロワーは元に戻ります。filterValue はそのテキストで、ユーザーが入力するとドロワーが自分で設定してから filterChange を発火します。ページを描き直すときに絞り込みを戻すため、利用者側で設定することもできます。入力欄の文言は利用者側のものです。filterLabel が入力欄の名前になり、filterPlaceholder、filterCountText(「一致: {count} 件」)、filterEmptyText、filterClearLabel は、空にしておくとプロダクトの文言から読みます。絞り込みは、今のところ Web で使えます。
ドロワーには 2 つのバリアントがあり、1 つのプロダクトでたいてい両方を使います。ウィンドウの幅が足りればスタンダード、足りなければモーダルです。
- スタンダードはレイアウト領域で、オーバーレイではありません。開いている間はコンテンツの横に自分の幅を確保し、閉じている間は幅を持ちません。スクリムを描かず、フォーカスを中に閉じ込めることもありません。
- モーダルは操作するオーバーレイで、しかもモーダルなものです。スクリムとともにコンテンツの上に滑り込み、閉じるまでフォーカスを中にとどめ、行き先が選ばれると自分で閉じます。
responsive を付けると、この選択をドロワーがウィンドウの幅から自分で行います(後述の「ウィンドウの幅に合わせる」を参照)。
どちらのバリアントも open で表示と非表示を切り替えます。モーダルのドロワーは、スクリムや Escape を押したとき、プラットフォームの「戻る」を使ったとき、端の方へドラッグしたときにも閉じ、close を発火します。Web では、ダイアログと同じくドロワー自身が open を false に戻します。ほかのプラットフォームでは、閉じたことを受けて利用者側で状態を合わせます。Flutter と React Native では onClose、SwiftUI では isPresented のバインディング、Compose ではドロワーの状態で、その confirmValueChange が閉じるたびに呼ばれます。
<tanrei-button variant="text" id="menu" label="メニュー"><span slot="icon">menu</span></tanrei-button>
<!-- モーダルは、シャドウルートの中で showModal() で開く <dialog> です。スタンダードは label を名前とする <nav> です。 -->
<tanrei-navigation-drawer variant="modal" label="メール" value="inbox">
<tanrei-navigation-drawer-section headline="メール">
<tanrei-navigation-drawer-item value="inbox" label="受信トレイ" icon="inbox" trailing-text="24"></tanrei-navigation-drawer-item>
<tanrei-navigation-drawer-item value="sent" label="送信済み" icon="send"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer-section>
<tanrei-navigation-drawer-section headline="ラベル" divider>
<tanrei-navigation-drawer-item value="work" label="仕事" icon="label" trailing-text="新着"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer-section>
</tanrei-navigation-drawer>
<!-- 折りたためるドロワー:最初のヘッダーボタンがメニューボタンです。ドロワーが自分で応え、expandedchange を発火します。 -->
<tanrei-navigation-drawer collapsible open label="ワークスペース" value="home">
<tanrei-button slot="header-button" variant="text" label="メニュー"><span slot="icon">menu</span></tanrei-button>
<tanrei-main-action-button slot="main-action" label="新しいプロジェクト"><span slot="icon">add</span></tanrei-main-action-button>
<span slot="header">ワークスペース</span>
<tanrei-navigation-drawer-item value="home" label="ホーム" icon="home"></tanrei-navigation-drawer-item>
<!-- グループ:その行で開閉し、toggle を発火します。 -->
<tanrei-navigation-drawer-group label="プロジェクト" icon="folder">
<tanrei-navigation-drawer-item value="atlas" label="Atlas" icon="deployed_code"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer-group>
<!-- アイコンのバッジはどちらの形でも描き、末尾の内容は展開しているときだけ描きます。 -->
<tanrei-navigation-drawer-item value="inbox" label="受信トレイ" icon="inbox" badge badge-count="3" badge-label="未読 3 件"></tanrei-navigation-drawer-item>
<!-- 新しいタブで開くリンク:展開した項目の末尾に open_in_new を描き、名前の後に target-label を読み上げます。 -->
<tanrei-navigation-drawer-item label="ヘルプセンター" icon="help" href="/help" target="new" target-label="新しいタブで開きます"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer>
<!-- サイトのサイドバー:行き先はすべてリンクで、各ページが自分のアドレスを value としてドロワーに渡します。
responsive はウィンドウの幅で表示のしかたを選び、reveal-selected は今のページを含むグループを開きます。 -->
<tanrei-navigation-drawer id="sidebar" label="ドキュメント" value="/components/tabs/" reveal-selected responsive open>
<tanrei-navigation-drawer-item label="はじめに" href="/getting-started/"></tanrei-navigation-drawer-item>
<tanrei-navigation-drawer-group label="コンポーネント">
<tanrei-navigation-drawer-item label="ボタン" href="/components/button/"></tanrei-navigation-drawer-item>
<tanrei-navigation-drawer-item label="タブ" href="/components/tabs/" trailing-text="新着"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer-group>
</tanrei-navigation-drawer>
<!-- 行を絞り込めるサイドバー:ページのどこで「/」を押しても入力欄に移ります。文言は利用者側のものです。 -->
<tanrei-navigation-drawer id="filtered" label="ドキュメント" value="/components/tabs/" reveal-selected open
filterable filter-label="ナビゲーションを絞り込む" filter-placeholder="絞り込む"
filter-count-text="一致: {count} 件" filter-empty-text="一致する項目はありません" filter-clear-label="クリア">
<tanrei-navigation-drawer-group label="コンポーネント">
<tanrei-navigation-drawer-item label="ボタン" href="/components/button/"></tanrei-navigation-drawer-item>
<tanrei-navigation-drawer-item label="タブ" href="/components/tabs/"></tanrei-navigation-drawer-item>
</tanrei-navigation-drawer-group>
</tanrei-navigation-drawer>
<script type="module">
import '@tanrei/web/components/navigation-drawer';
import '@tanrei/web/components/button';
const drawer = document.querySelector('tanrei-navigation-drawer');
document.querySelector('#menu').addEventListener('click', () => (drawer.open = true));
// ドロワーは change を発火する前に自分の value を更新します。モーダルのドロワーはその後で自分で閉じます。
drawer.addEventListener('change', (e) => showFolder(e.detail.value));
// close は、スクリム、Escape、ドラッグ、行き先の選択のどれで閉じても発火します。
drawer.addEventListener('close', onDrawerClosed);
// 折りたためるドロワーは、メニューボタンが求めた形にすでになっています。
document.querySelector('[collapsible]').addEventListener('expandedchange', (e) => savePreference(e.detail.expanded));
const sidebar = document.querySelector('#sidebar');
// リンクの change はキャンセルでき、href を持ちます。クライアントサイドのルーターはここで遷移を引き取ります。
// ページごとに文書が分かれたサイトは何も聞かず、次のページが value を伝えます。
sidebar.addEventListener('change', (e) => {
e.preventDefault();
router.navigate(e.detail.href);
});
// responsive のドロワーは、ウィンドウの幅で決まった表示(standard、column、modal)を伝えます。
sidebar.addEventListener('presentationchange', (e) => showMenuButton(e.detail.presentation === 'modal'));
// ユーザーが残した絞り込みのテキストを、次のページのために取っておきます(ドロワーは何も保存しません)。
const filtered = document.querySelector('#filtered');
filtered.addEventListener('filterchange', (e) => sessionStorage.setItem('filter', e.detail.value));
filtered.filterValue = sessionStorage.getItem('filter') ?? '';
</script>import {
NavigationDrawer,
NavigationDrawerGroup,
NavigationDrawerItem,
NavigationDrawerSection,
} from '@tanrei/react';
// モーダルのドロワーは自分で閉じます(onClose)。そこで open を合わせます。
<NavigationDrawer
variant="modal"
label="メール"
open={open}
value={folder}
onChange={(e) => setFolder(e.detail.value)}
onClose={() => setOpen(false)}
>
<NavigationDrawerSection headline="メール">
<NavigationDrawerItem value="inbox" label="受信トレイ" icon="inbox" trailingText="24" />
<NavigationDrawerItem value="sent" label="送信済み" icon="send" />
</NavigationDrawerSection>
</NavigationDrawer>
// サイトのサイドバー:行き先はリンクで、どれが今の場所かはページが伝えます。
<NavigationDrawer
label="ドキュメント"
open
responsive
revealSelected
value={pathname}
onChange={(e) => {
e.preventDefault(); // クライアントサイドのルーターが遷移を引き取ります
navigate(e.detail.href);
}}
onPresentationChange={(e) => setPresentation(e.detail.presentation)}
>
<NavigationDrawerGroup label="コンポーネント">
<NavigationDrawerItem label="ボタン" href="/components/button/" />
<NavigationDrawerItem label="タブ" href="/components/tabs/" trailingText="新着" />
</NavigationDrawerGroup>
<NavigationDrawerItem label="ソースコード" href="https://example.com/tanrei" target="new" targetLabel="新しいタブで開きます" />
</NavigationDrawer>
// 行を絞り込めるサイドバー:ユーザーが入力すると、ドロワーが自分で filterValue を設定します。
<NavigationDrawer
label="ドキュメント"
open
filterable
filterLabel="ナビゲーションを絞り込む"
filterPlaceholder="絞り込む"
filterCountText="一致: {count} 件"
filterEmptyText="一致する項目はありません"
filterClearLabel="クリア"
filterValue={filter}
onFilterChange={(e) => setFilter(e.detail.value)}
>
<NavigationDrawerGroup label="コンポーネント">
<NavigationDrawerItem label="ボタン" href="/components/button/" />
<NavigationDrawerItem label="タブ" href="/components/tabs/" />
</NavigationDrawerGroup>
</NavigationDrawer>import Tanrei
// スタンダード:コンテンツの横に置きます。isPresented で表示と非表示を切り替え、行き先を選ぶと selection に書き込まれます。
HStack(spacing: 0) {
TanreiNavigationDrawer(variant: .standard, isPresented: $sidebarShown, selection: $folder,
accessibilityLabel: "メール", onReselect: { _ in scrollToTop() }) {
TanreiNavigationDrawerSection("メール") {
TanreiNavigationDrawerItem("受信トレイ", icon: "inbox", value: "inbox", badge: "24")
TanreiNavigationDrawerItem("送信済み", icon: "send", value: "sent")
}
TanreiNavigationDrawerSection("ラベル", divider: true) {
TanreiNavigationDrawerItem("仕事", icon: "label", value: "work")
}
} header: {
Text("メール")
}
FolderView(folder)
}
// モーダル:覆うコンテンツに付けるモディファイアーです。閉じるとバインディングに false が書き込まれます。
FolderView(folder)
.tanreiNavigationDrawer(isPresented: $menuShown, selection: $folder, accessibilityLabel: "メール") { … }import io.github.chnotchy.tanrei.components.TanreiNavigationDrawer
import io.github.chnotchy.tanrei.components.TanreiNavigationDrawerItem
import io.github.chnotchy.tanrei.components.TanreiNavigationDrawerSection
import io.github.chnotchy.tanrei.components.rememberTanreiDrawerState
import io.github.chnotchy.tanrei.tokens.TanreiNavigationDrawerVariant
// ドロワーは画面全体を包みます。drawerState が仕様の open で、confirmValueChange が仕様の close を受け取ります。
val drawerState = rememberTanreiDrawerState()
TanreiNavigationDrawer(
variant = if (wide) TanreiNavigationDrawerVariant.Standard else TanreiNavigationDrawerVariant.Modal,
drawerState = drawerState,
contentDescription = "メール",
drawerContent = {
// 今の項目に selected を付けます。モーダルのドロワーは onClick の後で自分で閉じます。
TanreiNavigationDrawerSection(heading = "メール") {
TanreiNavigationDrawerItem(selected = folder == "inbox", onClick = { folder = "inbox" }, label = "受信トレイ", icon = "inbox", badge = "24")
TanreiNavigationDrawerItem(selected = folder == "sent", onClick = { folder = "sent" }, label = "送信済み", icon = "send")
}
TanreiNavigationDrawerSection(heading = "ラベル", divider = true) {
TanreiNavigationDrawerItem(selected = folder == "work", onClick = { folder = "work" }, label = "仕事", icon = "label", badge = "新着")
}
},
) {
FolderScreen(folder, onMenu = { drawerState.open() })
}import 'package:tanrei/tanrei.dart';
// スタンダード:レイアウト領域として、Row の先頭でコンテンツの横に置きます。
Row(
children: <Widget>[
TanreiNavigationDrawer(
open: sidebarOpen,
selectedIndex: current, // セクションをまたいで読み上げ順に数えた番号
onDestinationSelected: (int index) => setState(() => current = index), // change と reselect
semanticLabel: 'メール',
children: const <TanreiNavigationDrawerChild>[
TanreiNavigationDrawerSection(
heading: 'メール',
children: <TanreiNavigationDrawerChild>[
TanreiNavigationDrawerDestination(icon: 'inbox', label: '受信トレイ', badge: '24'),
TanreiNavigationDrawerDestination(icon: 'send', label: '送信済み'),
],
),
TanreiNavigationDrawerSection(
heading: 'ラベル',
divider: true,
children: <TanreiNavigationDrawerChild>[
TanreiNavigationDrawerDestination(icon: 'label', label: '仕事', badge: '新着'),
],
),
],
),
const Expanded(child: Page()),
],
),
// モーダル:ウィンドウいっぱいの Stack の最後の子として置きます。onClose を受けて open を false にします。
Stack(
children: <Widget>[
const Positioned.fill(child: Page()),
TanreiNavigationDrawer(
variant: TanreiNavigationDrawerVariant.modal,
open: menuOpen,
onClose: () => setState(() => menuOpen = false),
selectedIndex: current,
onDestinationSelected: (int index) => setState(() => current = index),
semanticLabel: 'メール',
children: destinations,
),
],
),import { useState } from 'react';
import { NavigationDrawer } from '@tanrei/react-native';
const [open, setOpen] = useState(false);
const [folder, setFolder] = useState('inbox');
// 制御コンポーネントです。onClose を受けて open を false にします。モーダルのドロワーは透明な Modal で表示します。
<NavigationDrawer
variant={wide ? 'standard' : 'modal'}
open={open}
onClose={() => setOpen(false)}
accessibilityLabel="メール"
value={folder}
onValueChange={setFolder}
items={[
{ heading: 'メール', items: [
{ value: 'inbox', label: '受信トレイ', icon: 'inbox', badge: '24' },
{ value: 'sent', label: '送信済み', icon: 'send' },
] },
{ heading: 'ラベル', divider: true, items: [{ value: 'work', label: '仕事', icon: 'label', badge: '新着' }] },
]}
/>セクションに入れず、アイコンを付けない行き先
構成要素
構成要素
standard の上に描いています。寸法
寸法
| 長さ | トークン | 値(px) |
|---|---|---|
container width | tanrei.comp.navigation-drawer.container.width | 240 |
container padding-inline | tanrei.comp.navigation-drawer.container.padding-inline | 12 |
standard の上に描いています。プロパティ
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
variant | standard | modal | "standard" | Standard sits beside the content and takes its width in the layout; modal lays itself over the content with a scrim and holds focus until it closes. One product uses both: standard where the window is wide enough, modal where it is not. A design system may add values. Ignored while responsive is true, when the window's width chooses. |
open | boolean | false | Whether the drawer is shown: for a standard drawer, whether it takes its place in the layout (in the form collapsible and expanded choose); for a modal one, whether it is presented over the content (while collapsible, its collapsed column stays in the layout when it is not). While responsive is true it only says whether the drawer is shown over the content in the presentations that are modal, and every change of presentation sets it back to false. |
collapsible | boolean | false | Gives the drawer a collapsed form, the icon column. A standard drawer then shows the form expanded chooses; a modal one shows its column in the layout while closed and widens over the content while open. While false the drawer is always expanded and lays its rows out for that form alone. |
expanded | boolean | true | The form of a collapsible standard drawer: true for the full drawer, false for the icon column. Ignored while collapsible is false, and by a modal drawer, whose form follows open. It is the user's choice: a change of the window's width never writes it, so a responsive drawer returns to it when the window is wide again. |
collapsedLabels | always | selected | never | "never" | Which cells draw their short label under the icon while the drawer is collapsed: none of them (the default: a collapsed drawer is the expanded one with its labels gone), only the selected one's, or all of them, for a product or a design system whose collapsed column is labelled. A label that is not drawn is still the destination's accessible name. |
density | regular | compact | "regular" | How much room a row takes, in a tree view's words. regular (a 48 row with a 24 glyph in the default system, a menu item's row) is the drawer of a product used by touch as well as by pointer. compact (a 32 row with a 16 glyph, a tree view's compact row) is for a tool used with a pointer whose drawer lists many places. It sets the rows, the section headings, the paddings, the glyphs, the nesting indent and the collapsed column alike — never the gap between the icon and the label — so both forms follow it; for touch a row is never lower than the touch target in either. A design system may add values. |
chevron | start | end | none | "start" | Where a group's chevron is drawn, as the tree view's: start, before its icon (every row then keeps the chevron's room, so the icons of a level stand in one column); end, at the very end of the row, after its trailing content; none, no chevron — the arrow keys still open and close a group, and with a pointer a press on the group's icon does, the icon showing openIcon while the group is open (NVD-68). A collapsible drawer draws start as end, so that every icon keeps its point in both forms. |
guides | none | shown | hover | "none" | Whether an open group draws a line down beside what it holds, as the tree view's: none; shown, always; hover, while the pointer is over the drawer or focus is in it, fading in and out (NVD-73). |
indent | number | null | How much further a level's rows begin than their group's, as the tree view's: null (auto, the default) lines a row's first part (its chevron, icon or label) up with where its group's label begins, and steps by comp.navigation-drawer.item.nest-indent where the group has neither a start chevron nor an icon; a number steps by that many units of the layout at every level, 0 none (NVD-69). On the web the attribute takes auto or a number. |
highlight | indented | full | "indented" | How far the selected fill and the hover and press layers of a nested row reach, as the tree view's: indented, from where the row begins (its indent) to the end; full, across the drawer's whole inner width at every level (NVD-70). |
iconSpace | auto | always | never | "auto" | Whether a row without an icon keeps the icon's room, as the tree view's: auto, where another row of its level has an icon, so that the labels of a level line up; always; never (NVD-71). |
expandable | boolean | true | Whether groups open and close at all, as the tree view's. While false every group is shown open, draws no chevron, has no toggle and is not exposed as expandable: its row names the list of its items (NVD-72). It is not collapsible, which narrows the drawer itself. |
labelWrap | boolean | false | Lets a row's label wrap onto more lines, as the tree view's. While false (the default) a label is one line, cut with an ellipsis, and its full text is shown in a tooltip on hover and keyboard focus wherever it is cut (NVD-75). |
supportingWrap | boolean | false | Lets a row's supporting text wrap, as labelWrap lets its label. |
responsive | boolean | false | Lets the window's width choose the drawer's presentation (NVD-53): beside the content where the window is wide, its collapsed column beside the content where it is narrower (while collapsible), and over the content alone where it is narrow. While true the drawer ignores variant, shows itself in a wide window whatever open says, and closes whenever the width changes its presentation. |
value | string | "" | The value of the selected destination (selection is the drawer's, by a destination's value), wherever it stands, in a section, in a group or neither. Empty selects none. The selected destination is the place the product is showing, and it is exposed as the current page: in a product whose pages are separate documents nothing is selected by a press, and each page sets value to the destination that is that page (a link's href stands as its value while it has none, NVD-59). |
revealSelected | boolean | false | Opens the groups that hold the selected destination when the drawer first appears and whenever value changes, so that the place the product is showing is drawn and not only the closed group that holds it (NVD-58). A site's sidebar sets it; while false a closed group stays closed and its row shows the selection (NVD-47). The user may still close such a group afterwards. |
selectableGroups | boolean | false | Lets a group be a destination as well as a row that opens and closes: a setting of the product's, off by default. While true a group that has a value or an href is a place of its own (NVD-66) — a section's overview page in a site, a folder that is shown when it is chosen — which the drawer's value selects, whose activation emits change or reselect and which an href makes a link; its chevron becomes a control of its own that opens and closes it, and the rest of its row chooses it (NVD-67). A group without either still only opens and closes. While false every group only opens and closes, whatever value or href it has. |
scrollOffset | number | 0 | How far the drawer's items are scrolled from their start, in the units of the layout. The product may set it, before the drawer first appears included, and the drawer scrolls there at once; reading it gives the present distance. It is the handle by which a product keeps a long drawer where the user left it from one page to the next (NVD-61, NVD-62); the drawer stores nothing itself. |
stickyParents | boolean | false | Keeps the rows of the open groups that the rows at the top of the drawer belong to pinned there while their items scroll under them, as the tree view's (on by default there, off here) and as VS Code's sticky scroll (NVD-77). Not applied while the drawer is collapsed. |
stickyMax | number | 2 | At most how many group rows are pinned, one per level, the innermost winning, as VS Code keeps its innermost scopes (NVD-77). |
loadingLabel | string | "" | What the loading row under a group that is fetching its items says ("Loading…"), and its accessible name, as the tree view's: Tanrei ships no words of its own. |
filterable | boolean | false | Draws a filter field above the items: what a person types there narrows the drawer to the rows whose label holds it, opening for the time being the groups that hold them, and the drawer comes back as it was when the field is emptied. Off by default: a product that filters on a server, ranks, or matches in another way leaves it off and gives the drawer the items that match, as before. |
filterValue | string | "" | The filter text: what the filter field holds. The drawer sets it when the person types and emits filterChange; the product may set it too (a filter given back when a page is rendered again). Empty, or only white space, applies no filter. |
filterLabel | string | "" | Names the filter field for assistive technology, in the product's language: what it narrows ("Filter navigation", "Filter files"). Required while filterable is true. It names this one field, so it is not one of the product's words set once. |
filterPlaceholder | string | "" | The hint the filter field shows while it is empty ("Filter"), in the product's language. Never a replacement for filterLabel. The product's: Tanrei has no words for it. Empty reads the product's words; with neither, the field shows no hint. |
filterEmptyText | string | "" | What the drawer draws at the top of the results and says while a filter is applied and no row matches ("No matches"), in the product's language. The product's: Tanrei has no words for it. Empty reads the product's words; with neither, nothing is drawn in its place and it is reported. |
filterCountText | string | "" | What the drawer draws quietly at the top of the results (NVD-90) and says to assistive technology once the result of a filter has settled (NVD-91), with {count} where the number of rows that match goes ("Matches: {count}"), in the product's language. filterCountHidden leaves it undrawn and still said. The product's: Tanrei has no words for it. Empty reads the product's words; with neither, no count is drawn or said and it is reported. |
filterCountHidden | boolean | false | Does not draw the count at the top of the results (NVD-90); it is still said to assistive technology (NVD-91). The words for a filter that matches nothing are drawn either way. A drawer whose results are counted elsewhere on the screen, or where the rows left say enough, turns it on. |
filterClearLabel | string | "" | The accessible name of the filter field's clear button ("Clear"), in the product's language. Required while the field can hold text. Empty reads the product's words. |
filterShortcut | strings | / | The key that moves focus to the filter field from anywhere in the window, in the keyboard shortcut component's key names, one chord (["/"], the default). While filterable is true the drawer draws it as a hint in the empty field, exposes it as the field's keyboard shortcut and answers it itself while it is shown (NVD-87); an app shell answers it for a drawer it has closed over its content (APS-33). Pressed while focus is in a field, or with a key held down, it does nothing. An empty list draws no hint and binds nothing: a product that already gives "/" another meaning sets its own chord or none. |
label | string | "" | Names the drawer for assistive technology ("Mail"): the navigation landmark on the web, and the modal drawer as a whole on every platform. |
スロット
| スロット | 説明 |
|---|---|
header | Content the product puts in the header beside the first header button (a title, an account switcher); the drawer does not restyle it. Drawn only while the drawer is expanded; collapsed, its row keeps its height. |
イベント
| イベント | 説明 |
|---|---|
change | The user activated a destination that is not the selected one, or a group that is one (NVD-66); carries its value and, for a link, its href. For a link it comes before the link is followed, only for an activation that follows it in place (NVD-60), and a product that cancels it follows the link itself. |
reselect | The user activated the destination that is already selected; carries its value and, for a link, its href, as change does. |
close | A modal drawer closed, or asks its controlled owner to close it: by the scrim, Escape, the platform's back action, a drag toward its edge, its menu button, or after a destination was activated. |
expandedChange | The user asked a collapsible drawer for its other form, with its menu button or a group's cell in the collapsed drawer; carries true to expand and false to collapse. For a collapsible modal drawer, true asks it to open. |
presentationChange | A responsive drawer decided its presentation for the first time, or the window's width changed it; carries standard (beside the content), column (its collapsed column beside the content, widening over it) or modal (over the content alone). A product shows its own menu button while the presentation is modal. |
filterChange | The person changed the filter text — typing, deleting, pasting, dictating, an input method committing text, the clear button or Escape; carries the new text. Not emitted when the product sets filterValue. It is the product's cue to keep the text where it keeps a page's state. |
アイテム
このコンポーネントが繰り返すアイテムの種類です。フィクスチャはアイテムを順に並べ、各プラットフォームはそれぞれの流儀で種類ごとに名前を付けます。
destination
One destination of the drawer: an icon, a label, optional trailing content at the end of its row and an optional badge on its icon. Collapsed, its icon alone. With an href it is a link to that address and not a button.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
value | string | "" | What identifies the destination. The drawer's value selects the destination whose value equals it; change and reselect carry it. Unique within the drawer. Empty on a link, its href stands as its value. |
href | string | "" | The address the destination leads to. Not empty, the destination is a link and not a button (NVD-59): it is followed as the platform follows a link, and the drawer does not select it by itself (NVD-60). Empty, the destination is a button and the product moves on change. As the Button's href (a control with a destination is a link). |
target | same | new | "same" | Where a link opens, as the Button's target. same: where the person is. new: a new context — a new tab or window on the web, outside the current screen elsewhere — which the expanded row marks with the glyph open_in_new at its end unless the product put trailing content there, and says through targetLabel (NVD-63). A link that opens elsewhere is never selected by a press (NVD-60). Ignored without href. |
targetLabel | string | "" | What assistive technology reads after the link's name while target is new ("opens in a new tab"), as the Button's targetLabel: Tanrei ships no words of its own. Required while target is new; ignored otherwise. |
label | string | "" | Its name, drawn beside the icon while the drawer is expanded and always its accessible name. Required. |
supportingText | string | "" | A few words about the row ("3 new", "shared with the team"), under its label or after it (supportingPosition), quieter than the label, read as its description after its name. Empty draws none (NVD-74). |
supportingPosition | below | inline | "below" | Where the supporting text stands, as the tree view's: below, on a line of its own under the label; inline, after the label on its line (NVD-74). |
shortLabel | string | "" | What the collapsed drawer draws under the icon, on one line ("Files" for "My files"), where collapsedLabels asks for labels. Empty draws the label, truncated if it does not fit. It should be a part of the label, which stays the accessible name. |
icon | string | "" | The name of its glyph in the system's icon set, drawn in the destination's own icon style: outlined while unselected, filled while selected. Empty draws no icon; give every destination of a drawer an icon, or none, and every top-level one an icon in a collapsible drawer. |
disabled | boolean | false | Makes it unavailable. It keeps its place, draws its disabled look, cannot be activated and leaves the focus order. |
trailingText | string | "" | Short text at the end of the expanded row, a count or a word ("24", "New"), quieter than the label. Empty draws none; the trailing slot's content, when there is any, is drawn instead. |
badge | boolean | false | Draws a Tanrei badge (the badge component) on the icon, in both forms, from badgeCount and badgeLabel. |
badgeCount | number | null | The badge's count, as the badge component's count: null draws the dot, 0 draws nothing, above 0 the number (above 999 as 999+). Ignored while badge is false. |
badgeLabel | string | "" | The badge's label, as the badge component's: what assistive technology reads after the destination's name and state ("3 unread"). A dot needs one. Ignored while badge is false. |
| スロット | 説明 |
|---|---|
trailing | Content at the end of the expanded row, in place of trailingText: a glyph (open_in_new for a destination that opens elsewhere), a short text. Not interactive. A count belongs in trailingText, and a badge on the icon (badge): a Badge needs an anchor, and the end of the row has none. A fixture item's content is a glyph drawn here. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-navigation-drawer-item | TanreiNavigationDrawerItem | TanreiNavigationDrawerItem | TanreiNavigationDrawerDestination | NavigationDrawerDestination |
value · プロパティ | value | value | selected | children | value |
href · プロパティ | href | destination | href | href | href |
target · プロパティ | target | target | target | target | target |
targetLabel · プロパティ | targetLabel | targetLabel | targetLabel | targetSemanticLabel | targetLabel |
label · プロパティ | label | title | label | label | label |
supportingText · プロパティ | supportingText | supportingText | supportingText | supportingText | supportingText |
supportingPosition · プロパティ | supportingPosition | supportingPosition | supportingPosition | supportingPosition | supportingPosition |
shortLabel · プロパティ | shortLabel | shortTitle | shortLabel | shortLabel | shortLabel |
icon · プロパティ | icon | icon | icon | icon | icon |
disabled · プロパティ | disabled | disabled | enabled | enabled | disabled |
trailingText · プロパティ | trailingText | trailingText | trailingText | trailingText | trailingText |
badge · プロパティ | badge | badge | badge | badge | badge |
badgeCount · プロパティ | badgeCount | count | count | count | count |
badgeLabel · プロパティ | badgeLabel | label | contentDescription | semanticLabel | label |
| 備考 | icon is the glyph's name; none, no icon. short-label, trailing-text, badge-count and badge-label are attributes; the trailing slot is trailing. badge is the boolean of the icon badge; a destination's trailing text is trailing-text. href makes the destination a link: the cell is an <a href> in the item's shadow root. target is the target attribute with the values same and new (the HTML spellings _self and _blank are read as those two), targetLabel the target-label attribute, and rel (to which new adds noopener) and download are web-only and forwarded to the anchor, all as <tanrei-button>'s. Space is not handled on it. With no value attribute the item's value property reads its href attribute as written (not the resolved URL). | TanreiNavigationDrawerItem(_ title: String, shortTitle: String = "", icon: String? = nil, value: Value, trailingText: String = "", badge: TanreiNavigationBadge? = nil) { trailing }, with the bar's TanreiNavigationBadge(count:, label:). disabled follows .disabled(_:). destination: URL? = nil makes it a SwiftUI Link (the link trait), opened by the environment's openURL after the selection callback, which an app that routes addresses itself answers with its own OpenURLAction; target: TanreiLinkTarget = .same and targetLabel (the accessibility hint), as the Button's. | TanreiNavigationDrawerItem(selected, onClick, label, shortLabel = "", icon = null, trailingText = "", badge = null, enabled = true, trailing = null); icon is the glyph's name, null for none; badge is the bar's TanreiNavigationBadge(count, contentDescription); trailing is a composable slot. enabled is the inverse flag. href: String? = null makes it a link: opened through LocalUriHandler.current after onClick (an app that routes addresses itself provides its own UriHandler); Compose has no link role for a clickable element, so the node drops Role.Button and carries no role; target: TanreiLinkTarget = TanreiLinkTarget.Same, and targetLabel is appended to the state description, as the Button's. | TanreiNavigationDrawerDestination(icon:, label:, shortLabel: '', trailingText: '', trailing: null, badge: null, enabled: true); icon is the glyph's name, null for none; badge: TanreiNavigationBadge(count:, semanticLabel:), as the bar's; trailing is a widget. Its value is its index among the destinations of children. href: Uri? = null makes it a link (Semantics(link: true) with the address as its linkUrl), opened by the nearest TanreiLinkOpener after onDestinationSelected; target is a TanreiLinkTarget and targetSemanticLabel the semantics hint, as the Button's. | An entry of items: { value, label, shortLabel?, icon?, trailingText?, trailing?, badge?: { count?, label? }, disabled? }, where icon is the glyph's name and trailing a React node; the badge has the navigation bar's shape. href?: string makes it a link (accessibilityRole="link"); onValueChange receives the value and the href, and Linking.openURL(href) follows it unless the product handles it; target is "same" | "new" and targetLabel the accessibilityHint, as the Button's. |
group · グループ — アイテムを含む
A group of destinations under a row that opens and closes it: an icon, a label and a chevron. It holds destinations and groups, not sections, and their rows start further in than its own. While the drawer's selectableGroups is true and it has a value or an href, it is a destination as well (NVD-66): its row chooses it and its chevron opens and closes it.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
label | string | "" | Its name, drawn in its row and used as the accessible name of its row and of the list of its items. Required. |
shortLabel | string | "" | What the collapsed drawer draws under its icon where collapsedLabels asks for labels; empty draws the label, as a destination's. |
icon | string | "" | The name of its glyph in the system's icon set, drawn as a destination's icon. |
openIcon | string | "" | A second glyph, drawn in the icon's place while the group is open (folder_open beside folder), as the tree view's. Ignored while icon is empty. |
supportingText | string | "" | A few words about the group ("3 new", "shared with the team"), under its label or after it (supportingPosition), quieter than the label, read as its description after its name. Empty draws none (NVD-74). |
supportingPosition | below | inline | "below" | Where the supporting text stands, as the tree view's: below, on a line of its own under the label; inline, after the label on its line (NVD-74). |
trailingText | string | "" | Short text at the end of the group's expanded row (a count), before an end chevron, as a destination's; the trailing slot's content, when there is any, is drawn instead. |
disabled | boolean | false | Makes its row unavailable: it keeps its place and its open state, draws its disabled look, cannot be toggled and leaves the focus order. Its items keep their own disabled. |
open | boolean | false | Whether its items are shown under its row while the drawer is expanded. |
loading | boolean | false | Says that the product is fetching the group's items: while the group is open a loading row is drawn under it, after any items it already holds, and the list of its items is exposed as busy (NVD-76). |
value | string | "" | What identifies the group as a destination, read only while the drawer's selectableGroups is true (NVD-66): the drawer's value selects the group whose value equals it, as it selects a destination, and change and reselect carry it. Unique among the drawer's destinations and groups. Empty on a link, its href stands as its value; empty with no href, the group is not a destination and only opens and closes. |
href | string | "" | The address the group leads to as a destination, read only while the drawer's selectableGroups is true: not empty, its row is a link and not a button (NVD-59, NVD-60), opened where the person is. Ignored while selectableGroups is false. |
| スロット | 説明 |
|---|---|
trailing | Content at the end of the group's expanded row, before an end chevron, in place of trailingText: a glyph of the icon set, as a destination's trailing slot. Not interactive. A count belongs in trailingText. |
| イベント | 説明 |
|---|---|
toggle | The user opened or closed the group from its row, or from its cell in the collapsed drawer, or the drawer opened it to show the selected destination (NVD-58); carries its new open state. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-navigation-drawer-group | TanreiNavigationDrawerGroup | TanreiNavigationDrawerGroup | TanreiNavigationDrawerGroup | NavigationDrawerGroup |
label · プロパティ | label | title | label | label | label |
shortLabel · プロパティ | shortLabel | shortTitle | shortLabel | shortLabel | shortLabel |
icon · プロパティ | icon | icon | icon | icon | icon |
openIcon · プロパティ | openIcon | openIcon | openIcon | openIcon | openIcon |
supportingText · プロパティ | supportingText | supportingText | supportingText | supportingText | supportingText |
supportingPosition · プロパティ | supportingPosition | supportingPosition | supportingPosition | supportingPosition | supportingPosition |
trailingText · プロパティ | trailingText | trailingText | trailingText | trailingText | trailingText |
disabled · プロパティ | disabled | disabled | enabled | enabled | disabled |
open · プロパティ | open | isExpanded | expanded | expanded | open |
loading · プロパティ | loading | loading | loading | loading | loading |
value · プロパティ | value | value | selected | value | value |
href · プロパティ | href | destination | href | href | href |
toggle · イベント | toggle | isExpanded | onExpandedChange | onExpansionChanged | onToggle |
| 備考 | Holds <tanrei-navigation-drawer-item> and <tanrei-navigation-drawer-group> children. Its row is a <button aria-expanded aria-controls> and its items a nested list labelled by it; open is reflected. toggle bubbles, with detail.open; the drawer's own expandedchange is a different event. While the drawer's selectable-groups is set and the group has a value or an href, its row is the destination — an <a href> or a <button> with aria-current="page" while selected — and its chevron a second <button aria-expanded aria-controls> after it, named by the group's label; a group without either keeps the one row button. The group's value property reads its href attribute while it has no value, as an item's does. | TanreiNavigationDrawerGroup(_ title: String, shortTitle: String = "", icon: String? = nil, isExpanded: Binding<Bool>) { items }, as SwiftUI's DisclosureGroup binds its state; toggling writes the binding. disabled follows .disabled(_:). | TanreiNavigationDrawerGroup(label, expanded, onExpandedChange, shortLabel = "", icon = null, enabled = true) { … }; the row has Modifier.semantics { expand() / collapse() } and the expanded state. enabled is the inverse flag. | TanreiNavigationDrawerGroup(label:, icon:, shortLabel: '', expanded:, onExpansionChanged:, enabled: true, children: [...]), controlled, with ExpansionTile's callback name; its row carries Semantics(expanded:). | An entry { label, shortLabel?, icon?, disabled?, open, onToggle, groupItems: (NavigationDrawerDestination | NavigationDrawerGroup)[] }; its groupItems array tells it from a section's items. |
section · グループ — アイテムを含む
A group of destinations and groups under an optional heading, with an optional divider before it. It is not interactive and does not nest.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
title | string | "" | The text that names the items under it, exposed as a heading. Empty draws no heading row. |
divider | boolean | false | Draws a divider (the divider component) before the section, to set it apart from what is above it. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-navigation-drawer-section | TanreiNavigationDrawerSection | TanreiNavigationDrawerSection | TanreiNavigationDrawerSection | NavigationDrawerSection |
title · プロパティ | headline | heading | heading | heading | heading |
divider · プロパティ | divider | divider | divider | divider | divider |
| 備考 | Holds <tanrei-navigation-drawer-item> and <tanrei-navigation-drawer-group> children. It draws a <tanrei-divider> before itself while divider is set, and its heading as a heading element (role="heading", level 2 unless a web-only heading-level says otherwise). | TanreiNavigationDrawerSection(_ heading: String = "", divider: Bool = false) { items }, as SwiftUI's Section; the heading carries the header trait. | TanreiNavigationDrawerSection(heading = "", divider = false) { … }, a composable whose content lambda holds its items; the heading has Modifier.semantics { heading() } and the divider is a TanreiDivider. | TanreiNavigationDrawerSection(heading: '', divider: false, children: [...]); the heading is wrapped in Semantics(header: true) and the divider is a TanreiDivider. | An entry { heading?, divider?, items: (NavigationDrawerDestination | NavigationDrawerGroup)[] }; its items array tells it from a destination. |
header-button
An icon-only Button in the header, on the icon column (a menu button): a Button of the text variant and the medium size with an icon and no label, unless the product sets otherwise, which the drawer lays out and does not restyle, resize or reshape in either form. While the drawer is collapsible the first one is its menu button.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
label | string | "" | Its accessible name, as the Button's label. Required. |
| スロット | 説明 |
|---|---|
icon | Its glyph, as the Button's icon slot. A fixture item's content is this glyph. |
| イベント | 説明 |
|---|---|
click | The button was activated, as the Button's click. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-button | TanreiButton | TanreiButton | TanreiButton | Button |
label · プロパティ | label | label | contentDescription | semanticLabel | accessibilityLabel |
click · イベント | click | action | onClick | onPressed | onPress |
| 備考 | An icon-only <tanrei-button> child with slot="header-button"; the glyph is its content. | An icon-only TanreiButton in the headerButtons view builder; the drawer adds the expanded value to the first. | An icon-only TanreiButton in the headerButtons lambda; the drawer adds the expanded state to the first one's semantics. | An icon-only TanreiButton in headerButtons:; the drawer wraps the first in Semantics(expanded:). | An icon-only Button element in headerButtons; the drawer adds accessibilityState.expanded to the first. |
main-action
The screen's main action, below the header buttons: the Main Action Button component, whose extended the drawer sets from its own form (collapsed to its icon while the drawer is collapsed). The drawer lays it out and does not restyle it.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
label | string | "" | Its label, drawn while the drawer is expanded and always its accessible name, as the Main Action Button's. Required. |
| スロット | 説明 |
|---|---|
icon | Its glyph, as the Main Action Button's icon slot. A fixture item's content is this glyph. |
| イベント | 説明 |
|---|---|
click | The button was activated, as the Main Action Button's click. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-main-action-button | TanreiMainActionButton | TanreiMainActionButton | TanreiMainActionButton | MainActionButton |
label · プロパティ | label | title | text | label | label |
click · イベント | click | action | onClick | onPressed | onPress |
| 備考 | A <tanrei-main-action-button> child with slot="main-action"; the glyph is its icon slot. The drawer sets its extended (the inverse collapsed attribute). | A TanreiMainActionButton in the mainAction view builder; the drawer sets its isExtended from its own form. | A TanreiMainActionButton in the mainAction lambda; the drawer passes its form as expanded. | A TanreiMainActionButton as mainAction:; the drawer sets its isExtended from its own form. | A MainActionButton element as mainAction; the drawer sets its extended. |
状態
振る舞い
EARS 記法による要件です。各プラットフォームの実装は、この ID に対応するテストで検証されます。要件の原文は仕様ファイルのものをそのまま掲載しています。
| ID | 要件 |
|---|---|
NVD-1 | WHEN the user activates a destination by pointer, touch, Enter or Space (Enter only for a destination that is a link, and for a link only an activation that NVD-60 counts) THE navigation drawer SHALL emit change exactly once with the destination's value WHILE it is not the selected destination, and reselect exactly once with its value WHILE it is. |
NVD-2 | WHILE a destination's disabled is true THE navigation drawer SHALL NOT emit change or reselect for it, SHALL NOT make it focusable and SHALL expose it as disabled to assistive technology. |
NVD-3 | THE navigation drawer SHALL draw the destination whose value equals the drawer's value, in a section, in a group or neither, from the selected parts and every other destination from the unselected parts: WHILE the drawer is expanded, from selected (comp.navigation-drawer.selected.item.container.color, comp.navigation-drawer.selected.item.icon-indicator.color, comp.navigation-drawer.selected.item.icon.color, comp.navigation-drawer.selected.item.label.color, comp.navigation-drawer.selected.item.trailing-text.color, comp.navigation-drawer.selected.item.trailing-icon.color) and unselected; WHILE it is collapsed, from collapsed-selected (comp.navigation-drawer.collapsed-selected.item.container.color, comp.navigation-drawer.collapsed-selected.item.icon-indicator.color, comp.navigation-drawer.collapsed-selected.item.icon.color, comp.navigation-drawer.collapsed-selected.item.label.color) and collapsed-unselected. IF no destination's value equals a value that is not empty THE navigation drawer SHALL draw every destination unselected, and in debug builds report the value. |
NVD-4 | WHILE a destination or a group's row is hovered, keyboard-focused or pressed THE navigation drawer SHALL render its item container, icon indicator, icon, label, trailing content and opacity from the component tokens of its condition in the highest-precedence active state, with precedence pressed over focused over hovered; focus gained by pointer or touch SHALL NOT select the focused state. |
NVD-5 | WHEN a destination or a group's row receives keyboard focus THE navigation drawer SHALL show the focus ring around its item container without animation; focus gained by pointer or touch SHALL NOT show it. |
NVD-6 | THE navigation drawer SHALL make each cell (a destination's or a group's row) its hit area, across the drawer's full width inside its insets, however deep it is nested (NVD-13), and the cell's height with half of comp.navigation-drawer.container.gap.regular above and below it, in both forms, and SHALL NOT let it fall below sys.target.pointer high for a fine pointer WHILE density is regular, nor below sys.target.touch for touch; a system whose geometry gives less SHALL still extend the hit area without changing the drawn cell. WHILE density is compact, for a fine pointer the hit area SHALL be the cell and half of the gap above and below it, the one place where a cell of the drawer is lower than the pointer target (still above the 24 of WCAG 2.5.8); WHERE input is touch, or the platform cannot tell the input type, a compact cell SHALL be drawn at least sys.target.touch high, because cells whose hit areas touch cannot extend them over each other. Hover and press over any part of the hit area SHALL answer on the item container. |
NVD-7 | WHILE a destination's or a group's disabled is true THE navigation drawer SHALL render its item container, icon indicator, icon, label, trailing content and opacity from the disabled component tokens of its condition. |
NVD-8 | WHEN a destination or a group's row is pressed by pointer, touch, Enter or Space THE navigation drawer SHALL show its pressed state without delay and SHALL keep it visible for at least sys.motion.duration.press-hold, even when the press ends sooner. |
NVD-9 | WHILE a destination or a group's row is pressed THE navigation drawer SHALL answer as sys.behavior.pressed-feedback names: overlay applies the pressed tokens to the whole item container at once; ripple grows the pressed state layer, clipped to the item container, from the point of contact (from the center for keyboard activation); dim applies the pressed opacity to the whole destination and draws no state layer; none draws no answer to the press. Under ripple and dim only the item container color stays with the state under the press; icon indicator, icon, label, trailing content and opacity still come from the pressed tokens. Under none every part stays with the state under the press. The ripple grows over comp.navigation-drawer.motion.feedback-duration with comp.navigation-drawer.motion.state-easing, fades over comp.navigation-drawer.motion.state-duration with comp.navigation-drawer.motion.state-easing once the press has ended and press-hold has passed, and appears whole where motion is reduced. |
NVD-10 | THE navigation drawer SHALL ease its item container and icon indicator corners and a modal drawer's end corners by sys.shape.corner-smoothing (0 is a quarter circle, 0.6 the iOS continuous corner; a platform with only the OS curve draws it for any amount above 0) and show its keyboard focus as sys.behavior.focus-style names (ring or glow); a platform that cannot draw a choice SHALL fall back to the first value and state that in its README. |
NVD-11 | THE navigation drawer SHALL be comp.navigation-drawer.container.width wide while expanded and comp.navigation-drawer.collapsed.container.width.regular wide while collapsed, beside the start inset, and the full height of its parent, filled with its variant's container color (comp.navigation-drawer.container.color.standard or comp.navigation-drawer.container.color.modal), raised by its variant's elevation (comp.navigation-drawer.container.elevation.standard, comp.navigation-drawer.container.elevation.modal), with its end corners rounded by its variant's shape (comp.navigation-drawer.container.shape.standard, comp.navigation-drawer.container.shape.modal) and square start corners, and edged at its end by comp.navigation-drawer.outline.width of its variant's outline color (comp.navigation-drawer.outline.color.standard, comp.navigation-drawer.outline.color.modal); right-to-left layouts SHALL put it at the right edge, mirrored. |
NVD-12 | THE navigation drawer SHALL lay out, comp.navigation-drawer.container.padding-inline from its start and end and comp.navigation-drawer.container.padding-block from its top and bottom (measured to the first and last cell, not to their hit areas), its header (NVD-38) and then, comp.navigation-drawer.header.gap below it (at the padding WHILE the header is empty), its items in reading order: destinations, groups and sections, a section laying out its divider, its heading and its items in that order, and an open group its row and then its items; it SHALL put comp.navigation-drawer.container.gap.regular between two cells, and WHILE the items are taller than the space below the header it SHALL scroll them and keep the header in place, in both forms. |
NVD-13 | WHILE the drawer is expanded THE navigation drawer SHALL draw each destination as an item container that ends comp.navigation-drawer.container.padding-inline inside the drawer's end edge and starts comp.navigation-drawer.container.padding-inline inside its start edge, further in by the row's indent (NVD-69) WHILE highlight is indented and at that same place at every level WHILE highlight is full (NVD-70), its content starting the row's indent further in either way; comp.navigation-drawer.item.container.height.regular high unless its label's lines need more, with corners comp.navigation-drawer.item.container.shape, holding in reading order: its icon, centered on the icon column's center line (half of comp.navigation-drawer.collapsed.container.width.regular from the drawer's start edge, the row's indent further, and a chevron's room and comp.navigation-drawer.item.gap further WHILE chevron is start) and on the cell's icon line (NVD-31), with its icon indicator centered behind it and taking no space; a group's start chevron before it WHILE chevron is start (NVD-68); its label in comp.navigation-drawer.item.label.typescale.regular, comp.navigation-drawer.item.gap after the icon or the icon's room (NVD-71), or comp.navigation-drawer.item.padding-inline.regular from where the row's content starts WHILE it has neither, on one line unless labelWrap is true (NVD-75), and its supporting text (NVD-74); and its trailing content (NVD-43) at the end, before an end chevron, comp.navigation-drawer.item.gap after the label and comp.navigation-drawer.item.padding-inline.regular from the item container's end. Right-to-left layouts SHALL mirror it. |
NVD-14 | THE navigation drawer SHALL draw each icon at comp.navigation-drawer.item.icon.size.regular with the family and fill of its condition (selected for the selected destination, unselected for every other), sys.icon.weight, and an optical size clamped between sys.icon.optical-size.min and sys.icon.optical-size.max. |
NVD-15 | WHILE a destination has trailing content (its trailingText, or its trailing slot's content) THE navigation drawer SHALL expose it as part of the destination's description, after its name, its state and its badge's description, and not as an element of its own, and SHALL keep drawing it WHILE the destination is disabled. |
NVD-16 | WHILE a section's title is not empty THE navigation drawer SHALL draw it as the section's heading in comp.navigation-drawer.heading.typescale and comp.navigation-drawer.heading.color, in a row at least comp.navigation-drawer.heading.height.regular high with the text vertically centered and starting where the destinations' labels start WHILE they have no icon (comp.navigation-drawer.item.padding-inline.regular inside the drawer's inner edge), and SHALL expose it as a heading that is not focusable; WHILE the drawer is collapsed it SHALL keep the row at its height, draw no text in it and hide it from assistive technology; WHILE the title is empty the section SHALL draw no heading row. THE navigation drawer SHALL set the heading's letter-spacing by the script of its text, as every title is set (PRS-20): no negative letter-spacing WHERE its language is Chinese, Japanese or Korean, and none WHERE its script joins its letters or stacks marks on them. |
NVD-17 | WHILE a section's divider is true THE navigation drawer SHALL draw a divider component before the section, across the drawer's inner width in either form, and leave it as the divider component draws it; IF a section holds a section, or a group holds a section, THE navigation drawer SHALL render the inner section's items in its place, and in debug builds report that sections do not nest and do not go inside a group. |
NVD-18 | WHILE variant is standard THE navigation drawer SHALL take its width in the layout, in its current form (NVD-30), WHILE open is true and no width and no presence to assistive technology or focus WHILE open is false; WHEN open changes it SHALL slide in or out while the content beside it resizes, over comp.navigation-drawer.motion.enter-duration with comp.navigation-drawer.motion.enter-easing when opening and comp.navigation-drawer.motion.exit-duration with comp.navigation-drawer.motion.exit-easing when closing, and at once where motion is reduced. A standard drawer SHALL draw no scrim, SHALL NOT keep focus inside it and SHALL NOT emit close. |
NVD-19 | WHEN open becomes true WHILE variant is modal THE navigation drawer SHALL, WHILE collapsible is false, slide in from its start edge over the content and fade its modal layer's scrim in comp.navigation-drawer.scrim.color and comp.navigation-drawer.scrim.blur in over the rest of the window in step (MDL-1, MDL-7), over comp.navigation-drawer.motion.enter-duration with comp.navigation-drawer.motion.enter-easing (at once where motion is reduced), and WHILE collapsible is true widen from its column as NVD-40 says; in both cases it SHALL move focus to the selected destination (or the group row that shows it, NVD-47) or else to its first focusable element, SHALL keep focus inside the drawer while it is open, and SHALL make everything behind it inert to pointer, touch, keyboard and assistive technology, as its modal layer does (MDL-2, MDL-3, MDL-4). |
NVD-20 | WHEN the user presses the scrim, presses Escape, uses the platform's back action (as its modal layer answers them, MDL-6), activates the menu button (NVD-37), or drags the drawer toward its start edge past half its width or flings it that way, WHILE variant is modal and open is true, THE navigation drawer SHALL close and emit close exactly once; on the web it SHALL set open to false itself, as a dialog does, and a controlled platform SHALL leave open to the caller, who sets it from close. A fling is a release faster than the platform's minimum fling velocity (Android's ViewConfiguration.getScaledMinimumFlingVelocity, Flutter's kMinFlingVelocity) or, where the platform names none (the web, SwiftUI, React Native), 0.5 points per millisecond, and the drawer follows a drag only beyond the platform's touch slop (Android's ViewConfiguration.getScaledTouchSlop, Flutter's kTouchSlop) or, where the platform names none, 8 points, as BSH-9 says for the bottom sheet. A release's velocity is the pointer's over its last moves: WHERE the pointer has not moved for longer than the time after which the platform's velocity tracker takes a pointer as stopped (40 milliseconds in Android's VelocityTracker, Jetpack Compose's VelocityTracker and Flutter's VelocityTracker) or, where the platform names none (the web, SwiftUI, React Native), 40 milliseconds before the release THE navigation drawer SHALL take the release as having no velocity, so that a drag that stops where it is wanted and is let go there is no fling, however fast it moved before it stopped. |
NVD-21 | WHEN the user activates a destination WHILE variant is modal THE navigation drawer SHALL emit change or reselect as NVD-1 says, and then close and emit close as NVD-20 says; an activation of a link that NVD-60 does not count, which opens the link somewhere else, SHALL leave the drawer open. |
NVD-22 | WHEN a modal drawer closes THE navigation drawer SHALL, WHILE collapsible is false, slide out and fade its scrim out over comp.navigation-drawer.motion.exit-duration with comp.navigation-drawer.motion.exit-easing, and WHILE collapsible is true narrow back to its column as NVD-40 says (at once where motion is reduced), and SHALL return focus to the element that had it when the drawer opened, or, WHERE that element is gone, to where the platform puts focus by default, as its modal layer does (MDL-5). |
NVD-23 | THE navigation drawer SHALL expose each destination as one element named by its label in both forms, with its selected state and its position among the items of its level, and its icon hidden: a link WHILE its href is not empty (NVD-59) and a button otherwise. On the web it is an anchor or a button inside a navigation landmark named by the drawer's label, the selected destination carrying aria-current="page"; on Apple platforms, Android, Flutter and React Native a button, or a link, with the selected state. The selected destination is the place the product is showing, in a product of one screen and in a site of many pages alike: THE navigation drawer SHALL have no second state and no second mark for a current page, and SHALL expose exactly one destination, or none, as current. It SHALL expose groups as NVD-46 says. WHILE variant is modal and open is true THE navigation drawer SHALL also be a modal dialog named by the drawer's label (the web's dialog element; the modal trait or pane title elsewhere). |
NVD-24 | WHILE a destination's label is not empty THE navigation drawer SHALL expose it as the destination's accessible name, over a name the product gives the destination on the element (aria-label or aria-labelledby); WHILE a destination's label is empty and the product gives the destination a name of its own on the element — aria-label, or aria-labelledby naming an element — THE navigation drawer SHALL expose that name as its accessible name; WHILE a destination's label is empty and the product gives it none THE navigation drawer SHALL still render it, and in debug builds report that it has no accessible name; WHILE the drawer's label is empty, variant is modal and the product gives the drawer no name of its own on the element — aria-label, or aria-labelledby naming an element — it SHALL report that the dialog has no name. |
NVD-25 | THE navigation drawer SHALL extend its container under the system insets at its start, top and bottom and SHALL place its header, destinations and sections inside them. |
NVD-26 | WHEN variant or density names a value that the active design system does not have THE navigation drawer SHALL render with that axis's default value's tokens, and in debug builds report the unknown value. |
NVD-27 | WHILE the text size is enlarged THE navigation drawer SHALL keep both its widths, grow each cell and section heading with its text in both forms alike (their heights are minimums, NVD-31), keep one-line labels, one-line supporting text and short labels on one line and cut them (NVD-75), and SHALL NOT scale its icons, icon indicators or trailing glyphs; WHERE the platform offers a large-content viewer for bar items (iOS) a long press on a collapsed destination SHALL show its icon and label enlarged. |
NVD-28 | WHEN open changes from false to true WHILE variant is standard THE navigation drawer SHALL move focus to the selected destination or else to its first focusable element, and WHEN open then changes to false while focus is inside it SHALL return focus to the element that had it when the drawer opened, or, WHERE that element is gone, to where the platform puts focus by default; Tab and Shift+Tab SHALL move focus out of an open standard drawer without closing it (a standard drawer is a layout region, not an overlay). |
NVD-29 | IF two destinations have the same value THE navigation drawer SHALL treat the first of them in reading order as the one the drawer's value selects, and in debug builds report the repeated value. |
NVD-30 | WHILE collapsible is false THE navigation drawer SHALL be expanded and ignore expanded; WHILE collapsible is true and variant is standard it SHALL be expanded WHILE expanded is true and collapsed WHILE expanded is false; WHILE collapsible is true and variant is modal it SHALL be collapsed, in the layout, WHILE open is false, and expanded over the content WHILE open is true (NVD-40), ignoring expanded. |
NVD-31 | WHILE collapsible is true THE navigation drawer SHALL give every cell the same height and the same place in both forms, so that each icon, each header button and the main action's glyph is drawn at exactly the same point expanded, collapsed and while moving between them: a cell's icon line SHALL lie below its top by the larger of half the expanded row's height (NVD-13) and comp.navigation-drawer.collapsed.item.container.padding-block.regular plus half of comp.navigation-drawer.item.icon-indicator.height.regular, and the cell SHALL reach below that line by the larger of half the expanded row's height and half of comp.navigation-drawer.item.icon-indicator.height.regular plus, WHILE collapsedLabels is not never, comp.navigation-drawer.collapsed.item.gap and one line of comp.navigation-drawer.collapsed.item.label.typescale, plus comp.navigation-drawer.collapsed.item.container.padding-block.regular; both forms SHALL center the icon on that line. A section heading's row, and the header slot's row, SHALL keep their heights in both forms. The one exception is an open group, whose items the collapsed drawer does not draw (NVD-47): the cells after it move up while the drawer collapses and back while it expands. WHILE collapsible is false a cell SHALL be the expanded row alone. |
NVD-32 | WHILE the drawer is collapsed THE navigation drawer SHALL draw only the cells that are not inside a group (top-level destinations and groups, in a section or not), each as an item container comp.navigation-drawer.collapsed.item.container.width.regular wide, centered in the icon column, with corners comp.navigation-drawer.collapsed.item.container.shape, each at most half its height, holding, comp.navigation-drawer.collapsed.item.container.padding-block.regular below its top, the icon indicator, comp.navigation-drawer.item.icon-indicator.width.regular wide and comp.navigation-drawer.item.icon-indicator.height.regular high with corners comp.navigation-drawer.item.icon-indicator.shape, its icon centered in it on the cell's icon line; and WHILE its short label is drawn (NVD-33), comp.navigation-drawer.collapsed.item.gap below the icon indicator, the short label centered on one line in comp.navigation-drawer.collapsed.item.label.typescale, truncated at its end with an ellipsis inside comp.navigation-drawer.collapsed.item.container.padding-inline, and comp.navigation-drawer.collapsed.item.container.padding-block.regular below it. It SHALL draw no trailing content. Every part is laid out in every system; a transparent color hides a part without changing the layout. |
NVD-33 | WHILE the drawer is collapsed and collapsedLabels is never THE navigation drawer SHALL draw no short label, so that a collapsed cell is its expanded row with the label and trailing content gone; WHILE it is selected it SHALL draw only the short label of the cell drawn selected (the selected destination, or the group that shows it, NVD-47); WHILE it is always it SHALL draw every cell's short label. Every destination's label SHALL remain its accessible name. |
NVD-34 | THE navigation drawer SHALL draw a collapsed cell's shortLabel, or its label WHILE shortLabel is empty, and SHALL keep its label as its accessible name in both forms; IF shortLabel is not empty and is not a part of label (ignoring case) THE navigation drawer SHALL still draw it, and in debug builds report that the visible name is not part of the accessible name. |
NVD-35 | WHEN the drawer changes form (NVD-30) THE navigation drawer SHALL, over comp.navigation-drawer.motion.expand-duration with comp.navigation-drawer.motion.expand-easing: move its end edge between comp.navigation-drawer.collapsed.container.width.regular and comp.navigation-drawer.container.width, a standard drawer's content beside it resizing with it; keep every icon, header button and the main action's glyph in place (NVD-31); change each item container between its two sizes and corners as one shape around the same icon line (WHERE the two forms give it the same height and corners, as the default system does, its end edge alone moves), and cross-fade its color and those of its icon indicator, icon and label from one form's condition to the other's; clip the expanded labels, trailing content, headings' text and the header slot at the moving edge and fade them out over the first half of the change when collapsing, and in over the second half when expanding; and fade the short labels in over the second half when collapsing, and out over the first half when expanding. It SHALL NOT stretch, reshape or recolor a header button on the way (NVD-38). WHERE motion is reduced it SHALL change form at once. |
NVD-36 | WHEN the drawer changes form THE navigation drawer SHALL keep focus where it is, and SHALL take what the collapsed form does not draw (the header slot's content, the headings' text, trailing content, the chevron of a group that is a destination, the items inside groups) out of the focus order and away from assistive technology WHILE it is collapsed; IF focus is on such content when the drawer collapses THE navigation drawer SHALL move it to the menu button (NVD-37), or else to the first focusable element of the drawer. A destination's role, name and state SHALL be the same in both forms. |
NVD-37 | WHILE collapsible is true THE navigation drawer SHALL treat its first header button as its menu button and expose it as expanded or collapsed, controlling the drawer (aria-expanded and aria-controls on the web; the expanded state elsewhere); WHEN the user activates it, after the button's own click, THE navigation drawer SHALL emit expandedChange exactly once with the form asked for (true to expand, false to collapse) WHILE variant is standard or the drawer is not open, and on the web apply it itself (expanded for a standard drawer, open for a modal one); WHILE a modal drawer is open it SHALL close as NVD-20 says instead. WHILE collapsible is true and the drawer has no header button it SHALL report in debug builds that its user cannot change its form. |
NVD-38 | THE navigation drawer SHALL lay out its header from the top: its header buttons stacked in the icon column, each centered on its center line, comp.navigation-drawer.header.item-gap apart, and each drawn as the Button it is in both forms and while the drawer moves between them: the Button's own size, shape (a circle in the default system) and colors, never stretched to a row's width, never given an item container's shape and never filled as an active indicator; WHILE expanded, the header slot's content in the first header button's row, comp.navigation-drawer.item.gap after it (from comp.navigation-drawer.container.padding-inline WHILE there is no header button), vertically centered, the row as tall as the taller of the two, the slot's box giving what it holds comp.navigation-drawer.header.typescale and comp.navigation-drawer.header.color as an inherited text style, so that plain text placed there is drawn in the system's title style and an element that sets its own style keeps it; and then the main action (NVD-39), comp.navigation-drawer.header.item-gap below. A header-button or main-action item SHALL go to the header wherever it stands among the items, and the header's content SHALL come first in reading and focus order and keep its own semantics. |
NVD-39 | WHILE the drawer holds a main-action item THE navigation drawer SHALL draw it as the Main Action Button it is, collapsed to its icon (extended false) WHILE the drawer is collapsed and extended with its label WHILE the drawer is expanded, changing with the drawer over comp.navigation-drawer.motion.expand-duration; it SHALL place the button so that the center of its glyph lies on the icon column's center line, the line the destinations' icons are centered on (NVD-13, NVD-31), in both forms, at every size of the button, in every density and design system and in either layout direction: the icon column's center line lying a chevron's room and comp.navigation-drawer.item.gap further from the start WHILE chevron is start (NVD-68): WHILE the drawer is collapsed the button's start SHALL lie half the column's width less half the button's height (the side of its collapsed square, comp.main-action-button.container.height.medium for medium, and so on) from the drawer's start edge, and WHILE it is expanded half the column's width less the button's padding before a leading glyph and half that glyph (comp.main-action-button.container.padding-inline-start-with-icon.medium and comp.main-action-button.icon.size.medium for medium, and so on), each read from the button's own tokens for its size and never measured or written as a number; WHEN the drawer changes form the button's start SHALL move between the two over comp.main-action-button.motion.resize-duration with comp.main-action-button.motion.resize-easing, the motion with which the button moves its glyph between the middle and its side (MAB-14), at once where motion is reduced. A button whose collapsed square is wider than the icon column (a large one in the default system's columns) SHALL still be placed so, reaching past the column's start edge, and in debug builds THE navigation drawer SHALL report it; a button whose glyph is trailing SHALL be placed so while collapsed and, while expanded, start where it starts collapsed, and in debug builds THE navigation drawer SHALL report that its glyph leaves the column while expanded. Its label SHALL remain its accessible name in both forms. IF the drawer holds more than one main-action item THE navigation drawer SHALL draw the first, and in debug builds report the rest. |
NVD-40 | WHILE variant is modal and collapsible is true THE navigation drawer SHALL take its column's width in the layout and draw the column as a standard drawer's (comp.navigation-drawer.container.color.standard, comp.navigation-drawer.container.elevation.standard, comp.navigation-drawer.outline.color.standard) WHILE open is false; WHEN open becomes true it SHALL widen over the content, without resizing it, from the column to comp.navigation-drawer.container.width in the modal variant's container, elevation, shape and outline, and fade its modal layer's scrim in comp.navigation-drawer.scrim.color and comp.navigation-drawer.scrim.blur in over the rest of the window (MDL-1), both over comp.navigation-drawer.motion.expand-duration with comp.navigation-drawer.motion.expand-easing, changing its parts as NVD-35 says; WHEN it closes it SHALL narrow back to the column and fade the scrim out over the same time; WHERE motion is reduced it SHALL do both at once. While it widens and while it narrows its container color, elevation, end corners and outline SHALL change between the column's and the modal variant's over the same motion, in step with its width, so that no frame changes its look at once: its first frame opening is drawn as the column at rest, and its last frame closing as the column at rest, which then stays where it is. WHEN it first appears with open true it SHALL draw itself open in its first frame, at comp.navigation-drawer.container.width over its full scrim, without widening from a column it never showed. NVD-19 to NVD-22 apply to it while it is open. |
NVD-41 | WHEN the selected destination changes THE navigation drawer SHALL change the new destination's item container to its selected color and the previous one's to its unselected color in place, each at its full size and shape throughout, and change icon, label and trailing content colors and icon fill, over comp.navigation-drawer.motion.state-duration with comp.navigation-drawer.motion.state-easing, in either form; it SHALL NOT grow, shrink, slide or otherwise resize an item container to show a selection. THE icon indicator, which the default system leaves transparent, SHALL grow in width from its center to its full width, at its full height throughout, on the new destination and fade out on the previous one, over comp.navigation-drawer.motion.selection-duration with comp.navigation-drawer.motion.selection-easing; WHILE the drawer is collapsed and collapsedLabels is selected the short labels SHALL appear and disappear over the same time without moving any cell (NVD-31); WHERE motion is reduced it SHALL show the new selection at once. |
NVD-42 | WHILE a destination's badge is true THE navigation drawer SHALL draw a Tanrei badge anchored to its icon in both forms, above the icon indicator, as the badge component draws one whose count is the destination's badgeCount and whose label is its badgeLabel, SHALL keep it while the destination is disabled, and SHALL expose the badge's description (badgeLabel, or the displayed count when it is empty) as part of the destination's own description, after its name and state. |
NVD-43 | WHILE a destination's trailing slot holds content THE navigation drawer SHALL draw it at the end of the expanded row: a glyph at comp.navigation-drawer.item.trailing-icon.size.regular in its condition's trailing icon color (comp.navigation-drawer.unselected.item.trailing-icon.color, comp.navigation-drawer.selected.item.trailing-icon.color), anything else as it draws itself; WHILE the slot is empty and trailingText is not empty it SHALL draw trailingText there, on one line and never truncated, in comp.navigation-drawer.item.trailing-text.typescale and its condition's trailing text color (comp.navigation-drawer.unselected.item.trailing-text.color, comp.navigation-drawer.selected.item.trailing-text.color); IF both are given it SHALL draw the slot's content and in debug builds report trailingText. IF the slot holds a focusable element THE navigation drawer SHALL keep it out of the focus order, and in debug builds report that trailing content is not interactive. |
NVD-44 | THE navigation drawer SHALL draw a group's row as a destination's in either form (NVD-13, NVD-32), with its icon, label and short label, its trailing content (NVD-43, a group's trailing slot and trailingText as a destination's), and its chevron where chevron puts it (NVD-68): the icon set's expand_more at comp.navigation-drawer.item.trailing-icon.size.regular in its condition's trailing icon color, turned half a turn WHILE the group is open; WHILE the group is open and the drawer expanded it SHALL draw the group's items below its row, each one's row starting one step of indent further in (NVD-69, NVD-70); WHEN open changes it SHALL reveal or hide those items, moving the cells below, and turn the chevron, over comp.navigation-drawer.motion.disclosure-duration with comp.navigation-drawer.motion.disclosure-easing, at once where motion is reduced. A group's row SHALL answer hover, focus and press, show its focus ring, and follow press-hold, pressed-feedback, corner smoothing and focus style exactly as a destination does (NVD-4 to NVD-10), from the unselected condition unless NVD-47 says otherwise. |
NVD-45 | WHEN the user activates, WHILE expandable is true and the drawer is expanded, a group's row by pointer, touch, Enter or Space and the group is not a destination (NVD-66), or activates the chevron of a group that is one (NVD-67), or the icon of a group while chevron is none (NVD-68), THE navigation drawer SHALL emit the group's toggle exactly once with its new open state, SHALL NOT emit change, reselect or close, and on the web SHALL set the group's open itself (a controlled platform leaves it to the caller); WHEN focus is on a closed group's row and the user presses the arrow key toward the end of the line (Right in a left-to-right layout) it SHALL open the group, and on an open group's row the arrow key toward the start SHALL close it; WHEN focus is on an item inside an open group and the user presses the arrow key toward the start, it SHALL move focus to that group's row. WHILE a group's disabled is true THE navigation drawer SHALL NOT emit toggle, change or reselect for it, SHALL NOT make its row or its chevron focusable and SHALL expose it as disabled. |
NVD-46 | THE navigation drawer SHALL expose a group's row as one button named by its label, with its expanded or collapsed state and its icon and chevron hidden, controlling its items, and its items as a list named by the group's label inside the drawer's list: on the web a button with aria-expanded and aria-controls and a nested list labelled by it; on Apple platforms a button whose value is expanded or collapsed, as a disclosure group reads; on Android the expanded state with the expand and collapse actions; in Flutter the expanded semantics flag; in React Native accessibilityState.expanded. WHILE a group is a destination (NVD-66) THE navigation drawer SHALL instead expose its row as that destination, as NVD-23 says (a link while it has an href and a button otherwise, named by its label, with its selected state), and its chevron as one more button, named by the group's label, with the group's expanded or collapsed state and controlling its items, which stay a list named by the group's label: on the web the row is the link or button with aria-current and the chevron a button with aria-expanded and aria-controls, each its own Tab stop, as the disclosure navigation menu with top-level links of the WAI-ARIA Authoring Practices is; on the other platforms the row carries the selected state and the chevron the expanded state with the expand and collapse actions. WHILE expandable is false, NVD-72 says instead what a group's row is. WHILE a group is closed, or the drawer collapsed, its items SHALL be neither exposed nor focusable. WHILE a group's label is not empty THE navigation drawer SHALL expose it as its row's accessible name, over a name the product gives the group on the element (aria-label or aria-labelledby); WHILE a group's label is empty and the product gives the group a name of its own on the element — aria-label, or aria-labelledby naming an element — THE navigation drawer SHALL expose that name as its row's accessible name; WHILE a group's label is empty and the product gives it none THE navigation drawer SHALL still render it, and in debug builds report that it has no accessible name. |
NVD-47 | WHILE the selected destination is inside a closed group, or inside a group WHILE the drawer is collapsed, THE navigation drawer SHALL draw the row that shows it (the outermost closed group that holds it; collapsed, its top-level group) from its form's selected condition; WHILE the drawer is collapsed it SHALL draw each top-level group as one cell and none of its items; WHEN the user activates the cell of a group that is not a destination (NVD-66) WHILE the drawer is collapsed THE navigation drawer SHALL emit expandedChange with true, and the group's toggle with true WHILE it is closed, SHALL on the web apply both itself, and SHALL move focus to the group's row once the drawer is expanded. |
NVD-48 | IF groups nest more than three levels deep THE navigation drawer SHALL still render them, indenting each level's content by comp.navigation-drawer.item.nest-indent.regular, and in debug builds report the depth. |
NVD-49 | WHILE the drawer is collapsed and a top-level destination or group has no icon THE navigation drawer SHALL still draw its cell, with an empty icon indicator and, WHERE NVD-33 draws one, its short label, and in debug builds report that a collapsible drawer needs an icon on every top-level destination and group. |
NVD-50 | THE navigation drawer SHALL take its layout direction from where it is used — the direction of the nearest ancestor that sets one, and the platform's own where none does — and SHALL have no direction setting of its own; WHEN that direction changes while the navigation drawer is shown THE navigation drawer SHALL draw itself for the new direction at once, without a motion of its own, keeping its expanded or collapsed form, its open state, the selected destination and its focus. |
NVD-51 | WHERE the layout direction is right-to-left THE navigation drawer SHALL draw a destination's and a group's icon mirrored left to right exactly when the system's icon set marks that glyph's name as mirrored or the product forces mirroring for that use, and unmirrored when the product forbids it: the icon helper mirrors the glyph inside its own box, about the box's vertical centre line, changing neither its place, size, color and fill nor the order NVD-13 gives. THE navigation drawer SHALL NOT mirror a glyph itself, and SHALL NOT mirror content the product gives as an image or a view of its own rather than by a glyph's name. A group's chevron (expand_more, NVD-44) is not marked and is never mirrored; the product's own content in a trailing slot is the product's to mirror, and a header button's and the main action's glyphs are mirrored by those components (BTN-19, MAB-22). |
NVD-52 | THE navigation drawer SHALL lay out a destination's and a group's label and short label, a section's heading, a destination's trailing text and the header's text as text of its own direction, isolated from the text around it: each takes the base direction of its first strong character, or the layout direction where it has none, so that a left-to-right word, a number with its sign or unit, a telephone number and an address keep their own order in a right-to-left layout and reorder nothing beside them; THE navigation drawer SHALL still place each and align its lines by the layout direction, not by the text's own, and SHALL cut a short label that does not fit (NVD-32) at the end of its own direction, so that a left-to-right label in a right-to-left layout loses its right end and never its beginning. |
NVD-53 | WHILE responsive is true THE navigation drawer SHALL choose its presentation from the width of the window it is in, and SHALL ignore variant: WHILE the window is at least comp.navigation-drawer.breakpoint.expanded wide it SHALL be a standard drawer that is shown whatever open says (the standard presentation: NVD-18's place in the layout, in the form NVD-30 gives a standard drawer); WHILE the window is narrower than that, at least comp.navigation-drawer.breakpoint.collapsed wide, and collapsible is true, it SHALL be a collapsible modal drawer (the column presentation: its column in the layout, widening over the content WHILE open is true, NVD-40); and otherwise it SHALL be a modal drawer that is not collapsible (the modal presentation: nothing in the layout, shown over the content WHILE open is true, NVD-19 to NVD-22). In each presentation THE navigation drawer SHALL draw and behave exactly as the drawer whose variant and collapsible it stands for, from that variant's tokens. WHILE responsive is false THE navigation drawer SHALL NOT read the window's width. |
NVD-54 | WHEN the window's width takes a responsive drawer from one presentation to another THE navigation drawer SHALL draw the new presentation at once, without the motions of NVD-18, NVD-35 and NVD-40; SHALL enter it closed — WHERE open is true it SHALL emit close exactly once, the web setting open to false itself and a controlled platform leaving it to the caller (NVD-20); SHALL keep expanded, which only the user's request (NVD-37) and the product change, so that the standard presentation returns in the form it was left in; SHALL keep value and every group's open; and SHALL emit presentationChange exactly once with the new presentation (standard, column or modal). It SHALL also emit presentationChange exactly once WHEN the presentation is first decided. IF keyboard focus is on something the new presentation does not show THE navigation drawer SHALL move it to the menu button (NVD-37), or else to the first focusable element it still shows, and WHERE it shows nothing SHALL leave focus to the platform; focus that an open modal presentation kept inside the drawer SHALL be free to leave once the drawer is standard. |
NVD-55 | THE navigation drawer SHALL hold three things apart WHILE responsive is true: the presentation, which it derives from the window's width alone, never stores, never writes into variant, open or expanded, and exposes read-only; open, which is transient, false unless the product or the menu button has just asked, and false again after every change of presentation and every close (NVD-20, NVD-21); and expanded, the user's choice of form for the standard presentation, which THE navigation drawer SHALL NOT persist beyond its own lifetime — a product that wants the choice remembered stores what expandedChange carries and sets expanded from it. WHEN a responsive drawer first appears THE navigation drawer SHALL draw the presentation of the current width in its first frame, without motion and without emitting close; WHERE it is rendered before the width is known (a page rendered on a server) it SHALL render no modal presentation open, SHALL make nothing inert, and SHALL decide both only once the width is known. |
NVD-56 | WHILE the drawer is collapsed and a cell draws no short label (NVD-33), and WHILE it is expanded and a row's label or supporting text is cut (NVD-75), THE navigation drawer SHALL show that cell's label (and, where its supporting text is cut, its supporting text after it), WHEN the cell is hovered with a fine pointer or receives keyboard focus, as the platform shows the name of a control that is an icon alone (a plain tooltip beside the cell, toward the content, on the web and on desktop; nothing more than the large-content viewer of NVD-27 on a touch platform), and SHALL NOT add it to the cell's accessible name or description, which already hold it. |
NVD-57 | WHEN the navigation drawer first appears in the layout with a selected destination, and WHEN value changes while it is shown, THE navigation drawer SHALL bring the row that shows the selection (the selected destination, or the group's row NVD-47 names) into view: IF that row is not wholly inside the space its items scroll in THE navigation drawer SHALL scroll them so that the row is centered in that space, as far as the scroll range allows, and otherwise it SHALL NOT scroll at all, so that a drawer whose selection is already in view stays where it is from one page to the next. It SHALL do so at once, without motion, WHEN the drawer first appears in its first frame (in the order NVD-62 gives), and SHALL NOT move keyboard focus. A modal presentation is brought there WHEN it opens, by the focus NVD-19 gives. |
NVD-58 | WHILE revealSelected is true THE navigation drawer SHALL, WHEN it first appears with a selected destination and WHEN value changes to a destination, draw every closed group that holds that destination open — and, WHERE the selected destination is a group (NVD-66), that group as well, so that a site's sidebar shows the pages of the section whose page is shown — whatever its open said (a state the product gave back included, NVD-62), and SHALL emit each such group's toggle exactly once with true, the web setting the group's open itself and a controlled platform leaving its open to the caller, as NVD-45 says; WHEN the drawer first appears it SHALL draw them open in its first frame, without the motion of NVD-44, and afterwards with it. It SHALL NOT emit change, reselect or close for it, and SHALL NOT open again a group the user closes afterwards until value changes: that group's row then shows the selection (NVD-47). WHILE the drawer is collapsed it SHALL open them all the same, for the form in which they are drawn. WHILE revealSelected is false THE navigation drawer SHALL leave every group as its open says. |
NVD-59 | WHILE a destination's href is not empty THE navigation drawer SHALL make it a link to that address and not a button. On the web it SHALL be an anchor element with that address, whose behaviours are the browser's own — following it on a plain click, a touch or Enter; opening it in another tab or window by a modified click or a middle click; the link's context menu; dragging it; copying its address; showing its address on hover — and THE navigation drawer SHALL NOT prevent, replace or imitate any of them; Space SHALL NOT activate a link. On other platforms it SHALL be the platform's own link (SwiftUI's Link; on Compose, Flutter and React Native an element with the platform's link semantics whose address is opened by the platform's opener), as BTN-22 says for a link button. THE navigation drawer SHALL draw a link exactly as it draws a button destination, from the same tokens in every state and both forms (NVD-3, NVD-4, NVD-7 to NVD-9, NVD-13, NVD-32), SHALL draw no look of its own for a link the user has visited, and SHALL give its hit area (NVD-6) to the link. WHILE a link's value is empty THE navigation drawer SHALL take its href as its value, for value, change, reselect and NVD-29. WHILE a link's disabled is true it SHALL keep the link role with the disabled state and no destination, and SHALL open nothing by any means the platform gives a link (NVD-2; on the web the anchor carries no address). |
NVD-60 | WHEN the user activates a link destination THE navigation drawer SHALL count it as an activation (NVD-1, NVD-21) only WHILE it follows the link in the place where the product is shown: a click with the primary button and no modifier key, a touch, Enter, or the default action of assistive technology, on a link whose target is same and that asks for no download. It SHALL then emit change or reselect exactly once, carrying the destination's value and its href, before the link is followed, and SHALL NOT hold the link back for sys.motion.duration.press-hold; SHALL NOT write value itself on any platform, because where the product is, is the product's to say, and the page or the route shown next sets value; and SHALL let the link be followed unless the product cancels the event (preventDefault on the web), as a product does that moves between its pages without loading a document. For every other activation of a link — a modified or a middle click, a link whose target is new, a download — THE navigation drawer SHALL emit neither change nor reselect, SHALL NOT close, and SHALL keep value and the drawn selection as they are. |
NVD-61 | THE navigation drawer SHALL hold how far its items are scrolled from their start as scrollOffset, in the units of its layout: it SHALL give the present distance whenever the product reads it, and WHEN the product sets it, before the drawer first appears included, SHALL scroll there at once and without motion, held inside the scroll range, the header staying in place (NVD-12). Scrolling by the user SHALL emit no event. WHILE the items can scroll, a scroll that reaches either end of them SHALL NOT go on to scroll what is beside or behind the drawer. WHEN a group opens or closes (NVD-44) THE navigation drawer SHALL keep that group's row where it is in view and move only the cells after it; WHEN keyboard focus moves to a cell that is not wholly in view it SHALL scroll that cell into view by the least distance that shows it whole. |
NVD-62 | THE navigation drawer SHALL treat scrollOffset and every group's open as the state of one view, as NVD-55 treats expanded: it SHALL keep neither beyond its own lifetime and SHALL write neither to any storage. A product whose pages are separate documents keeps what each group's toggle carries, and what scrollOffset reads when a page is left, and gives them back as the groups' open and the drawer's scrollOffset when the next page is rendered. WHEN the drawer first appears THE navigation drawer SHALL build its first frame in this order — every group as its open says; then the groups NVD-58 opens; then the items at scrollOffset; then the selection brought into view (NVD-57) — and SHALL draw it without the motions of NVD-41 and NVD-44 and without emitting change, reselect or close. |
NVD-63 | WHILE a destination is a link and its target is new THE navigation drawer SHALL open its href in a new context, as BTN-24 says for a link button (on the web a new tab or window that is given no handle to the page that opened it), and, WHILE the drawer is expanded and the destination has neither trailing slot content nor trailingText, SHALL draw the glyph open_in_new of the system's icon set as its trailing content, as NVD-43 draws a glyph: at comp.navigation-drawer.item.trailing-icon.size.regular, in its condition's trailing icon color (comp.navigation-drawer.unselected.item.trailing-icon.color, comp.navigation-drawer.selected.item.trailing-icon.color), through the icon helper, which mirrors it in a right-to-left layout because the icon set marks its name, and hidden from assistive technology; WHILE the product has put trailing content there THE navigation drawer SHALL draw no mark of its own. Whether a mark is drawn or not, and in both forms, it SHALL expose targetLabel as part of the destination's description, after its badge's description and its trailing content (NVD-15), and WHILE targetLabel is empty SHALL still render and in debug builds report that a link that opens a new context does not say so. WHILE target is same THE navigation drawer SHALL draw no mark and SHALL ignore targetLabel. |
NVD-64 | WHEN a destination's target names a value the navigation drawer does not define THE navigation drawer SHALL treat it as same, and in debug builds report the unknown value. IF a destination's href is only white space, or names a script to run rather than a place to go (the web's javascript: scheme), or cannot be read as an address by the platform, THE navigation drawer SHALL make the destination a button without a destination, and in the last two cases report it in debug builds, as BTN-26 says for a button. WHILE a destination's href is empty THE navigation drawer SHALL ignore its target and targetLabel. |
NVD-65 | THE navigation drawer SHALL draw its cells, its section headings, the gaps between its cells, its nesting indent and its collapsed column from the tokens of its density: WHILE density is regular from comp.navigation-drawer.container.gap.regular, comp.navigation-drawer.item.container.height.regular, comp.navigation-drawer.item.padding-inline.regular, comp.navigation-drawer.item.padding-block.regular, comp.navigation-drawer.item.nest-indent.regular, comp.navigation-drawer.item.icon.size.regular, comp.navigation-drawer.item.icon-indicator.width.regular, comp.navigation-drawer.item.icon-indicator.height.regular, comp.navigation-drawer.item.label.typescale.regular, comp.navigation-drawer.item.trailing-icon.size.regular, comp.navigation-drawer.collapsed.container.width.regular, comp.navigation-drawer.collapsed.item.container.width.regular, comp.navigation-drawer.collapsed.item.container.padding-block.regular and comp.navigation-drawer.heading.height.regular, and WHILE density is compact from comp.navigation-drawer.container.gap.compact, comp.navigation-drawer.item.container.height.compact, comp.navigation-drawer.item.padding-inline.compact, comp.navigation-drawer.item.padding-block.compact, comp.navigation-drawer.item.nest-indent.compact, comp.navigation-drawer.item.icon.size.compact, comp.navigation-drawer.item.icon-indicator.width.compact, comp.navigation-drawer.item.icon-indicator.height.compact, comp.navigation-drawer.item.label.typescale.compact, comp.navigation-drawer.item.trailing-icon.size.compact, comp.navigation-drawer.collapsed.container.width.compact, comp.navigation-drawer.collapsed.item.container.width.compact, comp.navigation-drawer.collapsed.item.container.padding-block.compact and comp.navigation-drawer.heading.height.compact. No density SHALL change comp.navigation-drawer.item.gap, the room between the icon (or its room), the label and the trailing content, as no density changes the tree view's. Wherever another behaviour names one of these tokens by its regular value, THE navigation drawer SHALL read the value of its density instead, in both forms and while moving between them, so that every icon keeps one point in both forms (NVD-31) in each density and a nested destination's icon stands where its group's label starts in each. WHEN density changes while the drawer is shown THE navigation drawer SHALL draw the new density at once, without the motions of NVD-35, NVD-41 and NVD-44, keeping its form, its selection, every group's open, its scroll offset where the range allows, and focus, and SHALL emit nothing for it. |
NVD-66 | WHILE selectableGroups is true THE navigation drawer SHALL treat each group whose value or href is not empty as a destination as well as a group: the drawer's value SHALL select it as it selects a destination, its href standing as its value while its value is empty (NVD-59), and NVD-29 SHALL count it among the destinations in reading order, before the items it holds; its row SHALL be drawn from the selected parts in its form while it is selected (NVD-3, NVD-41) and from the parts NVD-47 names while it is not and a destination it holds is shown by it; its activation SHALL emit change or reselect as NVD-1 says and close a modal drawer as NVD-21 says; and WHILE its href is not empty its row SHALL be a link as NVD-59, NVD-60 and NVD-64 say, opened where the person is. WHILE selectableGroups is false, and for a group whose value and href are both empty, THE navigation drawer SHALL ignore the group's value and href, the group SHALL only open and close (NVD-45), and in debug builds it SHALL report once a group that has a value or an href while selectableGroups is false. WHEN selectableGroups changes while the drawer is shown THE navigation drawer SHALL draw the new form of each group at once, keeping value, every group's open and focus where the element that had it is still drawn, and SHALL emit nothing for it. |
NVD-67 | WHILE a group is a destination (NVD-66) and the drawer is expanded THE navigation drawer SHALL split its row in two: its chevron SHALL be a control of its own, which opens and closes the group as NVD-45 says and SHALL NOT change the selection, and the rest of the row SHALL be the destination, which a press, Enter or Space (Enter alone for a link) activates as NVD-1 says and which SHALL NOT open or close the group: the chevron opens and the row chooses, and one press never does both. The chevron's hit area SHALL be the part of the cell's hit area from the middle of the gap before the chevron's box to the cell's end edge, at least sys.target.pointer wide for a fine pointer and sys.target.touch wide for touch, reaching over the end of the label where the row gives less; the rest of the cell's hit area SHALL be the row's. A hover anywhere on the cell SHALL show on the item container, a press on the chevron SHALL show the pressed state on the item container as a press on the row does (NVD-8, NVD-9), and keyboard focus on the chevron SHALL show the focus ring around the chevron's own box, at the corners of the item container, and not around the row. With focus on the row the arrow keys SHALL open, close and leave the group as NVD-45 says. WHILE the drawer is collapsed the group's cell SHALL be the destination alone: its activation SHALL emit change or reselect, and SHALL NOT expand the drawer or open the group; its items are reached by expanding the drawer. |
NVD-68 | THE navigation drawer SHALL draw a group's chevron where chevron says, as the tree view does. WHILE chevron is start THE navigation drawer SHALL keep a box of comp.navigation-drawer.item.trailing-icon.size.regular at the start of every expanded row's content, comp.navigation-drawer.item.gap before its icon, the icon's room or its label, draw the chevron in it on a group's row and nothing on a destination's, so that the icons and labels of a level each stand in one column, and turn it a quarter turn from pointing toward the end of the line WHILE the group is closed to pointing down WHILE it is open. WHILE chevron is end it SHALL draw expand_more at the very end of the row, after its trailing content, turned half a turn WHILE open. WHILE chevron is none it SHALL draw no chevron and keep no room for one: the arrow keys SHALL still open and close a group (NVD-45); a press on a group's icon SHALL open and close it and choose nothing; WHILE the group is open its icon SHALL be drawn as its openIcon where it has one; a group without an icon SHALL open and close by a press anywhere on its row, unless it is a destination (NVD-66), whose row then chooses it and which the pointer cannot open or close. WHILE the drawer is collapsible THE navigation drawer SHALL draw start as end, so that every icon keeps one point in both forms (NVD-31). WHEN chevron names a value it does not define it SHALL draw start, and in debug builds report the value. |
NVD-69 | THE navigation drawer SHALL begin each row's content, and WHILE highlight is indented its item container, one step of indent further from the start than its group's row for each group that holds it, as the tree view does. WHILE indent is null (auto) a step SHALL be what the group's row draws before its label — its start chevron's room and comp.navigation-drawer.item.gap WHILE chevron is start, and its icon (or the icon's room, NVD-71) and comp.navigation-drawer.item.gap — so that a row's first part (its start chevron, its icon or its label) lines up with where its group's label begins, and comp.navigation-drawer.item.nest-indent.regular WHERE the group's row draws neither. WHILE indent is a number a step SHALL be that many units of the layout, and 0 SHALL begin every row where its group's row begins. WHILE the steps of a row's levels would begin its label past half of the drawer's width THE navigation drawer SHALL begin the row so that its label begins there, as the tree view does, so that a deep row keeps room for its name, at 200 % text too. A step SHALL NOT change a row's height, its hit area (NVD-6), which stays the drawer's width, or the collapsed form, which draws no nested row (NVD-32). WHEN indent is negative or not a number THE navigation drawer SHALL draw auto, and in debug builds report the value. |
NVD-70 | WHILE highlight is indented THE navigation drawer SHALL draw a nested row's item container — its selected fill, its hover and press layers and its focus indicator — from where the row begins (NVD-69) to the drawer's padding at its end, and WHILE highlight is full from the drawer's padding at its start to its padding at its end at every level, the content starting where the row begins either way; WHEN highlight names a value it does not define it SHALL draw indented, and in debug builds report the value. |
NVD-71 | WHILE iconSpace is auto THE navigation drawer SHALL keep an icon's room, empty, on a row without an icon WHERE another row of its level (the same group's rows, or the drawer's top-level rows) has an icon, so that the labels of the level start on one line; WHILE it is always on every row without an icon; and WHILE it is never on none, the label then starting comp.navigation-drawer.item.padding-inline.regular from where the row's content starts. The room is the icon's box and and counts toward the next level's step (NVD-69). |
NVD-72 | WHILE expandable is false THE navigation drawer SHALL draw every group open whatever its open says, draw no chevron and keep no room for one, emit no toggle, and SHALL expose no group as expandable: a group that is a destination (NVD-66) SHALL be that destination alone, and every other group's row SHALL be drawn, take no focus, answer no pointer and be hidden from assistive technology, its label naming the list of its items, which stays a list inside the drawer's list. WHILE the drawer is collapsed it SHALL still draw each top-level group as one cell, whose activation expands the drawer (NVD-47). |
NVD-73 | WHILE guides is shown THE navigation drawer SHALL draw, for each open group that shows at least one row under it while the drawer is expanded, one line comp.navigation-drawer.guide.width wide in comp.navigation-drawer.guide.color from the lower edge of the group's row to the lower edge of the last row shown under it, centred under the group's first part — its start chevron, else its icon or the icon's room, else at the start of its label — as the tree view does; WHILE guides is hover it SHALL draw the same lines only while the pointer is over the drawer or focus is in it, fading them in and out over comp.navigation-drawer.motion.state-duration with comp.navigation-drawer.motion.state-easing (at once where motion is reduced); WHILE guides is none it SHALL draw none. The lines SHALL take no space, keep their color and full opacity in every state of the rows beside them, be hidden from assistive technology, and continue under a pinned group row (NVD-77); WHILE indent is 0 no line SHALL be drawn. In forced colors they SHALL be drawn in the system's line color. |
NVD-74 | WHILE a destination's or a group's supportingText is not empty THE navigation drawer SHALL draw it in comp.navigation-drawer.item.supporting-text.typescale and its condition's supporting-text color (comp.navigation-drawer.unselected.item.supporting-text.color, comp.navigation-drawer.selected.item.supporting-text.color): WHILE supportingPosition is below on a line of its own under the label, the row growing to hold it with comp.navigation-drawer.item.padding-block.regular above and below its text, and WHILE it is inline after the label on its line, comp.navigation-drawer.item.gap after it; it SHALL be one line unless supportingWrap is true (NVD-75), SHALL be read as the row's description after its name and state, and SHALL NOT be drawn while the drawer is collapsed. |
NVD-75 | WHILE labelWrap is false THE navigation drawer SHALL draw each row's label on one line, cut with an ellipsis at the end of its own direction where it does not fit, and WHILE supportingWrap is false the same for its supporting text, below or inline; WHILE either is true that text SHALL wrap and the row grow with it. THE row's accessible name SHALL be its full label, and its description its full supporting text, whatever is drawn. WHEN a row whose label or supporting text is cut is hovered with a fine pointer, after the tooltip's show delay, or receives keyboard focus, THE navigation drawer SHALL show the full text in a plain tooltip beside the row, toward the content (NVD-56), which Escape dismisses, which stays while the pointer is over the row or focus is on it, and which SHALL NOT be shown for a row whose text is drawn whole. |
NVD-76 | WHILE an open group's loading is true THE navigation drawer SHALL draw one loading row under it, after the rows of any items it already holds, one step of indent further in (NVD-69): a Loading indicator component of the small size in the place of a row's icon, and after it loadingLabel in comp.navigation-drawer.item.supporting-text.typescale and comp.navigation-drawer.unselected.item.supporting-text.color, in a row of comp.navigation-drawer.item.container.height.regular. It is not a destination: it SHALL take no focus and answer no pointer, SHALL be counted among no items, and SHALL be named by loadingLabel; THE navigation drawer SHALL expose the list of the group's items as busy WHILE loading is true, and announce nothing itself. WHILE loadingLabel is empty it SHALL draw the indicator alone and in debug builds report that the loading row has no name. |
NVD-77 | WHILE stickyParents is true and the drawer is expanded THE navigation drawer SHALL keep pinned at the top of the space its items scroll in the rows of the open groups that hold the first row shown below the pinned rows, at most stickyMax of them, the innermost winning as VS Code keeps its innermost scopes, one per level and each directly under the one above: each pinned row SHALL be the row itself (no copy is drawn or exposed), keep its own fill, state and focus ring, stay interactive as its row is, be drawn over the rows scrolling under it on comp.navigation-drawer.sticky.container.color (a modal drawer's on its own container color), and leave as its group's last row scrolls past, as the platform's sticky position does; the last pinned row SHALL draw an edge comp.navigation-drawer.sticky.divider.width wide in comp.navigation-drawer.sticky.divider.color at its lower side. WHEN keyboard focus moves to a row hidden under the pinned rows THE navigation drawer SHALL scroll it into view below them (NVD-61's least distance, measured from their lower edge), and bring the selection into view below them (NVD-57). Nothing is animated beyond the scroll itself. WHILE the drawer is collapsed, or stickyParents is false, no row SHALL be pinned. WHEN stickyMax is not a positive whole number it SHALL pin 2, and in debug builds report the value. |
NVD-78 | WHERE the platform has ARIA attributes (the web), WHEN the product sets an aria- attribute on the drawer's own host, by the attribute or by the ARIA property that reflects it, THE navigation drawer SHALL move it to the data-aria- attribute of the same name, so that the host is no second node with its name, description or state, and SHALL expose it on the element that carries the drawer's role — its dialog WHILE it is shown as a modal dialog (NVD-23), its navigation landmark otherwise — an id reference by the elements it names in the host's tree or a tree around it, a description after its own; WHILE label is not empty, label is the drawer's name, over a name given so; WHILE label is empty, a name given so is the drawer's name. WHEN the product sets an aria- attribute on an item's host — a destination's or a group's — THE navigation drawer SHALL move it to the data-aria- attribute of the same name, so that the host is no second node with its name, description or state, and SHALL expose it on the element that carries the row's role (its link or its button), in both forms of the drawer — an id reference by the elements it names in the host's tree or a tree around it, an error message as part of the description while the item is invalid — except those an item owns (aria-current, aria-disabled, and for a group aria-expanded and aria-controls), which it SHALL move and not expose. WHEN the product removes the aria- attribute or its data-aria- twin, or sets the ARIA property that reflects it (ariaLabel, ariaDescribedByElements…) to null, THE navigation drawer SHALL take it off that element. WHEN the product sets an aria- attribute an item owns THE navigation drawer SHALL report it in debug builds. |
NVD-79 | WHILE filterable is true and the drawer is expanded THE navigation drawer SHALL draw a filter field after its header (NVD-38: its header buttons, its header slot and its main action) and comp.navigation-drawer.header.gap below it (at the padding WHILE the header is empty), across the drawer's width inside comp.navigation-drawer.container.padding-inline, and SHALL lay out what stands under the field — the status line of NVD-90 while there is one, then the items — comp.navigation-drawer.filter.gap below it; the field SHALL stay in place while the items scroll, as the header does (NVD-12). The field SHALL be a Text input component of type search in its default variant, of the medium size WHILE density is regular and the small size WHILE density is compact, showing the glyph search of the system's icon set in its leading-icon slot, filterPlaceholder as its placeholder and filterValue as its value, drawn and answering as that text input draws and answers (its own sentences hold, its tokens are its own). WHILE the drawer is collapsed it SHALL draw no field, SHALL keep filterValue, and SHALL draw its cells as though no filter were applied; WHEN it is expanded again the filter SHALL apply again. |
NVD-80 | WHEN the person changes the filter field's text — by typing, deleting, pasting, cutting, dictating, an input method committing text, the clear button (NVD-89) or Escape (NVD-86) — THE navigation drawer SHALL emit filterChange exactly once per change with the new text, setting filterValue itself first on the web (a controlled platform leaves filterValue to the caller), and SHALL apply the filter to the new text at once. WHEN the product sets filterValue THE navigation drawer SHALL show that text in the field and apply it, and SHALL NOT emit filterChange. WHILE an input method is composing THE navigation drawer SHALL filter by the text the field reports, and SHALL leave the composition, Enter, Escape and the arrow keys to the input method (TXI-4). |
NVD-81 | THE navigation drawer SHALL apply a filter WHILE filterable is true and filterValue holds a character that is not white space, and SHALL read the filter text as words: the runs of characters between white space. A destination or a group SHALL match WHILE its label contains every word, each anywhere in it and in any order, compared without regard to case, to the width of a character or to the marks on a letter, as the label's language compares (as the combobox compares, CMB-25). THE navigation drawer SHALL compare nothing else of a row — not its short label, its supporting text, its trailing text, its badge, its value or its href — and not a section's title. A disabled row SHALL match as any other row and stay disabled. It SHALL match only the items it holds: the items of a group that loads them when it opens (NVD-76) are not searched until they are given. THE navigation drawer SHALL NOT fetch, wait, debounce, rank or reorder anything for a filter. |
NVD-82 | WHILE a filter is applied THE navigation drawer SHALL show, in the order given: each row that matches; each group's row that holds a row that matches, at any depth; and every item inside a group whose own row matches, so that a group found by its name is shown whole. Every other row SHALL be hidden — not drawn, taking no space, not focusable and not exposed to assistive technology — together with what it holds. A section with no row shown SHALL be hidden with its heading and its divider; a section with a row shown SHALL keep both. A hidden row SHALL keep its open, its disabled state and its selection, and WHEN no filter is applied any more every row SHALL be shown as it was. |
NVD-84 | WHILE a filter is applied THE navigation drawer SHALL draw open, for the filter, each closed group that holds a row that matches and is shown, at any depth, so that every match is in view without the person opening anything, and SHALL draw every other group as its open says. Opening a group for the filter SHALL write nothing to the group's open, SHALL emit no toggle, and SHALL be drawn at once, without the motion of NVD-44; the group's row SHALL be exposed as expanded while it is drawn open. WHEN the person opens or closes a group while a filter is applied THE navigation drawer SHALL answer as NVD-45 says — setting open itself on the web and emitting toggle exactly once where open changes — and SHALL stop opening that group for the filter until the filter text changes. WHEN no filter is applied any more THE navigation drawer SHALL draw every group as its open says: the groups the filter opened close again, at once, and a group the person opened or closed stays as the person left it. |
NVD-85 | WHILE a filter is applied THE navigation drawer SHALL draw each row it shows as it draws that row without a filter, and SHALL NOT mark, in a label, the characters that a word of the filter text matched: no color, weight, fill or element of their own. What the filter leaves is the answer, as in a file tree's filter and a site's sidebar filter; a row SHALL be told from the others only by its own states — selected, disabled, hovered, pressed and focused — and as the active match (NVD-86). THE navigation drawer SHALL expose each label to assistive technology as the one text it is without a filter. |
NVD-86 | WHILE keyboard focus is in the filter field, a filter is applied and a row shown matches and is not disabled, THE navigation drawer SHALL make the first such row, in reading order, the active match — as soon as there is one, and the new first one whenever the result changes — and SHALL draw it as it draws that row while the row has keyboard focus, its focused tokens and its focus ring (NVD-10), without animation, while focus stays in the field, so that typing goes on editing the filter text; a pointer over a row SHALL NOT make it the active match, and WHILE focus is not in the field no row SHALL be drawn as one. WHILE no input method is composing, WHEN the person presses Enter THE navigation drawer SHALL take the active match as Enter on that row takes it — a destination activated (NVD-1, NVD-60), a group's row opened or closed (NVD-45) — and SHALL keep focus in the field unless the activation moves it (a link followed, a modal drawer closed, NVD-21); WHEN the person presses Down Arrow THE navigation drawer SHALL move focus to the active match and do nothing more. WHILE there is no active match the two keys SHALL do nothing of the drawer's own. WHEN the person presses Escape WHILE the field holds text THE navigation drawer SHALL empty it, emit filterChange once with the empty text, and keep focus in the field, as a native search field does; WHEN the person presses Escape WHILE the field is empty THE navigation drawer SHALL return focus to the element that had it before the filter shortcut moved it to the field (NVD-87), and otherwise SHALL do nothing of its own and let the key pass on, so that a modal drawer closes (NVD-20). Up Arrow, Home, End and the arrow keys along the line SHALL stay the field's. |
NVD-87 | WHILE filterable is true and filterShortcut holds exactly one chord THE navigation drawer SHALL draw that chord at the end of the filter field with the keyboard shortcut component, hosted as KBS-13 says — in its plain form, at size small, with convention auto, its legends and separators in comp.navigation-drawer.filter.shortcut.typescale and comp.navigation-drawer.filter.shortcut.color, and no cap, fill or edge (KBS-7) — only while the field is empty and does not have focus, SHALL expose it as the field's keyboard shortcut (KBS-12: aria-keyshortcuts on the web) with the drawn keys hidden from assistive technology, and SHALL give the hint no press of its own. WHEN the person presses that chord anywhere in the window, read as SRC-38 reads a chord and with its exceptions (a press something else has taken, a key repeating while held, an input-method composition and, for a chord without mod, ctrl or alt, focus in an element that takes text), THE navigation drawer SHALL keep the press from doing anything else and SHALL: WHILE it is expanded and shown, move focus to the field with its text selected; WHILE it is collapsed (a collapsible standard drawer, or the column of a collapsible modal drawer), emit expandedChange with true, apply it itself on the web as NVD-37 does, and move focus to the field once it is expanded. WHILE it is not shown (a standard drawer whose open is false, or a modal drawer that is closed and not collapsible) it SHALL NOT take the press: what opens it is the product's, or the app shell's (APS-33). THE navigation drawer SHALL listen only while it is part of what is shown and filterable is true, and SHALL stop when it is removed. IF another shown navigation drawer, tree view or search binds the same chord, the one shown first SHALL keep it and the others SHALL bind nothing and report it in debug builds, as SRC-39 says. WHILE filterShortcut is empty or holds more than one chord THE navigation drawer SHALL draw no hint and bind nothing, reporting more than one chord in debug builds. |
NVD-88 | WHEN the product asks the navigation drawer to focus its filter (the platform's method for it) WHILE filterable is true THE navigation drawer SHALL do what its chord does (NVD-87), whether or not filterShortcut is empty; WHILE it is a modal drawer that is closed it SHALL instead move focus to the field the next time it opens, in place of the destination NVD-19 would give focus to — so that an app shell, or a key of the product's own, can open the drawer and land in its field. |
NVD-89 | WHILE the filter field holds text THE navigation drawer SHALL draw, in the field's trailing-icon slot, an icon-only Tanrei Button of the text variant and the small size showing the glyph close of the system's icon set, not mirrored, named by filterClearLabel. WHEN it is activated THE navigation drawer SHALL empty the field, emit filterChange once with the empty text, and move focus to the field. WHILE filterClearLabel is empty and the product's words give none THE navigation drawer SHALL still draw the button, and in debug builds report that it has no accessible name. The hint of NVD-87 and the clear button SHALL never be drawn together. |
NVD-90 | WHILE a filter is applied THE navigation drawer SHALL draw a status line at the top of the results, where its first item would stand, the items following it: filterCountText with its place {count} filled by the number of rows that match WHILE a row matches and filterCountHidden is false, and filterEmptyText WHILE no row matches, in place of the items, all of them hidden. It SHALL draw the line in comp.navigation-drawer.filter.status.typescale and comp.navigation-drawer.filter.status.color, inset as a row's content is (comp.navigation-drawer.item.padding-inline.regular for regular and comp.navigation-drawer.item.padding-inline.compact for compact), wrapping and growing with enlarged text, as text of its own direction (NVD-52), taking no focus and no state, and hidden from assistive technology, which NVD-91 tells the same words. WHILE a row matches and filterCountHidden is true it SHALL draw no line. WHILE the words it would draw are empty and the product's words give none THE navigation drawer SHALL draw nothing in their place and in debug builds report it. |
NVD-91 | WHEN the result of a filter changes — the filter text or the items change while a filter is applied — and has then stayed as it is for one second (the pause that ends a type-ahead run, TRV-23), THE navigation drawer SHALL tell assistive technology once, politely and without moving focus, filterCountText with its place {count} filled by the number of rows that match, or filterEmptyText WHILE no row matches; WHEN no filter is applied any more it SHALL say nothing. It SHALL say them whether or not filterCountHidden is true, through one status of its own that is not drawn (the line of NVD-90 is what is drawn) — on the web an element with the status role and aria-atomic true, inside the drawer — and never through the field's name or description. WHILE filterCountText is empty and the product's words give none THE navigation drawer SHALL say no count and in debug builds report it. |
NVD-92 | THE navigation drawer SHALL change nothing but what it draws for a filter: value, expanded, open, every group's open (except where the person opens or closes one, NVD-84) and the distance scrollOffset measures SHALL stay as they were, and it SHALL keep filterValue no longer than its own lifetime and write it to no storage, as NVD-62 says of a group's open. WHEN a filter begins to be applied THE navigation drawer SHALL remember how far its items are scrolled, and WHEN the filter text changes while a filter is applied it SHALL scroll its items to their start; WHEN no filter is applied any more it SHALL, WHILE keyboard focus is on a row, keep that row where it is in the view as far as the scrolling allows, and otherwise scroll back to where the items stood when the filter began. A selected destination that the filter hides SHALL stay selected and SHALL be brought into view (NVD-57) only once it is shown again. |
NVD-93 | WHEN a filter comes to hide the row that has keyboard focus (the product sets filterValue, or changes the items) THE navigation drawer SHALL move focus to the filter field. WHILE a filter is applied and keyboard focus is on a destination, a group's row or a group's chevron, WHEN the person presses Escape THE navigation drawer SHALL, WHILE variant is standard, open, as the person would (open set and toggle emitted for each, NVD-45), the groups the filter had opened around that row, so that it stays shown, then empty the filter as NVD-86 does and keep focus on that row, which NVD-92 keeps in view, so that a person who found a place by the filter sees it among its neighbours; WHILE the drawer is modal, Escape SHALL close it as NVD-20 says and leave the filter as it is. |
NVD-94 | THE navigation drawer SHALL draw every change a filter makes — rows hidden and shown, groups opened for the filter and closed again — at once, without the motions of NVD-41 and NVD-44, whether or not motion is reduced; a group the person opens or closes during a filter moves as NVD-44 says. |
NVD-95 | THE navigation drawer SHALL expose the filter field as a search field — on the web an input of type search, which has the searchbox role — named by filterLabel, with filterPlaceholder as its placeholder, controlling the drawer's list of items (aria-controls on the web), after the header and before the items in reading and focus order; each shown destination and group with its position among the shown items of its level and their number, so that a person is told the size of what the filter left; and the rows the filter hides not at all. WHILE filterable is true and filterLabel is empty THE navigation drawer SHALL still draw the field, and in debug builds report that it has no accessible name. |
プラットフォーム別の名前対応
パリティは API が同一であることを意味しません。同じ契約を、各プラットフォームの流儀で表現します。
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| コンポーネント | tanrei-navigation-drawer | TanreiNavigationDrawer | TanreiNavigationDrawer | TanreiNavigationDrawer | NavigationDrawer |
variant · プロパティ | variant | variant | variant | variant | variant |
open · プロパティ | open | isPresented | drawerState | open | open |
collapsible · プロパティ | collapsible | isCollapsible | collapsible | collapsible | collapsible |
expanded · プロパティ | expanded | isExpanded | expanded | extended | expanded |
collapsedLabels · プロパティ | collapsedLabels | collapsedLabelVisibility | collapsedLabelVisibility | labelType | collapsedLabelVisibility |
density · プロパティ | density | density | density | density | density |
chevron · プロパティ | chevron | chevron | chevron | chevron | chevron |
guides · プロパティ | guides | guides | guides | guides | guides |
indent · プロパティ | indent | indent | indent | indent | indent |
highlight · プロパティ | highlight | highlight | highlight | highlight | highlight |
iconSpace · プロパティ | iconSpace | iconSpace | iconSpace | iconSpace | iconSpace |
expandable · プロパティ | expandable | expandable | expandable | expandable | expandable |
labelWrap · プロパティ | labelWrap | labelWrap | labelWrap | labelWrap | labelWrap |
supportingWrap · プロパティ | supportingWrap | supportingWrap | supportingWrap | supportingWrap | supportingWrap |
responsive · プロパティ | responsive | isResponsive | responsive | responsive | responsive |
value · プロパティ | value | selection | selected | selectedIndex | value |
revealSelected · プロパティ | revealSelected | revealsSelection | revealSelected | revealSelected | revealSelected |
selectableGroups · プロパティ | selectableGroups | selectableGroups | selectableGroups | selectableGroups | selectableGroups |
scrollOffset · プロパティ | scrollOffset | scrollOffset | scrollState | scrollController | scrollOffset |
stickyParents · プロパティ | stickyParents | stickyParents | stickyParents | stickyParents | stickyParents |
stickyMax · プロパティ | stickyMax | stickyMax | stickyMax | stickyMax | stickyMax |
loadingLabel · プロパティ | loadingLabel | loadingLabel | loadingLabel | loadingLabel | loadingLabel |
filterable · プロパティ | filterable | isFilterable | filterable | filterable | filterable |
filterValue · プロパティ | filterValue | filterText | filterValue | filterValue | filterValue |
filterLabel · プロパティ | filterLabel | filterLabel | filterLabel | filterLabel | filterLabel |
filterPlaceholder · プロパティ | filterPlaceholder | filterPrompt | filterPlaceholder | filterPlaceholder | filterPlaceholder |
filterEmptyText · プロパティ | filterEmptyText | filterEmptyText | filterEmptyText | filterEmptyText | filterEmptyText |
filterCountText · プロパティ | filterCountText | filterCountText | filterCountText | filterCountText | filterCountText |
filterCountHidden · プロパティ | filterCountHidden | isFilterCountHidden | filterCountHidden | filterCountHidden | filterCountHidden |
filterClearLabel · プロパティ | filterClearLabel | filterClearLabel | filterClearLabel | filterClearLabel | filterClearLabel |
filterShortcut · プロパティ | filterShortcut | filterShortcut | filterShortcut | filterShortcut | filterShortcut |
label · プロパティ | label | accessibilityLabel | contentDescription | semanticLabel | accessibilityLabel |
change · イベント | change | selection | onClick | onDestinationSelected | onValueChange |
reselect · イベント | reselect | onReselect | onClick | onDestinationSelected | onReselect |
close · イベント | close | isPresented | drawerState | onClose | onClose |
expandedChange · イベント | expandedchange | isExpanded | onExpandedChange | onExtendedChanged | onExpandedChange |
presentationChange · イベント | presentationchange | onPresentationChange | onPresentationChange | onPresentationChanged | onPresentationChange |
filterChange · イベント | filterchange | filterText | onFilterValueChange | onFilterChanged | onFilterChange |
| 備考 | Children are <tanrei-navigation-drawer-item>, <tanrei-navigation-drawer-group> and <tanrei-navigation-drawer-section> elements, in order; header buttons (icon-only <tanrei-button>s) and the main action (<tanrei-main-action-button>) are children with slot="header-button" and slot="main-action", and the header slot is header. collapsedLabels is the collapsed-labels attribute; expanded is reflected, and so is a read-only collapsed state attribute for styling. Modal: a <dialog> in the shadow root opened with showModal(), its ::backdrop the scrim; Escape and a press on the backdrop close it, the host sets open to false and fires close; a collapsible modal drawer keeps its column in the host's layout box and widens the dialog from it. Standard: a <nav> named by label. The drawer selects the activated destination itself (sets value) before firing change, sets expanded (or open) before firing expandedchange, and sets a group's open before the group fires toggle. It sets aria-expanded and aria-controls on its first header button's inner button through the Button's ariaExpanded / ariaControlsElements element properties, and the Main Action Button's extended from its own form. responsive is an attribute: the element reads its system's breakpoint.expanded and breakpoint.collapsed custom properties from its computed style, listens to the two widths with matchMedia, exposes the result as the read-only presentation property (reflected as a state attribute for styling) and fires presentationchange with detail.presentation; nothing about the presentation is written to variant, open or expanded, and nothing is kept in storage. Before the element is upgraded, and in the React wrapper on a server, no dialog is open and nothing is inert. A collapsed cell that draws no label shows its name in a plain tooltip. Insets are env(safe-area-inset-*). It lags the spec: it ships an earlier form of the drawer, with a separate rail element beside it. It does not yet follow NVD-57 to NVD-64, nor the parts of NVD-1, NVD-21 and NVD-23 that go with them. reveal-selected is an attribute. scroll-offset is an attribute read once, for the first frame, and scrollOffset a property whose getter returns the scroller's present scrollTop and whose setter writes it; the scroller has overscroll-behavior: contain and scroll-behavior: auto, and bringing the selection into view is a write to scrollTop, never scrollIntoView (which would also scroll the page). For a link destination change and reselect are cancelable, carry detail.href beside detail.value, and are fired from the anchor's click only when event.button is 0, no modifier key is down, the click was not already cancelled, and the item's target is same and it has no download; cancelling one calls preventDefault() on that click. The drawer does not set value for a link. Nothing is read from or written to sessionStorage or localStorage: a site keeps the groups' open and scrollOffset itself (on toggle and on pagehide) and writes them back as attributes in the page's markup, or in an inline script placed after the drawer's markup, before the elements are upgraded. density is reflected; a value a design system added is read from its own tokens, falling back to regular's. selectableGroups is the selectable-groups attribute. The attributes are chevron, guides, indent (auto or a number), highlight, icon-space, expandable (expandable="false" turns it off), label-wrap, supporting-wrap, sticky-parents, sticky-max and loading-label; on the items supporting-text, supporting-position, and on a group open-icon, trailing-text, loading and the trailing slot. Filter (NVD-79 to NVD-95): the attributes are filterable, filter-value, filter-label, filter-placeholder, filter-empty-text, filter-count-text, filter-count-hidden, filter-clear-label and filter-shortcut (a space-separated list of chords); filterchange carries detail.value. The field is a <tanrei-text-input type="search" variant="stacked"> in the shadow root between the header and the items (part filter), its leading glyph and its clear button (a <tanrei-button>) slotted into it; the drawer sets aria-controls (the drawer's list, through ariaControlsElements) and aria-keyshortcuts on its native input. The status line (part filter-status) stands first in the list of items, hidden from assistive technology; the status is a visually hidden element with role="status" and aria-atomic="true" in the shadow root. A row the filter hides takes display: none from a state attribute it writes on its own host (data-filter-hidden), a section with no row shown likewise, and a group opened for the filter draws its items open without writing open. The active match is drawn by a state attribute on its host (data-filter-active). focusFilter() is the method of NVD-88. The chord is read as the search reads its own (SRC-38), and the drawer, the search and the tree view share one registry of the chords that are bound (SRC-39). | TanreiNavigationDrawer(variant:, isPresented: Binding<Bool>, selection: Binding<Value>, isCollapsible:, isExpanded: Binding<Bool>, collapsedLabelVisibility:, onReselect:) { TanreiNavigationDrawerItem(…); TanreiNavigationDrawerGroup(…) { … }; TanreiNavigationDrawerSection(…) { … } } header: { … } headerButtons: { … } mainAction: { … }, and for a modal drawer the modifier .tanreiNavigationDrawer(isPresented:…) on the content it covers. Closing writes false to isPresented (close); the menu button writes isExpanded (expandedChange). The modal drawer carries the modal trait and answers the escape gesture (accessibilityAction(.escape)). It lags the spec: it ships an earlier form of the drawer (no collapsed form, groups or trailing slot; its badge: string is the trailing text), with a separate rail component beside it. Not built on this platform yet: the 48 row with the menu item's corners in both forms, a collapsed cell that is the row without its label (collapsedLabels defaults to never), nested rows whose content alone starts further in while their item containers keep the full width (NVD-13), the header slot's inherited text style and color (NVD-38), a selection that changes color in place, and responsive with its event (NVD-53 to NVD-55): the width comes from a GeometryReader on the window's scene, or horizontalSizeClass where the product prefers Apple's own classes; onPresentationChange is a closure. Also not built yet (NVD-57 to NVD-64): revealsSelection: Bool, and scrollOffset: Binding<CGFloat> over the items' ScrollView (a ScrollPosition where the deployment target has it), which the product may keep in @SceneStorage. Not yet: the heading's letter-spacing by the script of its text (NVD-16, PRS-20). Not built yet: density (NVD-65), a density parameter as the tree view's on this platform; and this platform's drawer still reads the tokens that the density axis made per density (the row height, paddings, gap, nesting indent, icon sizes, label style, the collapsed column and the heading height), each now one value per density in the generated tokens, so it does not build against them until it catches up. Not built yet: selectableGroups (NVD-66, NVD-67) — a group that is a destination, with its row choosing it and its chevron a control of its own that opens and closes it. Not built yet: the row model shared with the tree view (chevron, guides, indent, highlight, iconSpace, expandable, labelWrap and supportingWrap, supporting text, one-line labels with a tooltip where cut, a group's trailing content, openIcon and loading row, stickyParents and stickyMax; NVD-68 to NVD-77). Filter (NVD-79 to NVD-95), not built yet: filterText: Binding<String>; the chord is a .keyboardShortcut on hardware keyboards; the status is an AccessibilityNotification.Announcement with the polite priority; focusFilter() is a FocusState the product can set. | Compose idiom (as ModalNavigationDrawer and DismissibleNavigationDrawer, and Material 3 Expressive's WideNavigationRail for the collapsed form): TanreiNavigationDrawer(variant, drawerState, collapsible, expanded, onExpandedChange, collapsedLabelVisibility, header = { … }, headerButtons = { … }, mainAction = { … }, drawerContent = { TanreiNavigationDrawerItem(…); TanreiNavigationDrawerGroup(…) { … }; TanreiNavigationDrawerSection(…) { … } }, content = { … }). drawerState (rememberTanreiDrawerState) is open or closed; the drawer closes it itself on the scrim, back and drag, and its confirmValueChange sees the close. As for the bar, the drawer's value and a destination's value both map to the item's selected, and one onClick covers change and reselect. The modal sheet sets a pane title from contentDescription and is drawn in a window of its own (a Dialog), as TanreiDialog is, which traps focus, handles back and hides the content behind from TalkBack. It lags the spec: it ships an earlier form of the drawer, with a separate rail component beside it. Not built on this platform yet: the 48 row with the menu item's corners in both forms, a collapsed cell that is the row without its label (collapsedLabels defaults to never), nested rows whose content alone starts further in while their item containers keep the full width (NVD-13), the header slot's inherited text style and color (NVD-38), a selection that changes color in place, and responsive with its event (NVD-53 to NVD-55): the width comes from LocalWindowInfo.current.containerSize (or currentWindowAdaptiveInfo() where the product has it); onPresentationChange is a lambda and drawerState is closed by the drawer when the presentation changes. Also not built yet (NVD-57 to NVD-64): revealSelected: Boolean, and a hoisted scrollState: ScrollState = rememberScrollState(), which is saved and restored by rememberSaveable as any scroll state is; the drawer writes nothing itself. Not yet: the heading's letter-spacing by the script of its text (NVD-16, PRS-20). Not built yet: density (NVD-65), a density parameter as the tree view's on this platform; and this platform's drawer still reads the tokens that the density axis made per density (the row height, paddings, gap, nesting indent, icon sizes, label style, the collapsed column and the heading height), each now one value per density in the generated tokens, so it does not build against them until it catches up. Not built yet: selectableGroups (NVD-66, NVD-67) — a group that is a destination, with its row choosing it and its chevron a control of its own that opens and closes it. Not built yet: the row model shared with the tree view (chevron, guides, indent, highlight, iconSpace, expandable, labelWrap and supportingWrap, supporting text, one-line labels with a tooltip where cut, a group's trailing content, openIcon and loading row, stickyParents and stickyMax; NVD-68 to NVD-77). Filter (NVD-79 to NVD-95), not built yet: filterValue with onFilterValueChange; the status is a polite liveRegion node; the chord is read from hardware keys (onPreviewKeyEvent); focusFilter is a FocusRequester in the drawer's state. | Flutter idiom (as NavigationDrawer, with the rail widget's extended and labelType for the collapsed form): TanreiNavigationDrawer(variant:, collapsible:, extended:, onExtendedChanged:, labelType:, selectedIndex:, onDestinationSelected:, headerButtons: [...], mainAction:, header:, children: [TanreiNavigationDrawerDestination(…), TanreiNavigationDrawerGroup(…), TanreiNavigationDrawerSection(…), …]). A destination's value is its index among the destinations, counted in reading order through sections and groups, open or not, as NavigationDrawer counts its destinations. labelType is all, selected or none. open shows or hides the drawer in both variants. A modal drawer is a controlled overlay in a Stack over the page — not Scaffold.drawer, which would need Material — with its own scrim and motion, a FocusScope that keeps focus in, and the page's semantics blocked; Escape, back (PopScope), a drag or fling, the menu button and choosing a destination call onClose once. It lags the spec: it ships an earlier form of the drawer, with a separate rail component beside it. Not built on this platform yet: the 48 row with the menu item's corners in both forms, a collapsed cell that is the row without its label (collapsedLabels defaults to never), nested rows whose content alone starts further in while their item containers keep the full width (NVD-13), the header slot's inherited text style and color (NVD-38), a selection that changes color in place, and responsive with its event (NVD-53 to NVD-55): the width comes from MediaQuery.sizeOf(context).width; onPresentationChanged is a ValueChanged<TanreiNavigationDrawerPresentation> and onClose is called when a change of presentation closes the drawer. Also not built yet (NVD-57 to NVD-64): revealSelected: bool, and scrollController: ScrollController? (its initialScrollOffset is the first frame's offset); a PageStorageKey or a restorationId on the product's side keeps the offset, the drawer writes nothing itself. Not yet: the heading's letter-spacing by the script of its text (NVD-16, PRS-20). Not built yet: density (NVD-65), a density parameter as the tree view's on this platform; and this platform's drawer still reads the tokens that the density axis made per density (the row height, paddings, gap, nesting indent, icon sizes, label style, the collapsed column and the heading height), each now one value per density in the generated tokens, so it does not build against them until it catches up. Not built yet: selectableGroups (NVD-66, NVD-67) — a group that is a destination, with its row choosing it and its chevron a control of its own that opens and closes it. Not built yet: the row model shared with the tree view (chevron, guides, indent, highlight, iconSpace, expandable, labelWrap and supportingWrap, supporting text, one-line labels with a tooltip where cut, a group's trailing content, openIcon and loading row, stickyParents and stickyMax; NVD-68 to NVD-77). Filter (NVD-79 to NVD-95), not built yet: filterValue with onFilterChanged; the chord is a Shortcuts entry; the status is SemanticsService.announce with the polite assertiveness; focusFilter is a FocusNode the product may pass. | Controlled: open, expanded, value, onValueChange, onExpandedChange, onClose, an items data array, headerButtons and mainAction elements and a header node. A modal drawer is presented in a transparent Modal with its own motion and scrim; onRequestClose (Android back) calls onClose. Destinations have the button role with accessibilityState.selected; group rows the button role with accessibilityState.expanded; headings the header role. Insets come from its own insets prop, falling back to TanreiProvider's. It lags the spec: it ships an earlier form of the drawer, with a separate rail component beside it. Not built on this platform yet: the 48 row with the menu item's corners in both forms, a collapsed cell that is the row without its label (collapsedLabels defaults to never), nested rows whose content alone starts further in while their item containers keep the full width (NVD-13), the header slot's inherited text style and color (NVD-38), a selection that changes color in place, and responsive with its event (NVD-53 to NVD-55): the width comes from useWindowDimensions(); onPresentationChange receives 'standard' | 'column' | 'modal', and onClose is called when a change of presentation closes the drawer. Also not built yet (NVD-57 to NVD-64): revealSelected, and scrollOffset as the first frame's offset with a ref method getScrollOffset() for reading it; the drawer writes to no storage. Not yet: the heading's letter-spacing by the script of its text (NVD-16, PRS-20). Not built yet: density (NVD-65), a density parameter as the tree view's on this platform; and this platform's drawer still reads the tokens that the density axis made per density (the row height, paddings, gap, nesting indent, icon sizes, label style, the collapsed column and the heading height), each now one value per density in the generated tokens, so it does not build against them until it catches up. Not built yet: selectableGroups (NVD-66, NVD-67) — a group that is a destination, with its row choosing it and its chevron a control of its own that opens and closes it. Not built yet: the row model shared with the tree view (chevron, guides, indent, highlight, iconSpace, expandable, labelWrap and supportingWrap, supporting text, one-line labels with a tooltip where cut, a group's trailing content, openIcon and loading row, stickyParents and stickyMax; NVD-68 to NVD-77). Filter (NVD-79 to NVD-95), not built yet: controlled filterValue with onFilterChange; the status is AccessibilityInfo.announceForAccessibilityWithOptions with queue: true; focusFilter() is on the component's ref. |
トークン
| トークン | 参照先 | 解決値(ライト) |
|---|---|---|
--tanrei-comp-navigation-drawer-breakpoint-collapsed | sys.breakpoint.medium | 600px |
--tanrei-comp-navigation-drawer-breakpoint-expanded | sys.breakpoint.expanded | 1024px |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-disabled-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-focused-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-hovered-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-container-color | comp.navigation-drawer.selected.item.container.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-icon-indicator-color | comp.navigation-drawer.selected.item.icon-indicator.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-icon-color | comp.navigation-drawer.selected.item.icon.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-label-color | comp.navigation-drawer.selected.item.label.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-state-layer-color | comp.navigation-drawer.collapsed-selected.item.icon.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-supporting-text-color | comp.navigation-drawer.selected.item.supporting-text.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-trailing-icon-color | comp.navigation-drawer.selected.item.trailing-icon.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-item-trailing-text-color | comp.navigation-drawer.selected.item.trailing-text.color | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-selected-pressed-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-disabled-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-focused-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-hovered-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-container-color | comp.navigation-drawer.unselected.item.container.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-icon-indicator-color | comp.navigation-drawer.unselected.item.icon-indicator.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-icon-color | comp.navigation-drawer.unselected.item.icon.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-label-color | comp.navigation-drawer.unselected.item.label.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-state-layer-color | comp.navigation-drawer.collapsed-unselected.item.icon.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-supporting-text-color | comp.navigation-drawer.unselected.item.supporting-text.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-trailing-icon-color | comp.navigation-drawer.unselected.item.trailing-icon.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-item-trailing-text-color | comp.navigation-drawer.unselected.item.trailing-text.color | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-container-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-label-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-collapsed-unselected-pressed-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-container-width-compact | — | 56px |
--tanrei-comp-navigation-drawer-collapsed-container-width-regular | — | 72px |
--tanrei-comp-navigation-drawer-collapsed-item-container-padding-block-compact | sys.space.space100 | 8px |
--tanrei-comp-navigation-drawer-collapsed-item-container-padding-block-regular | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-collapsed-item-container-padding-inline | sys.space.space50 | 4px |
--tanrei-comp-navigation-drawer-collapsed-item-container-shape | comp.navigation-drawer.item.container.shape | 6px |
--tanrei-comp-navigation-drawer-collapsed-item-container-width-compact | — | 32px |
--tanrei-comp-navigation-drawer-collapsed-item-container-width-regular | — | 48px |
--tanrei-comp-navigation-drawer-collapsed-item-gap | sys.space.space50 | 4px |
--tanrei-comp-navigation-drawer-container-color-modal | sys.color.surface-container-low | |
--tanrei-comp-navigation-drawer-container-color-standard | sys.color.surface | |
--tanrei-comp-navigation-drawer-container-elevation-modal | sys.elevation.level2 | 0px 0px 0px 1px rgb(0 0 0 / 0.08), 0px 1px 2px 0px rgb(0 0 0 / 0.04) |
--tanrei-comp-navigation-drawer-container-elevation-standard | sys.elevation.level0 | |
--tanrei-comp-navigation-drawer-container-gap-compact | — | 2px |
--tanrei-comp-navigation-drawer-container-gap-regular | — | 4px |
--tanrei-comp-navigation-drawer-container-padding-block | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-container-padding-inline | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-container-shape-modal | sys.shape.corner.large | 12px |
--tanrei-comp-navigation-drawer-container-shape-standard | sys.shape.corner.none | 0px |
--tanrei-comp-navigation-drawer-container-width | — | 240px |
--tanrei-comp-navigation-drawer-disabled-opacity | — | 1 |
--tanrei-comp-navigation-drawer-filter-gap | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-filter-shortcut-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-filter-status-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-focused-opacity | — | 1 |
--tanrei-comp-navigation-drawer-guide-color | sys.color.outline-variant | |
--tanrei-comp-navigation-drawer-guide-width | sys.border.hairline | 1px |
--tanrei-comp-navigation-drawer-header-color | sys.color.on-surface | |
--tanrei-comp-navigation-drawer-header-gap | sys.space.space300 | 24px |
--tanrei-comp-navigation-drawer-header-item-gap | sys.space.space100 | 8px |
--tanrei-comp-navigation-drawer-heading-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-heading-height-compact | — | 28px |
--tanrei-comp-navigation-drawer-heading-height-regular | — | 36px |
--tanrei-comp-navigation-drawer-hovered-opacity | — | 1 |
--tanrei-comp-navigation-drawer-item-container-height-compact | — | 32px |
--tanrei-comp-navigation-drawer-item-container-height-regular | — | 48px |
--tanrei-comp-navigation-drawer-item-container-shape | sys.shape.corner.small | 6px |
--tanrei-comp-navigation-drawer-item-gap | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-item-icon-indicator-height-compact | comp.navigation-drawer.item.icon.size.compact | 16px |
--tanrei-comp-navigation-drawer-item-icon-indicator-height-regular | comp.navigation-drawer.item.icon.size.regular | 24px |
--tanrei-comp-navigation-drawer-item-icon-indicator-shape | sys.shape.corner.full | 9999px |
--tanrei-comp-navigation-drawer-item-icon-indicator-width-compact | comp.navigation-drawer.item.icon.size.compact | 16px |
--tanrei-comp-navigation-drawer-item-icon-indicator-width-regular | comp.navigation-drawer.item.icon.size.regular | 24px |
--tanrei-comp-navigation-drawer-item-icon-size-compact | sys.icon.extra-small | 16px |
--tanrei-comp-navigation-drawer-item-icon-size-regular | sys.icon.medium | 24px |
--tanrei-comp-navigation-drawer-item-nest-indent-compact | sys.space.space300 | 24px |
--tanrei-comp-navigation-drawer-item-nest-indent-regular | sys.space.space450 | 36px |
--tanrei-comp-navigation-drawer-item-padding-block-compact | — | 2px |
--tanrei-comp-navigation-drawer-item-padding-block-regular | — | 4px |
--tanrei-comp-navigation-drawer-item-padding-inline-compact | sys.space.space100 | 8px |
--tanrei-comp-navigation-drawer-item-padding-inline-regular | sys.space.space150 | 12px |
--tanrei-comp-navigation-drawer-item-trailing-icon-size-compact | sys.icon.extra-small | 16px |
--tanrei-comp-navigation-drawer-item-trailing-icon-size-regular | sys.icon.small | 20px |
--tanrei-comp-navigation-drawer-motion-disclosure-duration | sys.motion.role.disclosure | 400ms |
--tanrei-comp-navigation-drawer-motion-disclosure-easing | sys.motion.easing.spatial | cubic-bezier(0.2, 0, 0, 1) |
--tanrei-comp-navigation-drawer-motion-enter-duration | sys.motion.role.appear.sheet.enter | 400ms |
--tanrei-comp-navigation-drawer-motion-enter-easing | sys.motion.easing.enter | cubic-bezier(0.2, 0, 0, 1) |
--tanrei-comp-navigation-drawer-motion-exit-duration | sys.motion.role.appear.sheet.exit | 350ms |
--tanrei-comp-navigation-drawer-motion-exit-easing | sys.motion.easing.exit | cubic-bezier(0.3, 0, 1, 1) |
--tanrei-comp-navigation-drawer-motion-expand-duration | sys.motion.role.resize.large | 400ms |
--tanrei-comp-navigation-drawer-motion-expand-easing | sys.motion.easing.spatial | cubic-bezier(0.2, 0, 0, 1) |
--tanrei-comp-navigation-drawer-motion-feedback-duration | sys.motion.role.feedback | 450ms |
--tanrei-comp-navigation-drawer-motion-selection-duration | sys.motion.role.selection.mark | 250ms |
--tanrei-comp-navigation-drawer-motion-selection-easing | sys.motion.easing.spatial | cubic-bezier(0.2, 0, 0, 1) |
--tanrei-comp-navigation-drawer-motion-state-duration | sys.motion.role.state.large | 250ms |
--tanrei-comp-navigation-drawer-motion-state-easing | sys.motion.easing.state | cubic-bezier(0.2, 0, 0, 1) |
--tanrei-comp-navigation-drawer-outline-color-modal | — | |
--tanrei-comp-navigation-drawer-outline-color-standard | sys.color.outline-variant | |
--tanrei-comp-navigation-drawer-outline-width | sys.border.hairline | 1px |
--tanrei-comp-navigation-drawer-pressed-opacity | — | 1 |
--tanrei-comp-navigation-drawer-scrim-blur | comp.modal-layer.scrim.blur | 0px |
--tanrei-comp-navigation-drawer-scrim-color | comp.modal-layer.scrim.color | |
--tanrei-comp-navigation-drawer-selected-disabled-item-container-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-label-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-disabled-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-container-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-label-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-focused-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-container-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-label-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-hovered-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-selected-item-container-color | sys.color.secondary-container | |
--tanrei-comp-navigation-drawer-selected-item-icon-indicator-color | comp.navigation-drawer.unselected.item.icon-indicator.color | |
--tanrei-comp-navigation-drawer-selected-item-icon-color | sys.color.on-secondary-container | |
--tanrei-comp-navigation-drawer-selected-item-label-color | sys.color.on-secondary-container | |
--tanrei-comp-navigation-drawer-selected-item-state-layer-color | comp.navigation-drawer.selected.item.label.color | |
--tanrei-comp-navigation-drawer-selected-item-supporting-text-color | sys.color.on-secondary-container | |
--tanrei-comp-navigation-drawer-selected-item-trailing-icon-color | sys.color.on-secondary-container | |
--tanrei-comp-navigation-drawer-selected-item-trailing-text-color | sys.color.on-secondary-container | |
--tanrei-comp-navigation-drawer-selected-pressed-item-container-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-label-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-selected-pressed-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-sticky-container-color | comp.navigation-drawer.container.color.standard | |
--tanrei-comp-navigation-drawer-sticky-divider-color | sys.color.outline-variant | |
--tanrei-comp-navigation-drawer-sticky-divider-width | sys.border.hairline | 1px |
--tanrei-comp-navigation-drawer-unselected-disabled-item-container-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-label-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-disabled-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-container-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-label-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-focused-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-container-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-label-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-hovered-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-item-container-color | — | |
--tanrei-comp-navigation-drawer-unselected-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-unselected-item-icon-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-unselected-item-label-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-unselected-item-state-layer-color | comp.navigation-drawer.unselected.item.label.color | |
--tanrei-comp-navigation-drawer-unselected-item-supporting-text-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-unselected-item-trailing-icon-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-unselected-item-trailing-text-color | sys.color.on-surface-variant | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-container-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-icon-indicator-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-label-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-state-layer-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-supporting-text-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-trailing-icon-color | — | |
--tanrei-comp-navigation-drawer-unselected-pressed-item-trailing-text-color | — | |
--tanrei-comp-navigation-drawer-collapsed-item-label-typescale | sys.typescale.label-small | 500 12px/1.3333 |
--tanrei-comp-navigation-drawer-filter-shortcut-typescale | sys.typescale.label-small | 500 12px/1.3333 |
--tanrei-comp-navigation-drawer-filter-status-typescale | sys.typescale.body-small | 400 13px/1.5385 |
--tanrei-comp-navigation-drawer-header-typescale | sys.typescale.heading-5 | 500 16px/1.5 |
--tanrei-comp-navigation-drawer-heading-typescale | sys.typescale.label-small | 500 12px/1.3333 |
--tanrei-comp-navigation-drawer-item-label-typescale-compact | sys.typescale.label | 500 14px/1.4286 |
--tanrei-comp-navigation-drawer-item-label-typescale-regular | sys.typescale.label | 500 14px/1.4286 |
--tanrei-comp-navigation-drawer-item-supporting-text-typescale | sys.typescale.body-small | 400 13px/1.5385 |
--tanrei-comp-navigation-drawer-item-trailing-text-typescale | sys.typescale.body-small | 400 13px/1.5385 |
フィクスチャ
基準となる描画パターンです。全プラットフォームが同じ ID でスナップショットを撮り、結果を比較できるようにしています。
variant: standard (45)
standard
open: true value: inbox label: Mail items: 2 256 × 560 のウィンドウに単独で描画standard-no-icons
open: true value: deployments label: Project items: 4 256 × 560 のウィンドウに単独で描画standard-disabled
open: true value: inbox label: Mail items: 4 256 × 560 のウィンドウに単独で描画collapsible-expanded
open: true collapsible: true expanded: true value: inbox label: Mail items: 6 slots: header 256 × 560 のウィンドウに単独で描画collapsed
open: true collapsible: true expanded: false value: inbox label: Mail items: 6 slots: header 88 × 560 のウィンドウに単独で描画collapsed-labels-always
open: true collapsible: true expanded: false collapsedLabels: always value: inbox label: Mail items: 5 88 × 560 のウィンドウに単独で描画collapsed-labels-selected
open: true collapsible: true expanded: false collapsedLabels: selected value: starred label: Mail items: 5 88 × 560 のウィンドウに単独で描画collapsed-badges
open: true collapsible: true expanded: false value: inbox label: Mail items: 5 88 × 560 のウィンドウに単独で描画collapsed-disabled
open: true collapsible: true expanded: false value: inbox label: Mail items: 5 88 × 560 のウィンドウに単独で描画collapsed-short-labels
open: true collapsible: true expanded: false collapsedLabels: always value: shared-with-me label: Files items: 5 88 × 560 のウィンドウに単独で描画trailing
open: true value: inbox label: Mail items: 5 256 × 560 のウィンドウに単独で描画groups
open: true value: website label: Workspace items: 4 256 × 560 のウィンドウに単独で描画groups-nested
open: true value: tokens label: Docs items: 1 256 × 560 のウィンドウに単独で描画nested-icons
open: true chevron: end value: website label: Workspace items: 3 256 × 560 のウィンドウに単独で描画compact
open: true density: compact chevron: end value: tree-view label: Workspace items: 3 256 × 560 のウィンドウに単独で描画compact-collapsed
open: true collapsible: true expanded: false density: compact value: inbox label: Mail items: 6 72 × 560 のウィンドウに単独で描画chevron-end
open: true chevron: end value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画chevron-none
open: true chevron: none value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画guides
open: true guides: shown value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画guides-chevron-none
open: true chevron: none guides: shown value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画indent-zero
open: true chevron: end indent: 0 value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画highlight-full
open: true chevron: end highlight: full value: posts label: Workspace items: 3 256 × 560 のウィンドウに単独で描画icon-space
open: true chevron: end value: inbox label: Mail items: 4 256 × 560 のウィンドウに単独で描画not-expandable
open: true expandable: false value: color label: Docs items: 2 256 × 560 のウィンドウに単独で描画supporting
open: true chevron: end value: inbox label: Mail items: 3 256 × 560 のウィンドウに単独で描画one-line
open: true chevron: end value: long label: Projects items: 2 256 × 560 のウィンドウに単独で描画label-wrap
open: true chevron: end labelWrap: true supportingWrap: true value: long label: Projects items: 2 256 × 560 のウィンドウに単独で描画group-loading
open: true chevron: end value: inbox loadingLabel: Loading… label: Mail items: 2 256 × 560 のウィンドウに単独で描画sticky
open: true chevron: end value: a-3-4 scrollOffset: 220 stickyParents: true label: Archive items: 2 256 × 560 のウィンドウに単独で描画group-closed-selected
open: true value: website label: Workspace items: 3 256 × 560 のウィンドウに単独で描画selectable-groups
open: true value: components selectableGroups: true label: Documentation items: 4 256 × 560 のウィンドウに単独で描画collapsed-groups
open: true collapsible: true expanded: false value: website label: Workspace items: 4 88 × 560 のウィンドウに単独で描画responsive-wide
collapsible: true responsive: true value: inbox label: Mail items: 6 slots: header 1280 × 640 のウィンドウに単独で描画responsive-medium
collapsible: true responsive: true value: inbox label: Mail items: 6 800 × 640 のウィンドウに単独で描画responsive-narrow
open: true collapsible: true responsive: true value: inbox label: Mail items: 6 slots: header 400 × 640 のウィンドウに単独で描画site-sidebar
open: true value: /components/navigation-drawer/ revealSelected: true label: Documentation items: 5 256 × 560 のウィンドウに単独で描画site-sidebar-long
open: true value: /components/navigation-drawer/ label: Documentation items: 5 256 × 800 のウィンドウに単独で描画site-sidebar-restored
open: true value: /components/navigation-drawer/ scrollOffset: 2900 label: Documentation items: 5 256 × 800 のウィンドウに単独で描画filter-empty-field
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: dr filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter-count-hidden
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: dr filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterCountHidden: true filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter-group
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: found filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter-matches
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: nav filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter-none
open: true value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: zzz filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画filter-compact
open: true density: compact value: /components/navigation-drawer/ revealSelected: true filterable: true filterValue: o filterLabel: Filter navigation filterPlaceholder: Filter filterEmptyText: No matches filterCountText: Matches: {count} filterClearLabel: Clear label: Documentation items: 5 256 × 560 のウィンドウに単独で描画variant: modal (3)
modal
variant: modal open: true value: inbox label: Mail items: 2 480 × 640 のウィンドウに単独で描画modal-collapsible-closed
variant: modal open: false collapsible: true value: inbox label: Mail items: 5 modal-collapsible-open
variant: modal open: true collapsible: true value: inbox label: Mail items: 5 slots: header 480 × 640 のウィンドウに単独で描画生成元 specs/navigation-drawer.spec.json, tokens/comp/navigation-drawer.tokens.json, design/tokens/
ナビゲーションバーに収まらないほど行き先が多いとき、または行き先がグループに分かれるときに使います。メールアプリのフォルダーとラベル、プロジェクトの各セクション、管理画面などです。大きいウィンドウでは、スタンダードのドロワーをサイドバーとしてコンテンツの横に置きます。コンパクトなウィンドウでは、モーダルのドロワーをメニューボタンからコンテンツの上に滑り込ませ、行き先が選ばれたら閉じます。
| 観点 | ナビゲーションバー | ナビゲーションドロワー(折りたたみ) | ナビゲーションドロワー(展開) |
|---|---|---|---|
| 置き場所 | 下端に沿って | 先頭側の端に沿ったアイコンの列 | 先頭側の端のパネルの中 |
| ウィンドウ | Compact | Medium 以上 | Expanded 以上(スタンダード)、または Compact(モーダル) |
| 行き先の数 | 3〜5 個 | 最上位の行き先とグループ。1 つにつき 1 セル | プロダクトにある分だけ。セクションとグループにまとめます |
| 行き先の形 | アイコンと、その下の 1 行のラベル。アイコンにバッジ | 項目をアイコンの後ろで切った形。アイコンだけで、バッジを付け、名前はツールチップで示します | 1 行の項目。アイコン(省略可)、折り返すラベル、末尾のテキストや内容 |
| ほかに持つもの | なし | ヘッダー:メニューボタンと、アイコンだけに折りたたんだメインアクション | ヘッダー:メニューボタン、タイトルやアカウントの切り替え、メインアクション |
| ネイティブのプラットフォームでの行き先 | タブバーのタブ | 選択状態を持つボタン | 選択状態を持つボタン |
| 位置づけ | レイアウト領域 | レイアウト領域。またはモーダルのドロワーが広がる元になるレイアウト内の列 | スタンダードはレイアウト領域、モーダルはモーダルなオーバーレイ |
- 折りたたんだドロワーがナビゲーションレールです。 折りたためるドロワーは、コンテンツに幅が要るときにアイコンの列まで狭まり、メニューボタンでまた広がります。どのアイコンも位置を変えません。Tanrei の独立したナビゲーションレールは、この形に統合されて廃止されました。
- バーとドロワーは、同じ行き先を置く場所が違うだけです。 同じ行き先と同じ選択を受け取るので、ウィンドウの大きさに合わせて変わるプロダクトは、行き先に手を加えずにブレークポイントでバーとドロワーを切り替えられます。同時に表示するのはどちらか一方だけです。
- ドロワーはもっと多くを持てます。 バーに収まらないほど行き先が多いとき、メールアプリのフォルダーとラベルのように行き先がグループに分かれるときは、展開したドロワーを使います。大きいウィンドウではスタンダードのドロワーをコンテンツの横に置き、コンパクトなウィンドウではモーダルのドロワーをメニューボタンから重ねて開きます。
- モーダルの折りたためるドロワーは、アイコンの列をレイアウトに残したまま、メニューボタンで開くとスクリムの上でコンテンツに重なって広がります。
- どのプラットフォームでも、どちらも行き先の値で選び(Compose は項目ごとのフラグ、Flutter は番号)、
changeとreselectを発火します。
Tanrei には独立したナビゲーションレールはありません。レールは、折りたためるドロワーを折りたたんだ形です。
| 以前 | 現在 |
|---|---|
| ナビゲーションレール | collapsible を付け、expanded を false にしたナビゲーションドロワー |
| レールの行き先(アイコンとその下のラベル) | 行き先。折りたたんだときは、項目をアイコンの後ろで切った形で描きます。アイコンだけで、名前はツールチップで示します |
| レールのラベルの表示 | collapsedLabels:never(既定)、selected、always。後の 2 つは、アイコンの下に shortLabel を描きます |
| レールのアイコンのバッジ | 行き先の badge、badgeCount、badgeLabel。どちらの形でも描きます |
| レールのメニューボタンと FAB | ドロワーの最初の header-button(メニューボタン)と main-action。メインアクションは折りたたむとアイコンだけになります |
ドロワーの項目末尾の badge のテキスト |
trailingText、または trailing スロット |
| レールのトークン | comp.navigation-drawer.collapsed.* と、折りたたんだときの状態 |
Web は実装済みです。SwiftUI、Compose、Flutter、React Native は、追いつくまで独立したナビゲーションレールを提供しますが、これらのページではそれを説明していません。
| Material 3 | Tanrei |
|---|---|
| Navigation rail | 折りたためるナビゲーションドロワーを折りたたんだ形 |
| Expanded navigation rail | 折りたためるナビゲーションドロワーを展開した形 |
| Modal expanded navigation rail | モーダルの折りたためるナビゲーションドロワー |
| Navigation drawer | 折りたためないナビゲーションドロワー |
| バリアント | どういうものか | 用途 |
|---|---|---|
| スタンダード(既定) | レイアウトの中のパネルで、末尾側の端に細い線を引きます。開閉に合わせて横のコンテンツの幅が変わります。スクリムを描かず、横のコンテンツで作業している間も開いたままです。 | ドロワーをサイドバーとして開いたままにできる、幅の広いウィンドウ。 |
| モーダル | 末尾側の角が丸い、浮き上がったパネルです。スクリムの上に重なってコンテンツの上へ滑り込みます。閉じるまでフォーカスをとどめ、行き先が選ばれると自分で閉じます。 | コンパクトなウィンドウ。アプリバーや、折りたたんだドロワーのヘッダーにあるメニューボタンから開きます。 |
デザインシステムはバリアントを追加できます。追加したバリアントは、スタンダードと同じように振る舞います。
- スタンダードを開く。 ドロワーが滑り込み、横のコンテンツが場所を空けます。メニューボタンなどで人の求めに応じて開いたときは、今の行き先へ、なければドロワーの最初のフォーカスできる要素へフォーカスが移ります。最初から開いた状態で表示したドロワーは、フォーカスを動かしません。
- スタンダードの横で作業する。 Tab でドロワーからコンテンツへ進んでも、ドロワーは開いたままです。フォーカスが中にある状態で閉じると、開く前にフォーカスがあった場所へ戻ります。
- モーダルを開く。 ドロワーが先頭側の端から滑り込み、ウィンドウの残りの部分にスクリムがフェードインします。フォーカスは今の行き先へ、なければ最初のフォーカスできる要素へ移り、ドロワーの中にとどまります。背後のものはすべて、ポインター、タッチ、キーボード、支援技術のどれからも操作できなくなります。
- モーダルを閉じる。 スクリムを押す、Escape を押す、プラットフォームの「戻る」を使う、先頭側の端の方へ幅の半分を超えてドラッグするかその向きにフリングする、行き先を選ぶ。どれでも 1 回だけ閉じます。ドロワーは滑り出てスクリムが消え、開いたときにフォーカスを持っていた要素へフォーカスが戻ります。
- 端からのスワイプでは開かない。 iOS では画面の先頭側の端は「戻る」のジェスチャーなので、そこからドロワーを開くことはしません。目に見えるメニューボタンから開きます。
- 動きを減らす設定では、瞬時に開閉します。
collapsibleを付けると、ドロワーは幅 72 の折りたたんだ形を持ちます。展開したドロワーからラベルがなくなっただけの形です。最上位の行き先とグループは、それぞれの項目をアイコンの後ろで切った 48 × 48 のセルになり、角の丸みは項目と同じで、選択中のものは項目とまったく同じように塗ります。ヘッダーのボタンは列に縦に並び、メインアクションはアイコンだけに縮みます。セクションの見出しは文字なしで行を保ち、ヘッダーのスロットと末尾の内容は描きません。- 折りたたんだセルは、名前をツールチップで示します。 ツールチップはコンテンツの側に出ます。ポインターをセルに置いたままにするとツールチップの待ち時間の後に、キーボードフォーカスではすぐに表示し、タッチでは表示しません。ラベルはもともとセルのアクセシブルネームなので、ツールチップが読み上げに加えるものはありません。
expandedは、スタンダードの折りたためるドロワーの形を選びます。モーダルの折りたためるドロワーは、閉じている間も列をレイアウトに残し、openでコンテンツの上へスクリム付きで広がります。- メニューボタン は最初の
header-buttonです。ドロワーが折りたためる間は、展開しているか折りたたんでいるかを伝え、ドロワーを制御するボタンとして扱われます。押すと、求めた形を付けてexpandedChangeを発火します。Web はそれを自分で反映し、ほかのプラットフォームでは利用者側でexpandedかopenを設定します。グリフと名前は利用者側で決めます。 collapsedLabelsは、どのセルがアイコンの下に短いラベルを描くかを選びます。既定のnever(描かない)、selected(選択中のものだけ)、always(すべて)です。ラベル付きの列は、それを求めるプロダクトやデザインシステムのためのものです。そのときセルはshortLabel(なければラベル)を描き、ツールチップは出しません。どれでも、ラベルはアクセシブルネームのままです。- どのアイコンも位置を変えません。 アイコンはどちらの形でも同じ列と同じ高さに並び、どのセルも高さを保つので、形が変わるときに動くのは末尾側の端だけです。端が通り過ぎるとラベルが消え、ラベル付きの列では短いラベルが現れます。唯一の例外は開いているグループで、折りたたんだドロワーはその中身を描かないため、その下のセルが上に詰まります。 メインアクションのグリフも、どちらの形でも、ボタンのどのサイズでも、どちらの密度でも、行き先のアイコンと同じ線の上に立ちます。ドロワーはボタン自身のトークンから位置を決めます。列より幅の広い折りたたみ時の正方形(既定のシステムの大きいメインアクション)は列の端からはみ出し、デバッグビルドで報告します。small か medium を使い、コンパクトなドロワーでは、medium の正方形が列いっぱいになるので small を使います。
- 選択は、その場で色が変わります。 新しく選ばれると、展開していても折りたたんでいても、項目はその場で色を変えます。選択を示すために何かが伸びたり、縮んだり、滑ったりすることはありません。
regular(既定)は、高さ 48 の項目に 24 のグリフで、メニューの項目と同じ高さです。タッチでもポインターでも使うプロダクト向けです。compactはツリービューのコンパクトな行と同じです。高さ 32、グリフ 16、行の内側の余白 8、行の間 2、見出しの高さ 28 で、折りたたむとアイコンの列の幅は 56 です。ファイルブラウザーやエディターのサイドバーのように、行き先の多いドロワーをポインターで使うツールに使います。- どちらの密度でも、入れ子のアイコンがそろいます。 階層が 1 つ深くなるごとに中身を 1 段字下げし、その幅はその密度のアイコンと間隔の和なので、入れ子の行き先のアイコンはグループのラベルの始まる位置に立ち、同じ階層のアイコンは 1 列に並びます。
- タッチのターゲットは保ちます。 タッチでは、コンパクトな項目も少なくともタッチターゲットの高さで描きます。ポインターでは、ヒット領域は項目とその上下の間隔の半分です。ポインターターゲットより小さくなりますが、WCAG 2.5.8 の 24 は上回ります。
- デザインシステムは、ドロワーの
.compactのトークン(comp.navigation-drawer.item.container.height.compactなど)で、コンパクトの中身を変えたり、密度を加えたりできます。
- ツリービューと同じパラメーターを、同じ名前と意味で持ちます。
chevron、guides、indent、highlight、iconSpace、expandable、labelWrapとsupportingWrap、行のsupportingTextとsupportingPosition、そしてstickyParentsとstickyMaxです。 chevron:既定のstartは、グループのシェブロンをアイコンの前に描き、すべての行でその場所を空けるので、同じ階層のアイコンがそろいます。endは行の最後、末尾の内容の後に描きます。noneは描かず、グループのアイコンを押すと開閉し、開いている間はopenIconを表示します。折りたためるドロワーはstartをendとして描くので、どちらの形でもアイコンの位置は変わりません。グループのないドロワーはその場所を空けません。indent:autoは、行の最初の部分をグループのラベルが始まる位置にそろえ、グループがラベルの前に何も描かないときはその階層のインデントだけ字下げします。数値はその px だけ、0 は字下げしません。行のラベルがドロワーの幅の半分より先から始まることはありません。highlight:既定のindentedは、入れ子の行の塗りとステートレイヤーを行の始まる位置から描き、fullはどの階層でも幅いっぱいに描きます。iconSpaceは、アイコンのない行にもアイコンの場所を空け、同じ階層のラベルをそろえます。auto(同じ階層のほかの行にアイコンがあるとき)、always、neverです。expandableを false にすると、すべてのグループを開いた状態で、シェブロンなしで表示します。グループの行はその中身の名前になり、操作できるものではなくなります。guides:shownは、開いたグループの中身の横に、シェブロン、なければアイコン、なければラベルの始まりの下に線を描きます。hoverは、ポインターがドロワーの上にある間か、フォーカスが中にある間だけ描きます。- 1 行:ラベルと補足テキストは 1 行で、入りきらなければ省略記号で切り、切れている行は、ホバーとキーボードフォーカスで全文をツールチップに表示します。
labelWrapとsupportingWrapで折り返せます。アクセシブルネームは常にラベル全文です。 - 補足テキストは、ラベルの下(
below)か後ろ(inline)に置き、行の説明として読み上げます。 - グループは、末尾のシェブロンの前に末尾のテキストや内容を、また
openIconとloadingを持てます。loadingは中身の下に読み込み中の行を描き、その名前はドロワーのloadingLabelです。 stickyParents(ドロワーでは既定でオフ、ツリービューではオン)は、上に見えている行が属する開いたグループの行を、エディターのスティッキースクロールのように、内側のものから最大stickyMax(2)個まで上端に固定します。折りたたんでいる間は働きません。
responsive を付けると、デザインシステムの 2 つのブレークポイント(既定のシステムでは 1024 と 600)をもとに、ウィンドウの幅がドロワーの表示のしかたを選びます。このとき variant は無視します。
| ウィンドウ | 表示 | ドロワーのあり方 |
|---|---|---|
| 広い方のブレークポイント以上 | standard |
コンテンツの横のスタンダードのドロワー。open が何であっても表示し、折りたためるなら expanded が選ぶ形になります |
狭い方のブレークポイント以上で、collapsible のとき |
column |
モーダルの折りたためるドロワー。アイコンの列をレイアウトに残し、open の間はコンテンツの上に広がります |
| それより狭い | modal |
折りたためない、モーダルのドロワー |
- 表示は導き出すもので、保存しません。 幅だけに従い、ドロワーがそれを
variant、open、expandedに書き込むことはありません。今の表示は、最初に決まったときと、幅によって変わるたびに、presentationChangeが伝えます。 - 新しい表示には、閉じた状態で入ります。 動きを付けず、すぐに描きます。開いていたオーバーレイは下ろし、
closeを 1 回発火します。expanded、value、各グループのopenは保つので、スタンダードの表示に戻ると、離れたときの形のままです。 modalの表示では、メニューボタンは利用者側で用意します。 表示がmodalの間は、アプリバーなどに自前のメニューボタンを表示し、そこからopenを設定します。このときドロワー自身のメニューボタンは、閉じることしかしません。- ドロワーは、訪問をまたいで何も覚えません。 展開か折りたたみかという人の選択を残したいときは、
expandedChangeが運ぶ値を保存し、そこからexpandedを設定します。
すべての行き先に href を付け、ドロワーの value にそのページ自身のアドレスを渡すと、ドロワーは文書でできたサイトのサイドバーになります。
- 今の場所はページが伝えます。 リンクは、押されただけでは選択されません。各ページが、自分の行き先を
valueに設定します。その行き先のvalueを、なければ書かれたとおりのhrefを渡します。 revealSelectedは、ドロワーが最初に現れたときに、選択中の行き先を含むグループを開きます。最初のフレームで、動きを付けずに開き、その後もvalueが変わるたびに開きます。その後で人が閉じたグループは、valueが変わるまで閉じたままです。- 選択は、着いたときに見えています。 ドロワーが現れたとき、そして
valueが変わるたびに、選択を示す項目が全部は見えていなければ、スクロールする領域の中央へ運びます。見えていれば、まったく動かしません。そのため、今のページがすでに見えているサイドバーは、ページを移っても位置が変わりません。フォーカスは動かしません。 scrollOffsetは、項目がどれだけスクロールしているかを読み書きします。ドロワーは何も保存しません。長いツリーを読者が離れたときの位置に保ちたいサイトは、スクロール量と各グループのopenを自分で(たとえばセッションのストレージに)保存し、最初のフレームの前に戻します。それでも、今のページを含むグループは開き、選択が見えなくなるスクロール量よりも選択の方を優先します。- サイトの外へ出るリンクには
targetにnewを指定します。新しいタブで開き、末尾の内容を置いていなければ、展開した項目の末尾にアイコンセットのopen_in_newを描き、名前の後にtargetLabelを読み上げます。この言葉(「新しいタブで開きます」など)は利用者側で用意します。Tanrei は言葉を同梱しません。 - ルーターは
changeを聞きます。changeは、ブラウザーがリンクをたどる前に発火します。ただし、ふつうの実行のときだけです。targetがsameのリンクを、修飾キーなしの主ボタン、タッチ、Enter のいずれかで実行したときです。これをキャンセルし、運ばれてきたhrefへ移ります。別のタブで開いたリンクは何も発火せず、モーダルのドロワーも開いたままにします。
絞り込みは、ドロワーをその場で狭めるもので、検索ではありません。検索はすべてのページの内容を探し、見つけたものを専用のビューに表示します。絞り込みは、ドロワーがすでに並べている場所のラベルだけを見て、それをその場に残します。そのため、ページの名前を知っている読み手は、「/」と最初の数文字の 2 つのキーでそこに着き、周りの項目の中でその位置を見られます。それぞれに専用のキーを割り当てます。サイドバーに絞り込みを持つドキュメントサイトにならって、絞り込みには「/」、検索には ⌘K か Ctrl+K です。
- 一致するもの。 入力したすべての語を、それぞれラベルのどこかに、順不同で含む行が一致します。大文字と小文字、文字の幅(全角と半角)、文字に付く記号(アクセントなど)は区別しません。「nav dr」は「Navigation drawer」に、「resume」は「Résumé」に一致します。比べるのはラベルだけで、補足テキスト、末尾テキスト、アドレスは比べません。取得も、順位付けも、並べ替えもしません。サーバーで探す、順位を付ける、ラベル以外も比べるプロダクトは、
filterableを設定せず、これまでどおり一致した行をドロワーに渡します。 - 残る行。 一致しない行は隠します。一致を持つグループは残し、名前で一致したグループは中身ごと残します。行が 1 つも残らないセクションは、見出しごと隠します。
- グループは一時的に開きます。 一致を持つ閉じたグループは、絞り込みのために開いて描きます。
openは変わらず、toggleも発火しないので、入力欄を空にすると、また閉じます。絞り込み中にユーザーが開閉したグループはユーザーのもので、置いたままの状態を保ちます。 - 最初の一致はすぐに選べます。 入力欄にフォーカスがある間、一致する最初の行をフォーカスのある行として描きます。Enter はその行で Enter を押したときと同じくそれを実行し、下矢印はその行にフォーカスを移します。入力は入力欄で続けられます。Escape は入力欄を空にし、もう一度押すと、「/」を押す前の場所にフォーカスを戻します。
- 「/」は、ページのどこからでも入力欄に移ります。 ただし、テキストの入力欄にフォーカスがあるときは、そこにスラッシュを入力します。折りたたんだドロワーは、先に展開します。キーは
filterShortcutで変えられ、空のリストにするとキーを割り当てません。すでに「/」を使っているプロダクト向けです。狭いウィンドウでは、アプリシェルが閉じたドロワーをこのキーで開き、入力欄にフォーカスを移します。 - 件数。 絞り込み中は、結果の先頭に控えめな 1 行で、一致した行の数(
filterCountText)を、何も一致しなければfilterEmptyTextを表示します。filterCountHiddenを設定すると件数は描きませんが、支援技術には伝えます。 - 一致には印を付けません。 絞り込みで残った行がそのまま答えなので、どの行も絞り込みのないときと同じ見た目です。コードレビューのファイルツリーや、ドキュメントサイトのサイドバーの絞り込みと同じです。
- 何も保存しません。 ドロワーがなくなると、テキストも忘れます。絞り込みを読み手について回らせたいときは、
filterChangeからfilterValueを取っておき、次のページで戻します。
- 項目の高さは最小 48 で、メニューの項目と同じ高さ、同じ角の丸みです。ラベルは 1 行で切り詰め、
labelWrapを付けると折り返して項目も高くなります。 - ラベルの位置がそろうように、アイコンはすべての行き先に付けるか、どれにも付けないかのどちらかにします。折りたためるドロワーは、折りたたんだときに最上位の行き先とグループをアイコンで描くので、それぞれにアイコンを付けます。
trailingTextは、項目の末尾にラベルより控えめに描く短いテキストです。「24」のような件数か、「新着」のような言葉を書きます。件数はバッジではなく、ここにテキストとして書きます。バッジはアンカーに付ける印で、項目の末尾には付ける先がありません。印を付けるなら、badgeでアイコンに付けます。そのほかのもの、たとえばグリフはtrailingスロットに入れます。スロットはtrailingTextより優先され、操作はできません。targetがnewのリンクは、自分で項目の末尾にopen_in_newを描くので、このグリフを利用者側で置くことはありません。末尾の内容はラベルの後に読み上げ、折りたたんでいる間は描きません。badgeは、どちらの形でもアイコンにバッジを描きます。点かbadgeCountの数字で、名前はbadgeLabelです。- グループの行は、
chevronが置く位置のシェブロン(上記)で、中の行き先やグループを開閉します。選択中の行き先を含む閉じたグループは選択中として描き、折りたたんでいる間は最上位のグループも同じです。折りたたんでいる間にグループを押すと、ドロワーが展開してグループが開きます。階層は 3 つまでにします。 - 行き先にもなるグループ(
selectableGroupsを付け、グループにvalueかhrefを与えたもの)は、ツリービューと同じように行を 2 つに分けます。シェブロンが開閉し、行の残りがそれを選び、1 回押して両方が起きることはありません。シェブロンは行の次にフォーカスが移る独立した操作部品で、ヒット領域の幅は少なくともポインターターゲットです。折りたたんでいる間は、ほかのグループと違い、セルを押すとそれを選び、ドロワーは折りたたんだままです。中の行き先には、ドロワーを展開してたどります。revealSelectedは、そのようなグループが今のページのときにもそれを開くので、サイトのサイドバーは表示中のセクションのページを示します。 - セクションの見出しは、その下の行き先をまとめて名付けるものです。見出しであって、操作できるものではありません。見出しのないセクションも作れます。タイトルのない、区切っただけのグループです。
- セクションの
dividerは、上にあるものと区切るために、セクションの前に区切り線を描きます。区切り線を利用者側で置くことはありません。 - ヘッダーには、アイコンの列に縦に並ぶヘッダーボタンと、その下のメインアクションがあります。ヘッダーのスロットは展開している間メニューボタンの横に置かれ、タイトルやアカウントの切り替えに使います。折りたたんでいる間は描きません。そこに置いたただのテキストは、ドロワーのタイトルのスタイル(
comp.navigation-drawer.header.typescaleとcomp.navigation-drawer.header.color)で描きます。自分でスタイルを指定した要素は、そのスタイルのままです。 - 項目がヘッダーの下の空きより高くなると、項目がスクロールし、ヘッダーはその場にとどまります。スクロールがどちらかの端に達しても、ドロワーの背後のページまでスクロールすることはありません。
- よく使う行き先を先頭に、セクションの外か最初のセクションに置きます。
- 自分のアドレスを持つ行き先には
hrefを付け、本物のリンクにします。新しいタブで開け、アドレスをコピーでき、クローラーもたどれます。 - セクションには「ラベル」「管理」のように、中の行き先に共通するものを名前にします。
- スタンダードとモーダルで同じ行き先と値を使い、ウィンドウの幅だけで切り替えられるようにします。
- 「サインアウト」や「新規作成」のようなアクションをドロワーに置かない。ドロワーの項目は場所です。
- セクションを入れ子にしたり、グループにセクションを入れたりしない。デバッグビルドで報告し、内側のセクションの行き先をその場所に描きます。
selectableGroupsを付けずにグループにvalueやhrefを与えて、行で選べるようにしようとしない。開閉するだけで、デバッグビルドで報告します。- スタンダードが収まる幅のウィンドウでモーダルを使わない。
- 絞り込みを、サイトの検索の代わりにしない。絞り込みは場所を名前で見つけるものです。内容の中の語を探す読み手には、検索が必要です。
- ロール
navigation- ラベル付け
- Each destination is named by its label in both forms, drawn or not, as a button or as a link; its icon is decorative; its badge's description and then its trailing content are part of its description. A group's row and the list of its items are named by the group's label. A section's heading is a heading. The drawer's label names the navigation landmark and, while the drawer is modal and open, the dialog. The menu button is named by its own label and carries the drawer's expanded state; the main action is named by its label in both forms. A collapsed drawer that draws no labels shows each cell's name where the platform shows a name for an icon alone (a tooltip on the web). The filter field is a search field named by filterLabel, the product's words, controlling the drawer's list; its clear button is named by filterClearLabel; its key hint is hidden and its chord is the field's keyboard shortcut. How many rows match is drawn at the top of the results, hidden from assistive technology, and said by a status of the drawer's own, in the product's filterCountText or filterEmptyText.
- 最小ターゲット
- 見た目のサイズが小さくても、ヒット領域は最小ターゲットサイズを満たします。 minimum 32px · pointer 44px · spacing 8px · touch 48px
キーボード操作
| キー | 動作 |
|---|---|
| Tab / Shift+Tab | Moves focus through the header's content, then the destinations and group rows that are shown and not disabled, and after the row of a group that is a destination its chevron; inside an open modal drawer it wraps around and never leaves the drawer; from an open standard drawer, expanded or collapsed, it moves on to the content, and the drawer stays as it is. |
| Enter / Space | Activates the focused destination (Enter only for a destination that is a link: it follows the link, and Space is left to the platform), and a modal drawer then closes; on a group's row, opens or closes the group, or, for a group that is a destination (NVD-66), activates it as a destination and leaves it as it is; on that group's chevron, opens or closes the group; on a group's cell in the collapsed drawer, expands the drawer with the group open; on the menu button, changes the drawer's form. |
| Enter with a modifier key, on a link (the web) | What the browser does with a link: another tab or window, a download. The drawer emits nothing, selects nothing and stays as it is (NVD-60). |
| Right arrow / Left arrow (mirrored in right-to-left layouts) | On a closed group's row, the arrow toward the end of the line opens it; on an open group's row, the arrow toward the start closes it; on an item inside an open group, the arrow toward the start moves focus to the group's row. Elsewhere the keys do nothing. |
| Escape | Closes an open modal drawer (a collapsible one narrows back to its column) and returns focus to where it was. |
| / (the filterShortcut chord, anywhere in the window) | WHILE filterable is true and the drawer is shown: moves focus to the filter field, expanding a collapsed drawer first. It types "/" while focus is in a text field. |
| Enter (in the filter field) | Takes the first row that matches — the active match, drawn as a focused row while focus stays in the field — as Enter on that row would: a destination is activated, a group's row opens or closes. |
| Down Arrow (in the filter field) | Moves focus to the active match. |
| Escape (in the filter field) | With text: empties the field and keeps focus there. Empty: returns focus to where it was before "/", or passes on (a modal drawer closes). |
| Escape (on a row, while a filter is applied) | A standard drawer: empties the filter and keeps focus on the row, which stays in view among its neighbours. A modal drawer: closes, as without a filter. |
備考
- The drawer is a list of places, not a tab bar, in both forms: on native platforms its destinations are buttons (or links) with the selected state (as iPadOS sidebars and Android's drawer items are read), and on the web links or buttons with aria-current in a navigation landmark. The collapsed form keeps these semantics; it does not become a tab bar.
- Selected and the current page are one thing. The drawer lists the product's places and the selected one is the place being shown, which the web exposes as aria-current="page" on a button and on a link alike. A site of separate pages changes who says which it is — the page, through value, not a press — and nothing else: no destination is ever selected and another current, so a second state would have no case to draw.
- A drawer of links is a navigation landmark holding lists of links and disclosure buttons, the pattern assistive technology users know from site navigation: every link and every group's row is its own Tab stop, and the arrow keys only open, close and leave a group. It is deliberately not a choice per use. One Tab stop with roving arrow keys is a tree's or a menu's model, would hide links from the browser's own ways of listing and following them, and would make the same component answer the keyboard in two ways. A long tree is passed by the landmark, by the headings of its sections, by closing its groups, and by the page's skip link.
- Showing the selection (NVD-57, NVD-58) scrolls the drawer and opens groups without moving focus and without an announcement: the page's own title and heading say where the user is, and the current destination carries its state for whoever reaches it.
- Groups are disclosures, not a tree: a group's row is a button with an expanded state that shows or hides a named list, and every shown destination stays its own tab stop, as the links of a navigation region are. A tree's single tab stop and arrow-key roving would make the drawer's keyboard model depend on whether it has groups; the arrow keys here only open, close and leave a group.
- A group that is a destination (selectableGroups, NVD-66) is the WAI-ARIA Authoring Practices' disclosure navigation menu with top-level links: its row is the link or button of its own page, with the current-page state, and its chevron a separate disclosure button for its items, each a Tab stop. The two are never one control: a row that both navigates and toggles would announce one action and do two, and a keyboard user could not open the group without leaving the page. The chevron is named by the group's label, as Tanrei ships no words of its own; its role and its expanded state tell it from the row.
- Collapsing hides the header slot, the headings' text, trailing content and the items inside groups from assistive technology and focus; it changes no destination's role, name or state, and the menu button announces the change as its expanded state.
- A responsive drawer (NVD-53 to NVD-55) changes what it is with the window's width — a layout region where the window is wide, a modal overlay where it is narrow — and each presentation has the semantics of the drawer it stands for. A change of presentation closes an open overlay, releases focus that was kept inside it and announces nothing by itself; the presentation is never the only way to reach a destination, because the product's menu button opens the modal presentation.
- The standard form is a layout region, not an overlay, expanded or collapsed: opening it moves focus in, to the selected destination or else the first, closing it returns focus to where it was, and focus leaving it never closes it. The modal form is a modal overlay: it keeps focus in and draws a scrim; a collapsible modal drawer's column is a layout region while the drawer is closed. The web presents the open modal drawer with a modal <dialog> element (showModal gives inertness and Escape); Compose draws it in a window of its own (a Dialog, as TanreiDialog is) and Flutter as a controlled overlay in a Stack over the page, each with a scrim, trapping focus and answering back; SwiftUI, which has no side presentation, overlays it with the modal trait and the escape gesture; React Native presents it in a transparent Modal.
- Opening a modal drawer by a swipe from the screen edge is left out: on iOS the same edge is the back gesture. The product opens it from a menu button.
- How a state looks is a value decision of the active design system; components read the state's tokens and never compute the effect themselves.
- A filter narrows the drawer in place; it is not a search. The site's search (the Search component, opened with ⌘K or Ctrl+K) looks through the content of every page and offers results in a view of its own; the filter looks only at the labels of the places the drawer already lists and leaves them where they are, so that a person who knows a page's name reaches it in two keys ("/" and its first letters) and sees it among its neighbours. The two keep separate keys: "/" for the filter, as documentation sites with a sidebar filter do, and the search's own chord.
- Hidden rows are removed from what assistive technology is told, not only from view, so that every list position and size a person hears is the filter's (WCAG 1.3.1). The count is a status message (WCAG 4.1.3): said politely through a status of the drawer's own once typing pauses, never by moving focus, and drawn quietly at the top of the results unless the product hides it. The rows that match are not marked: what the filter leaves is the answer, as in a file tree's filter and a documentation site's sidebar, and the row Enter takes is drawn as a focused row (NVD-85, NVD-86), so that nothing is told by color alone (WCAG 1.4.1).
- The field is a separate stop before the items, as a search field above a list is. As in a search, the first row that matches is active as soon as there is one while focus stays in the field: Enter takes it, as Enter on its row would, and Down Arrow moves focus to it, so that a keyboard user neither Tabs through every row the filter left nor leaves the field to reach the place they typed for. The active match is drawn as a focused row; it is not the field's active descendant, because a destination is a link or a button, which an input's active descendant is not (a search's results are not either), and a screen reader user meets it by Down Arrow, the count telling how many rows are left.
生成元 specs/navigation-drawer.spec.json, tokens/sys/measure.tokens.json
- Web では、ドロワーは
labelを名前とするナビゲーションのランドマークです。各行き先はリンク(hrefがあるとき)かボタンで、今の行き先にはaria-current="page"が付きます。モーダルのドロワーは、labelを名前とするモーダルな<dialog>でもあります。 - iOS、Android、Flutter、React Native では、各行き先は、選択状態と行き先の中での位置を持つボタンです。それぞれのプラットフォームでサイドバーやドロワーの項目が読み上げられるのと同じです。モーダルのドロワーは、
labelを名前とするモーダルなコンテナ(モーダルのトレイト、またはペインのタイトル)です。 - 行き先は、どちらの形でもラベルを名前とする 1 つの要素です。アイコンは隠し、アイコンのバッジの説明と末尾の内容を、名前と状態の後に読み上げます。
- リンクの行き先は、どの状態でもボタンの行き先とまったく同じように描き、訪問済みの見た目はありません。コンテキストメニュー、新しいタブで開くこと、ドラッグ、ホバーで出るアドレスなど、ブラウザーがリンクに与えるものはすべて残ります。新しいタブで開くリンクは、説明の最後に
targetLabelを読み上げます。 - 折りたたんだセルのツールチップは、ポインターやキーボードを目で見て使う人のためのものです。支援技術からは隠します。支援技術は、もともとラベルをセルの名前として読み上げます。
- グループの行は、展開状態を持ち、入れ子のリストを制御するボタンです。閉じたグループでは右(左から右に書くレイアウトの場合)で開き、開いたグループでは左で閉じ、グループの中では左でその行へ移ります。Tab は表示中のすべての行をたどります。
- 行き先にもなるグループは、WAI-ARIA Authoring Practices の「トップレベルのリンクを持つ開閉式ナビゲーションメニュー」です。行はリンクかボタンで、今のページのときは
aria-current="page"を持ち、シェブロンはグループのラベルを名前とする別のボタンで、展開状態を持ち、入れ子のリストを制御します。どちらも Tab で止まり、行の上では右と左でこれまでどおりグループを開閉できます。 - ドロワーが折りたためる間、メニューボタンは展開しているか折りたたんでいるかを伝え、ドロワーを制御するボタンとして扱われます。形が変わっても、フォーカスはそれまでのセルにとどまります。
- セクションの見出しは見出しとして伝え、フォーカスは受け取りません。
- Tab はヘッダーの中身と、無効でないすべての行き先を順にたどります。Enter と Space でフォーカス中の行き先を実行します(Web のリンクでは Enter だけ)。無効な行き先はフォーカスを受け取らず、無効であることを伝えます。
- スタンダードでは、開くとフォーカスが中に入り、閉じると戻ります。Tab でコンテンツへ進んでも閉じません。モーダルでは、Tab と Shift+Tab はドロワーの中で折り返し、Escape とプラットフォームの「戻る」で閉じてフォーカスを戻します。
- フォーカスリングは項目の周りに、キーボードフォーカスのときだけ描きます。全部は見えていない項目にキーボードフォーカスが移ると、見えるところまで最小限だけスクロールします。
- ヒット領域は、どちらの形でもセル全体で、最小ターゲットを下回ることはありません。
- 文字を大きくしても、どちらの形の幅も変わらず、項目と見出しが高くなります。ラベルは折り返し、短いラベルは切り詰め、アイコンは拡大しません。
- 絞り込みの入力欄は、
filterLabelを名前とする検索フィールドで、項目の前にあり、ドロワーのリストを操作することを伝えます。クリアボタンの名前はfilterClearLabelです。「/」は入力欄のキーボードショートカット(Web ではaria-keyshortcuts)として伝え、キーのヒントは支援技術から隠します。 - 絞り込みで隠した行は、支援技術からも消えます。そのため、聞こえる位置と数はどれも絞り込み後のものです。入力が 1 秒止まると、ドロワー自身のステータスが、一致した行の数、または何も一致しないことを、フォーカスを動かさずに polite に伝えます。結果の先頭に描く件数は支援技術から隠し、代わりにステータスが伝えます。
- 一致した行に印は付けないため、色だけで伝える情報はありません。Enter で選ぶ行は、フォーカスのある行として描きます。行の名前はラベル全体のままです。
- ラベルのない行き先、
labelのないモーダルのドロワー、どの行き先も指していない値、重複した値、入れ子のセクション、グループの中のセクション、3 つより深い階層、デザインシステムにないバリアント、メニューボタンのない折りたためるドロワー、trailingスロットの中のフォーカスできる要素、javascript:のアドレスや読み取れないhref、定義にないtarget、targetがnewなのにtargetLabelのないリンクは、デバッグビルドで報告します。 デザインシステムにない密度と、selectableGroupsを付けていないのにvalueかhrefを持つグループも報告します。絞り込みでは、filterLabelのない入力欄、名前のないクリアボタン、2 つ以上の組み合わせを持つfilterShortcut、ほかのドロワーや検索がすでに使っている組み合わせを報告します。
プラットフォームごとの既知の制約:
- Web:Firefox はトップレイヤーから出ていく要素をアニメーションできないので、そこではモーダルのドロワーがスライドして出ていかず、すぐに消えます。
- Web:すべての寸法が
remに従うので、ブラウザーの文字サイズを大きくすると、アイコンも大きくなります。ドロワーの幅は変わりません。Tanrei の文字の大きさだけを変えたときは大きくなりません。 - Web:開いたスタンダードのドロワーから Tab でフォーカスが出ていくことはテストしていますが、コンテンツのどこに着くかは、負荷がかかると安定しなかったため、まだ確かめていません。
- SwiftUI は、どのビューがフォーカスを持っていたかを知ることができません。そのためドロワーを閉じても、キーボードフォーカスはどの要素にも戻らず、プラットフォームの既定の場所へ移ります。開いたときは現在の行き先か、なければ最初の有効な行き先にフォーカスが移り、ヘッダーのコントロールには移りません。Mac では、モーダルのドロワーが覆って無効にするのは、付けたビューだけです。ウィンドウのルートに付けてください。
- SwiftUI:Escape、アクセシビリティの「戻る」ジェスチャー、開いたときのフォーカスの移動は、まだ端から端までテストしていません。行き先は位置を値のテキスト(「2 of 6」)として持ち、英語だけです。
- Compose は、モーダルのドロワーを、Material のドロワーのようにアプリのウィンドウの中ではなく、
TanreiDialogと同じく専用のDialogウィンドウで表示します。見た目は同じで、そのウィンドウがフォーカスを中にとどめ、「戻る」に応え、背後を支援技術から隠します。 - Compose にはドロワー全体の値がないので、どの行き先も指していない値を報告する手段がありません。
- Flutter のモーダルのドロワーは
Scaffold.drawerではありません。ウィンドウいっぱいのStackの最後の子として置き、openで制御します。行き先は集合の中の位置を持ちません。 - Flutter:短い行を持つデザインシステムのように、行とその間隔を合わせてもタッチターゲットに届かないとき、ヒット領域だけを広げるのではなく、行同士の間が広がります。
- React Native は、どの要素がフォーカスを持っていたかを知ることができません。そのためドロワーを閉じても、開いた要素へはフォーカスを戻せません。モーダルのドロワーではプラットフォームが決めた場所へ移り、スタンダードのドロワーでは何もしません。
- React Native のドロワーには、まだ自分の
insetsプロパティがなく、TanreiProviderのインセットだけを読みます。行き先は位置を値のテキストとして持ち、positionTextを渡さなければ英語です。 - React Native:モーダルのドロワーのドラッグとフリング、フォーカスの移動、アクセシビリティの「戻る」ジェスチャーは、実機ではまだ確かめていません。
- 以前の版を提供している SwiftUI、Compose、Flutter、React Native:最初の項目はドロワーの余白から間隔の半分だけ下に置かれ、ラベルが折り返した行の高さの伸び方もそろっていません(SwiftUI と Compose は、文字が収まらなくなるまで行の最小の高さを保ちます)。追従するときに、余白を最初のセルまでで測り、行の高さを最小値として扱うようになります。
- Web:入力欄ですぐに選べる最初の一致はフォーカスのある行として描きますが、入力欄のアクティブな子孫ではありません。行き先はリンクかボタンで、入力欄のアクティブな子孫にはなれないためです。スクリーンリーダーの利用者は、下矢印でその行に着きます。
- SwiftUI、Compose、Flutter、React Native には、まだ絞り込みがありません。
- Web:モーダルの折りたためるドロワーは、列の幅まで狭まってからでないとフォーカスを戻さず、ドラッグするとパネル全体が動き、ダイアログは開いたときに測った列の位置に置かれます。
- すべての行き先にラベルを付けます。折りたたんだ列にラベルを描くとき(
collapsedLabels)は、列には長すぎるラベルにshortLabelも付けます。 targetがnewのリンクには、プロダクトの言語でtargetLabelを付けます。- サイトでは、各ページで
valueをそのページ自身の行き先に設定します。 responsiveのドロワーの表示がmodalの間は、ドロワーを開く自前のメニューボタンを表示します。- メニューボタンには「メニュー」のような名前を付けます。Web 以外のプラットフォームでは、
expandedChangeからexpandedかopenを設定します。 labelで「メール」のようにドロワーに名前を付けます。モーダルのドロワーはダイアログなので、これがその名前になります。- モーダルのドロワーは、「メニュー」のようなラベルを持つ、目に見えるメニューボタンから開きます。
openを合わせておきます。モーダルのドロワーが閉じたら、プラットフォームに応じてonClose、バインディング、ドロワーの状態から false にします。- SwiftUI では、ドロワーが閉じた後に、キーボードフォーカスをメニューボタンへ利用者側で戻します。
- React Native では、ドロワーが閉じた後にメニューボタンへのフォーカスの戻しを利用者側で行い、プロダクトの言語で
positionTextを渡し、ウィンドウのインセットをTanreiProviderに渡します。 - 各行き先の値は重複させず、スタンダードとモーダルのどちらでも変えないでおきます。
filterableのときは、何を絞り込むかを伝えるfilterLabel(「ナビゲーションを絞り込む」)を入力欄に付け、filterCountText、filterEmptyText、filterClearLabel、filterPlaceholderの文言を、ドロワーに、またはプロダクトの文言として一度だけ渡します。