ドキュメントを検索

Collapsible

コンテンツのセクションを表示または非表示にするボタン。

CollapsibleはDisclosure (Show/Hide) WAI-ARIAデザインパターンに準拠しています。

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

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

  return (
    <Collapsible.Root class="collapsible-default-root">
      <Collapsible.Trigger class="collapsible-default-trigger">
        <span>Can I use this component in my project?</span>
        <LuChevronDown class="collapsible-default-chevron" aria-hidden="true" />
      </Collapsible.Trigger>
      <Collapsible.Content class="collapsible-default-content">
        Yes! It is headless, fully accessible, and styled with plain CSS.
      </Collapsible.Content>
    </Collapsible.Root>
  );
});

インストール#

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

pnpm add @leve-ui/collapsible

構造#

import { Collapsible } from '@leve-ui/collapsible'; // or '@leve-ui/core'

<Collapsible.Root>
  <Collapsible.Trigger />
  <Collapsible.Content />
</Collapsible.Root>
パーツ要素説明
Collapsible.Root<div>各パーツをラップし、開閉状態を保持します。
Collapsible.Trigger<button>コンテンツを開閉するボタン。
Collapsible.Content<div>表示または非表示にされるコンテンツ。

例#

開く#

defaultOpenはコンテンツを初期状態で開きます。

A headless, accessible UI component library built for Qwik.

Disabled#

Rootのdisabledはトリガーを無効化するため、コンテンツを開閉できなくなります。

Controlled#

bind:openはシグナルで開閉状態を制御するため、Collapsibleの外部にあるボタンから開閉できます。

APIリファレンス#

Root#

Propデフォルト型
ids–{ trigger?: string; content?: string }

パーツの要素IDをオーバーライドします。

defaultOpenfalseboolean

コンテンツが初期状態で開いているかどうか(非制御)。

bind:open–Signal<boolean>

開閉状態を保持するシグナル(制御)。

onOpenChange$–QRL<(open: boolean) => void>

ユーザーがコンテンツを開閉したときに呼び出されます。

disabledfalseboolean

Triggerを無効化します。

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

データ属性値
data-leve-collapsible常に存在
data-state"open" | "closed"
data-disabled無効時に存在

開閉状態はdefaultOpenで非制御に、bind:openで制御できます。ユーザーがコンテンツを開閉するとonOpenChange$が呼び出されます。

Trigger#

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

データ属性値
data-leve-collapsible-trigger常に存在
data-state"open" | "closed"
data-disabled無効時に存在

Rootが無効化されている場合、トリガーにはネイティブのdisabled属性が付与されます。

Content#

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

データ属性値
data-leve-collapsible-content常に存在
data-state"open" | "closed"
data-disabled無効時に存在

コンテンツが閉じている間、hidden属性が付与されます。トリガーのaria-controlsが参照し続けられるよう、DOM内に留まります。

アクセシビリティ#

Disclosure (Show/Hide) WAI-ARIAデザインパターンに準拠しています。

  • Collapsible.Triggerは、コンテンツを指すaria-expandedとaria-controlsを持つ<button type="button">です。IDはuseId()で生成されるか、Rootのidsで設定されます。
  • トリガーの名前はそのテキストによって決まります。アイコンのみを含む場合は、aria-labelを指定してください。
  • 無効化されたトリガーはTabでスキップされます。

キーボード操作#

キー説明
Enter / Spaceコンテンツを開閉します。