ドキュメントを検索

Accordion

コンテンツの各セクションの表示・非表示を切り替える見出しの積み重ね。

AccordionはAccordionのWAI-ARIAデザインパターンに従います。

import { component$, useStyles$ } from '@builder.io/qwik';
import { Accordion } from '@leve-ui/accordion';
import { LuChevronDown } from '@qwikest/icons/lucide';
import styles from './default.css?inline';

export default component$(() => {
  useStyles$(styles);

  return (
    <Accordion.Root class="accordion-default-root">
      <Accordion.Item value="item-1" class="accordion-default-item">
        <Accordion.Header class="accordion-default-header">
          <Accordion.Trigger class="accordion-default-trigger">
            <span>What is leve-ui?</span>
            <LuChevronDown class="accordion-default-chevron" aria-hidden="true" />
          </Accordion.Trigger>
        </Accordion.Header>
        <Accordion.Content class="accordion-default-content">
          leve-ui is a headless UI component library built for Qwik with full WAI-ARIA compliance.
        </Accordion.Content>
      </Accordion.Item>

      <Accordion.Item value="item-2" class="accordion-default-item">
        <Accordion.Header class="accordion-default-header">
          <Accordion.Trigger class="accordion-default-trigger">
            <span>Is it accessible?</span>
            <LuChevronDown class="accordion-default-chevron" aria-hidden="true" />
          </Accordion.Trigger>
        </Accordion.Header>
        <Accordion.Content class="accordion-default-content">
          Yes, all components follow WAI-ARIA Authoring Practices Guide (APG) patterns and keyboard
          interactions.
        </Accordion.Content>
      </Accordion.Item>

      <Accordion.Item value="item-3" class="accordion-default-item">
        <Accordion.Header class="accordion-default-header">
          <Accordion.Trigger class="accordion-default-trigger">
            <span>Can I customize the styles?</span>
            <LuChevronDown class="accordion-default-chevron" aria-hidden="true" />
          </Accordion.Trigger>
        </Accordion.Header>
        <Accordion.Content class="accordion-default-content">
          Yes, leve-ui components are headless and unstyled. You can style them using CSS, Tailwind,
          or any CSS-in-JS library.
        </Accordion.Content>
      </Accordion.Item>
    </Accordion.Root>
  );
});

インストール#

個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。

pnpm add @leve-ui/accordion

構造#

import { Accordion } from '@leve-ui/accordion'; // or '@leve-ui/core'

<Accordion.Root>
  <Accordion.Item value="item-1">
    <Accordion.Header>
      <Accordion.Trigger />
    </Accordion.Header>
    <Accordion.Content />
  </Accordion.Item>
</Accordion.Root>
パーツ要素説明
Accordion.Root<div>各項目をラップし、どの項目が開いているかを保持します。
Accordion.Item<div>valueで識別される、ヘッダーとコンテンツのペア。
Accordion.Header<h1>–<h6>Triggerをラップする見出し。levelでレベルを設定します(デフォルトは3)。
Accordion.Trigger<button>コンテンツを表示または非表示にします。
Accordion.Content<div>コンテンツのセクション。項目が閉じている間は非表示になります。

例#

Multiple#

type="multiple"を指定すると、複数の項目を同時に開くことができます。

leve-ui is a headless UI component library built for Qwik with full WAI-ARIA compliance.

Collapsible#

collapsibleを指定すると、開いている項目のTriggerを再度アクティブにして閉じることができます。

leve-ui is a headless UI component library built for Qwik with full WAI-ARIA compliance. Learn more about leve-ui

Disabled#

Accordion.Itemにdisabledを指定するとその項目が無効化されます。Rootにdisabledを指定するとすべての項目が無効化されます。

Controlled#

外部から開いている項目を読み取ったり変更したりするには、シグナルをbind:valueに渡します。

leve-ui is a headless UI component library built for Qwik with full WAI-ARIA compliance.

Open items: item-1

APIリファレンス#

Root#

Propデフォルト型
type'single''single' | 'multiple'

