jQuery UI API - アコーディオンウィジェット(Accordion Widget)

所属カテゴリ

ウィジェット(Widgets)

使用法

説明:タイトルとコンテンツパネルのペアをアコーディオンに変換します。

バージョンでの追加:1.0

アコーディオンコンテナのマークアップには、タイトルとコンテンツパネルのペアが必要です。

<div id="accordion">
  <h3>First header</h3>
  <div>First content panel</div>
  <h3>Second header</h3>
  <div>Second content panel</div>
</div>

アコーディオンは任意のマークアップをサポートしますが、各コンテンツパネルは関連するヘッダーパネルの次の兄弟要素である必要があります。カスタムマークアップ構造の使用方法については、headerオプションを参照してください。

パネルは、activeオプションを設定することでプログラム的にアクティブにできます。

キーボード操作

フォーカスがヘッダー(header)上にある場合、以下のキーボードコマンドを使用できます:

  • UP/LEFT - フォーカスを前のヘッダー(header)に移動します。最初のヘッダー(header)にある場合は、最後のヘッダー(header)にフォーカスを移動します。
  • DOWN/RIGHT - フォーカスを次のヘッダー(header)に移動します。最後のヘッダー(header)にある場合は、最初のヘッダー(header)にフォーカスを移動します。
  • HOME - フォーカスを最初のヘッダー(header)に移動します。
  • END - フォーカスを最後のヘッダー(header)に移動します。
  • SPACE/ENTER - フォーカスされたヘッダー(header)に関連するパネル(panel)をアクティブにします。

フォーカスがパネル(panel)内にある場合、以下のキーボードコマンドが使用できます:

  • CTRL+UP:フォーカスを関連するヘッダー(header)に移動します。

テーマ化

アコーディオンウィジェット(Accordion Widget)は、jQuery UI CSS フレームワークを使用して、外観とスタイルを定義します。アコーディオン固有のスタイルを使用する必要がある場合は、以下の CSS クラス名を使用できます:

  • ui-accordion:アコーディオンの外側のコンテナ。
    • ui-accordion-header:アコーディオンのヘッダー。ヘッダーにが含まれる場合、iconsヘッダーには追加のが付きます。ui-accordion-icons class。
    • ui-accordion-content:アコーディオンのコンテンツパネル。

依存関係

追加説明

  • このウィジェットは機能的な CSS を必要とします。そうしないと動作しません。カスタムテーマを作成する場合は、ウィジェット固有の CSS ファイルを出発点として使用してください。

クイックナビゲーション

オプション メソッド イベント

オプション 型 説明 デフォルト値
active Boolean または Integer 現在どのパネルが開いているか。

複数の型をサポート:

  • Boolean:false に設定すると、activeためにfalseすべてのパネルが折りたたまれます。これにはcollapsibleオプションが true である必要があります。true。
  • Integer:アクティブなパネルのインデックス(0 ベース)。負の値は最後のパネルから逆に選択します。

コード例:

指定されたactiveオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ active: 2 });
    

初期化後、activeオプションを取得または設定:

// getter
var active = $( ".selector" ).accordion( "option", "active" );
 
// setter
$( ".selector" ).accordion( "option", "active", 2 );
    
0
animate Boolean または Number または String または Object アニメーションを使用してパネルを変更するかどうか、およびその方法。

複数の型をサポート:

  • Boolean:false値はアニメーションを無効にします。
  • Number:easing のデフォルトの所要時間(ミリ秒単位)。
  • String:デフォルトの所要時間に使用するeasing名前。
  • Object:easingとdurationプロパティのアニメーション設定。
    • 上記の任意のオプションには、downプロパティを含めることができます。
    • アクティブになるパネルのインデックスが現在アクティブなパネルより小さい場合、"Down" アニメーションが発生します。

コード例:

指定されたanimateオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ animate: "bounceslide" });
    

初期化後、animateオプションを取得または設定:

// getter
var animate = $( ".selector" ).accordion( "option", "animate" );
 
// setter
$( ".selector" ).accordion( "option", "animate", "bounceslide" );
    
{}
collapsible Boolean すべてのセクションをすぐに閉じることができるかどうか。アクティブなセクションを折りたたむことを許可します。

コード例:

指定されたcollapsibleオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ collapsible: true });
    

初期化後、collapsibleオプションを取得または設定:

// getter
var collapsible = $( ".selector" ).accordion( "option", "collapsible" );
 
// setter
$( ".selector" ).accordion( "option", "collapsible", true );
    
false
disabled Boolean に設定すると、trueこの accordion が無効になります。

コード例:

指定されたdisabledオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ disabled: true });
    

初期化後、disabledオプションを取得または設定:

// getter
var disabled = $( ".selector" ).accordion( "option", "disabled" );
 
// setter
$( ".selector" ).accordion( "option", "disabled", true );
    
false
event String accordion のヘッダーが反応して関連するパネルをアクティブにするイベント。複数のイベントをスペース区切りで指定できます。

コード例:

指定されたeventオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ event: "mouseover" });
    

初期化後、eventオプションを取得または設定:

// getter
var event = $( ".selector" ).accordion( "option", "event" );
 
// setter
$( ".selector" ).accordion( "option", "event", "mouseover" );
    
"click"
header Selector ヘッダー要素のセレクター。メインの accordion 要素の .find() を使用して適用されます。コンテンツパネルは、関連するヘッダーの直後の兄弟要素である必要があります。

コード例:

指定されたheaderオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ header: "h3" });
    

初期化後、headerオプションを取得または設定:

// getter
var header = $( ".selector" ).accordion( "option", "header" );
 
// setter
$( ".selector" ).accordion( "option", "header", "h3" );
    
"> li > :first-child,> :not(li):even"
heightStyle String accordion と各パネルの高さを制御します。可能な値:
  • "auto":すべてのパネルが最も高いパネルの高さに設定されます。
  • "fill":accordion の親要素の高さに基づいて、利用可能な高さまで拡張されます。
  • "content":各パネルの高さはそのコンテンツに依存します。

コード例:

指定されたheightStyleオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ heightStyle: "fill" });
    

初期化後、heightStyleオプションを取得または設定:

// getter
var heightStyle = $( ".selector" ).accordion( "option", "heightStyle" );
 
// setter
$( ".selector" ).accordion( "option", "heightStyle", "fill" );
    
"auto"
icons Object ヘッダーに使用するアイコン。は、jQuery UI CSS フレームワークが提供するアイコン(Icons)に一致します。に設定するとfalseアイコンは表示されません。
  • header (string、デフォルト値:"ui-icon-triangle-1-e")
  • activeHeader (string、デフォルト値:"ui-icon-triangle-1-s")

コード例:

指定されたiconsオプションを使用して accordion を初期化:

$( ".selector" ).accordion({ icons: { "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" } });
    

初期化後、iconsオプションを取得または設定:

// getter
var icons = $( ".selector" ).accordion( "option", "icons" );
 
// setter
$( ".selector" ).accordion( "option", "icons", { "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" } );
    
{ "header": "ui-icon-triangle-1-e", "activeHeader": "ui-icon-triangle-1-s" }

メソッド 戻り値 説明
destroy() jQuery (plugin only) accordion 機能を完全に削除します。これにより、要素は初期化前の状態に戻ります。
  • このメソッドは引数を受け付けません。

コード例:

destroy メソッドを呼び出します:

$( ".selector" ).accordion( "destroy" );
    
disable() jQuery (plugin only) accordion を無効にします。
  • このメソッドは引数を受け付けません。

コード例:

disable メソッドを呼び出します:

$( ".selector" ).accordion( "disable" );
    
enable() jQuery (plugin only) accordion を有効にします。
  • このメソッドは引数を受け付けません。

コード例:

enable メソッドを呼び出します:

$( ".selector" ).accordion( "enable" );
    
option( optionName ) Object 指定されたoptionNameオプションに関連付けられた現在の値を取得します。
  • optionName
    型:String
    説明:取得するオプションの名前。

コード例:

このメソッドを呼び出します:

var isDisabled = $( ".selector" ).accordion( "option", "disabled" );
    
option() PlainObject 現在の accordion オプションハッシュを表すキーと値のペアを含むオブジェクトを取得します。
  • このメソッドは引数を受け付けません。

コード例:

このメソッドを呼び出します:

var options = $( ".selector" ).accordion( "option" );
    
option( optionName, value ) jQuery (plugin only) 指定されたoptionNameオプションに関連付けられた accordion オプションの値を設定します。
  • optionName
    型:String
    説明:設定するオプションの名前。
  • value
    型:Object
    説明:オプションに設定する値。

コード例:

このメソッドを呼び出す:

$( ".selector" ).accordion( "option", "disabled", true );
    
option( options ) jQuery (plugin only) accordion に1つ以上のオプションを設定します。
  • options
    型:Object
    説明:設定する option-value のペア。

コード例:

このメソッドを呼び出す:

$( ".selector" ).accordion( "option", { disabled: true } );
    
