アコーディオン

アコーディオンは、展開/折りたたんで詳細情報を表示できる、上位レベルのオプションのリストを表示します。


インストール

npx nextui-cli@latest add accordion
上記のコマンドは個別のインストール専用です。もし、 @nextui-org/react がグローバルにインストール済みの場合は、この手順をスキップできます。

インポート

NextUIは、アコーディオン関連の2つのコンポーネントをエクスポートします。

  • Accordion: アコーディオンアイテムのリストを表示するためのメインコンポーネントです。
  • AccordionItem: 単一のアコーディオンアイテムを表示するためのアイテムコンポーネントです。

使い方

サブタイトル付き

複数アイテムの展開

selectionModemultiple に設定すると、Accordion は複数のアイテムを同時に展開できるようになります。

コンパクト

isCompacttrue に設定すると、Accordion はコンパクトなスタイルで表示されます。

バリアント

アコーディオンには、light, shadow, bordered, splitted の4つのバリアントがあります。

ライトバリアント

シャドウバリアント

ボーダー付きバリアント

分割バリアント

デフォルトで展開されるキー

デフォルトでいくつかのアイテムを展開したい場合は、defaultExpandedKeys プロパティにキーの配列を設定できます。

無効化されたキー

いくつかのアイテムを無効化したい場合は、disabledKeys プロパティにキーの配列を設定できます。

開始コンテンツ

アコーディオンアイテムの前にコンテンツを表示したい場合は、startContent プロパティを設定できます。

カスタムインジケーター

アコーディオンアイテムには、indicator というプロパティがあります。これを使用して、開閉インジケーターをカスタマイズできます。

インジケーターは、functionであることもでき、その場合、isOpenisDisabled、そしてデフォルトのindicatorがパラメータとして渡されます。

カスタムモーション

アコーディオンは、enter / exitアニメーションをカスタマイズするためのmotionPropsプロパティを提供します。

Framer motionのバリアントについて詳しくは、こちらをご覧ください。

制御されたコンポーネント

アコーディオンは制御されたコンポーネントであり、selectedKeysプロパティを自分で制御する必要があります。

アコーディオンアイテムのスロット

  • base: アコーディオンアイテムのラッパー。
  • heading: アコーディオンアイテムの見出し。indicatortitleを含みます。
  • trigger: アコーディオンアイテムを開閉するボタン。
  • titleWrapper: titlesubtitleのラッパー。
  • title: アコーディオンアイテムのタイトル。
  • subtitle: アコーディオンアイテムのサブタイトル。
  • startContent: アコーディオンアイテムの前のコンテンツ。
  • indicator: アコーディオンアイテムの開閉状態を示す要素。
  • content: アコーディオンアイテムのコンテンツ。

カスタムアコーディオンスタイル

次のプロパティのいずれかを使用して、アコーディオンとアコーディオンアイテムのスタイルをカスタマイズできます。

  • className: アコーディオンのクラス名。アコーディオンラッパーのスタイルを変更します。(Accordion)
  • itemClasses: アコーディオンアイテムのクラス名。すべてのアコーディオンアイテムのスタイルを一度に変更します。(Accordion)
  • classNames: アコーディオンアイテムのクラス名。各アコーディオンアイテムのスタイルを個別に変更します。(AccordionItem)

アコーディオンのスタイルをカスタマイズする方法の例を次に示します。

データ属性

AccordionItembase要素には、次の属性があります。

  • data-open: アコーディオンアイテムが開いているかどうか。
  • data-disabled: アコーディオンアイテムが無効になっている場合。
  • data-hover: アコーディオンアイテムがホバーされている場合。useHoverに基づきます。
  • data-focus: アコーディオンアイテムがフォーカスされている場合。useFocusRingに基づきます。
  • data-focus-visible: アコーディオンアイテムがキーボードでフォーカスされている場合。useFocusRingに基づきます。
  • data-disabled: アコーディオンアイテムが無効になっている場合。isDisabledプロパティに基づきます。
  • data-pressed: アコーディオンアイテムが押されている場合。usePressに基づきます。

アクセシビリティ

  • SpaceEnterArrow UpArrow DownHome / Endキーのキーボードイベントをサポートします。
  • キーボードフォーカスの管理とクロスブラウザの正規化。
  • アコーディオンアイテムのaria-expanded属性。
  • アコーディオンアイテムのaria-disabled属性。
  • アコーディオンアイテムのaria-controls属性。

API

アコーディオンの Props