同時に開くことができるアイテムの数。 - 'single': 最大1個のアイテム - 'multiple': 任意の数のアイテム

defaultValue[]string[]

初期状態で開いているアイテムの値(非制御)。

bind:value–Signal<string[]>

開いているアイテムの値を保持するシグナル(制御)。

onValueChange$–QRL<(value: string[]) => void>

ユーザーがアイテムを開閉したときに呼び出されます。

collapsiblefalseboolean

typeが'single'の場合、開いているアイテムを再度アクティブ化して閉じられるようにします。

disabledfalseboolean

すべてのアイテムを無効化します。

orientation'vertical''vertical' | 'horizontal'

Accordionの向き。フォーカスを移動する矢印キーを決定します。

looptrueboolean

矢印キーで最後のTriggerから最初のTriggerへ、またはその逆へループするかどうか。

すべての<div>属性も受け入れます。

データ属性値
data-leve-accordion常に存在
data-orientation"vertical" | "horizontal"
data-disabledRootが無効化されている場合に存在

開いている項目はdefaultValueでは非制御、bind:valueでは制御されます。ユーザーが項目を開閉するとonValueChange$が呼び出されます。

Item#

Propデフォルト型
value (必須)–string

このアイテムを識別する一意の値。

disabledfalseboolean

このアイテムを無効化します。

すべての<div>属性も受け入れます。

データ属性値
data-leve-accordion-item常に存在
data-state"open" | "closed"
data-disabled項目またはRootが無効化されている場合に存在
data-orientation"vertical" | "horizontal"
Propデフォルト型
level31 | 2 | 3 | 4 | 5 | 6

Triggerをラップする要素の見出しレベル(1〜6)。

すべての<h1>–<h6>属性も受け入れます。

データ属性値
data-leve-accordion-header常に存在
data-state"open" | "closed"
data-disabled項目が無効化されている場合に存在
data-orientation"vertical" | "horizontal"

Trigger#

独自のpropはありません。 すべての<button>属性を受け入れます。

データ属性値
data-leve-accordion-trigger常に存在
data-state"open" | "closed"
data-disabled項目が無効化されている場合に存在
data-orientation"vertical" | "horizontal"

無効化された項目のTriggerにはネイティブのdisabled属性が付与されます。

Content#

独自のpropはありません。 すべての<div>属性を受け入れます。

データ属性値
data-leve-accordion-content常に存在
data-state"open" | "closed"
data-disabled項目が無効化されている場合に存在
data-orientation"vertical" | "horizontal"

コンテンツは、項目が閉じている間hidden属性を持ちます。Triggerのaria-controlsが参照し続けられるよう、DOM内に留まります。

アクセシビリティ#

Accordion WAI-ARIAデザインパターンに準拠しています。

  • Accordion.Triggerは<button type="button">であり、そのコンテンツを指すaria-expandedとaria-controlsを持ちます。
  • Accordion.Contentはrole="region"と、トリガーを指すaria-labelledbyを持ちます。IDはuseId()で生成されます。
  • ページのヘッダー構造に合ったAccordion.Headerのlevelを選択してください。
  • typeが"single"かつcollapsibleがfalseの場合、開いているアイテムのトリガーは閉じることができないため、aria-disabled="true"を持ちます。
  • 無効化されたトリガーは、Tabおよび矢印キーによってスキップされます。

キーボード操作#

キー説明
Enter / Spaceフォーカスされているトリガーのアイテムを開閉します。
Tab / Shift+Tab次または前のフォーカス可能な要素にフォーカスを移動します。
ArrowDown / ArrowUporientationが"vertical"の場合、次または前のトリガーにフォーカスを移動します。
ArrowRight / ArrowLeftorientationが"horizontal"の場合、次または前のトリガーにフォーカスを移動します(右から左のテキストでは逆になります)。
Home / End最初または最後のトリガーにフォーカスを移動します。

loopがtrue(デフォルト)の場合、矢印キー操作は最後のトリガーから最初へ、また最初から最後へとループします。