refresh() jQuery (plugin only) DOM内で直接追加または削除された見出しとパネルを処理し、accordion の高さを再計算します。結果はコンテンツとheightStyle オプションによって異なります。
  • このメソッドはパラメータを受け付けません。

コード例:

refresh メソッドを呼び出す:

$( ".selector" ).accordion( "refresh" );
    
widget() jQuery accordion を含むjQueryオブジェクトを返します。
  • このメソッドはパラメータを受け付けません。

コード例:

widget メソッドを呼び出す:

var widget = $( ".selector" ).accordion( "widget" );
    

イベント 型 説明
activate( event, ui ) accordionactivate パネルがアクティブ化された後に発生します(アニメーション完了後)。accordion が以前に折りたたまれていた場合、ui.oldHeaderとui.oldPanelは空の jQuery オブジェクトになります。accordion が折りたたまれている場合、ui.newHeaderとui.newPanelは空の jQuery オブジェクトになります。

注:activateイベントはパネルがアクティブになったときにのみ発生するため、accordion ウィジェットの作成時に最初のパネルはこのイベントを発生させません。ウィジェット作成用のフックが必要な場合は、createイベントを使用してください。

  • event
    型:Event
  • ui
    型:Object
    • newHeader
      型:jQuery
      説明:アクティブ化されたばかりの見出し。
    • oldHeader
      型:jQuery
      説明:非アクティブ化されたばかりの見出し。
    • newPanel
      型:jQuery
      説明:アクティブ化されたばかりのパネル。
    • oldPanel
      型:jQuery
      説明:非アクティブ化されたばかりのパネル。

コード例:

activate コールバックを指定して accordion を初期化する:

$( ".selector" ).accordion({
  activate: function( event, ui ) {}
});
    

accordionactivate イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "accordionactivate", function( event, ui ) {} );
    
beforeActivate( event, ui ) accordionbeforeactivate パネルがアクティブ化される直前に発生します。パネルがアクティブ化されるのを防ぐためにキャンセルできます。accordion が現在折りたたまれている場合、ui.oldHeaderとui.oldPanelは空の jQuery オブジェクトになります。accordion が折りたたまれている場合、ui.newHeaderとui.newPanelは空の jQuery オブジェクトになります。
  • event
    型:Event
  • ui
    型:Object
    • newHeader
      型:jQuery
      説明:アクティブ化される見出し。
    • oldHeader
      型:jQuery
      説明:非アクティブ化される見出し。
    • newPanel
      型:jQuery
      説明:アクティブ化されるパネル。
    • oldPanel
      型:jQuery
      説明:非アクティブ化されるパネル。

コード例:

beforeActivate コールバックを指定して accordion を初期化する:

$( ".selector" ).accordion({
  beforeActivate: function( event, ui ) {}
});
    

accordionbeforeactivate イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "accordionbeforeactivate", function( event, ui ) {} );
    
create( event, ui ) accordioncreate accordion の作成時に発生します。accordion が折りたたまれている場合、ui.headerとui.panelは空の jQuery オブジェクトになります。
  • event
    型:Event
  • ui
    型:Object
    • header
      型:jQuery
      説明:アクティブな見出し。
    • panel
      型:jQuery
      説明:アクティブなパネル。

コード例:

create コールバックを指定して accordion を初期化する:

$( ".selector" ).accordion({
  create: function( event, ui ) {}
});
    

accordioncreate イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "accordioncreate", function( event, ui ) {} );
    

例

シンプルな jQuery UI アコーディオン(Accordion)です。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>折叠面板部件(Accordion Widget)演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
  <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>
 
<div id="accordion">
  <h3>部分 1</h3>
  <div>
    <p>Mauris mauris ante, blandit et, ultrices a, suscipit eget.
    Integer ut neque. Vivamus nisi metus, molestie vel, gravida in,
    condimentum sit amet, nunc. Nam a nibh. Donec suscipit eros.
    Nam mi. Proin viverra leo ut odio.</p>
  </div>
  <h3>部分 2</h3>
  <div>
    <p>Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus.
    Vivamus hendrerit, dolor aliquet laoreet, mauris turpis velit,
    faucibus interdum tellus libero ac justo.</p>
  </div>
  <h3>部分 3</h3>
  <div>
    <p>Nam enim risus, molestie et, porta ac, aliquam ac, risus.
    Quisque lobortis.Phasellus pellentesque purus in massa.</p>
    <ul>
      <li>List item one</li>
      <li>List item two</li>
      <li>List item three</li>
    </ul>
  </div>
</div>
 
<script>
$( "#accordion" ).accordion();
</script>
 
</body>
</html>

その他の拡張