属性説明デフォルト
childrenReactNode | ReactNode[]コレクションの内容。通常はAccordionItemの配列。
variantlight | shadow | bordered | splittedアコーディオンの外観スタイル。light
selectionModenone | single | multipleコレクションで許可される選択の種類。
selectionBehaviortoggle | replaceアコーディオンの選択動作。toggle
isCompactbooleanすべてのアコーディオンアイテムを小さくするかどうか。false
isDisabledbooleanアコーディオンアイテムを無効にするかどうか。
showDividerboolean各アコーディオンアイテムの下部に区切り線を表示するかどうか。true
dividerPropsDividerProps区切り線コンポーネントのprops。-
hideIndicatorbooleanアコーディオンアイテムのインジケーターを非表示にするかどうか。
disableAnimationbooleanアコーディオンアイテムの開閉アニメーションを無効にするかどうか。
disableIndicatorAnimationbooleanアコーディオンアイテムのインジケーターアニメーションを無効にするかどうか。
disallowEmptySelectionbooleanコレクションで空の選択を許可するかどうか。
keepContentMountedbooleanアコーディオンアイテムのコンテンツを常にマウントしておくかどうか。false
fullWidthbooleanアコーディオンを親コンテナの全幅にするかどうか。true
motionPropsMotionPropsアコーディオンのモーションプロパティ。
disabledKeysReact.Key[]無効になっているアイテムのキー。これらのアイテムは選択、フォーカス、またはその他の操作を行うことはできません。
itemClassesClassnamesアコーディオンアイテムのclassNames。
selectedKeysall | React.Key[]コレクション内で現在選択されているキー (制御付き)。
defaultSelectedKeysall | React.Key[]コレクション内で最初に選択されているキー (非制御)。
disabledKeysReact.Key[]コレクション内で現在無効になっているキー (制御付き)。

アコーディオンのイベント

属性説明
onSelectionChange(keys: "all" | Set<React.Key>) => any選択が変更されたときに呼び出されるハンドラー。

アコーディオンアイテムのProps

属性説明デフォルト
childrenReactNode | stringコンポーネントの内容。
titleReactNode | stringアコーディオンアイテムのタイトル。
subtitleReactNode | stringアコーディオンアイテムのサブタイトル。
indicatorIndicatorPropsアコーディオンアイテムのexpandedインジケーター。通常は矢印アイコン。
startContentReactNodeアコーディオンアイテムの開始コンテンツ。通常はアイコンまたはアバター。
motionPropsMotionPropsframer motionアニメーションを修正するためのプロパティ。variants APIを使用して独自のアニメーションを作成します。
isCompactbooleanAccordionItemがコンパクトかどうか。false
isDisabledboolean現在の無効状態。false
keepContentMountedbooleanAccordionItemのコンテンツを閉じるときにマウントしておくかどうか。false
hideIndicatorbooleanAccordionItemのインジケーターを非表示にするかどうか。false
disableAnimationbooleanAccordionItemのアニメーションを無効にするかどうか。false
disableIndicatorAnimationbooleanAccordionItemのインジケーターアニメーションを無効にするかどうか。false
HeadingComponentReact.ElementTypeWebアクセシビリティのためのカスタマイズ可能な見出しタグ。見出しを使用してコンテンツを説明し、一貫性があり、セマンティックに使用します。h2
classNamesClassnamesアコーディオンアイテムのスロットにカスタムクラス名を設定できます。-

アコーディオンアイテムのイベント

属性説明
onFocus(e: FocusEvent) => void要素がフォーカスを受け取ったときに呼び出されるハンドラー。
onBlur(e: FocusEvent) => void要素がフォーカスを失ったときに呼び出されるハンドラー。
onFocusChange(isFocused: boolean) => void要素のフォーカス状態が変化したときに呼び出されるハンドラー。
onKeyDown(e: KeyboardEvent) => voidキーが押されたときに呼び出されるハンドラー。
onKeyUp(e: KeyboardEvent) => voidキーが離されたときに呼び出されるハンドラー。
onPress(e: PressEvent) => voidプレスがターゲット上でリリースされたときに呼び出されるハンドラー。
onPressStart(e: PressEvent) => voidプレスインタラクションが開始されたときに呼び出されるハンドラー。
onPressEnd(e: PressEvent) => voidプレスインタラクションがターゲット上で終了したとき、またはポインターがターゲットを離れたときに呼び出されるハンドラー。
onPressChange(isPressed: boolean) => voidプレス状態が変化したときに呼び出されるハンドラー。
onPressUp(e: PressEvent) => voidプレスがターゲット上でリリースされたときに呼び出されるハンドラー。ターゲットで開始されたかどうかは関係ありません。
onClickMouseEventHandlerネイティブボタンのクリックイベントハンドラー(非推奨)代わりにonPressを使用してください。

アコーディオンアイテムのインジケーターProps

export type AccordionItemIndicatorProps = {
/**
* The current indicator, usually an arrow icon.
*/
indicator?: ReactNode;
/**
* The current open status.
*/
isOpen?: boolean;
/**
* The current disabled status.
* @default false
*/
isDisabled?: boolean;
};
type indicator?: ReactNode | ((props: AccordionItemIndicatorProps) => ReactNode) | null;

アコーディオンアイテムのclassNames

export type AccordionItemClassnames = {
base?: string;
heading?: string;
trigger?: string;
titleWrapper?: string;
title?: string;
subtitle?: string;
startContent?: string;
indicator?: string;
content?: string;
};

モーションProps

export type MotionProps = {
/**
* If `true`, the opacity of the content will be animated
* @default true
*/
animateOpacity?: boolean;
/**
* The height you want the content in its collapsed state.
* @default 0
*/
startingHeight?: number;
/**
* The height you want the content in its expanded state.
* @default "auto"
*/
endingHeight?: number | string;
/**
* The y-axis offset you want the content in its collapsed state.
* @default 10
*/
startingY?: number;
/**
* The y-axis offset you want the content in its expanded state.
* @default 0
*/
endingY?: number;
} & HTMLMotionProps;