jQuery UI API - .toggleClass()

所属カテゴリ

エフェクト(Effects) | エフェクトコア(Effects Core) | メソッドオーバーライド(Method Overrides)

用法

説明:アニメーションのスタイルが変更されるとき、Class が存在するかどうか、および switch パラメータの値に応じて、一致する要素の集合内の各要素に対して 1 つ以上の Class を追加または削除します。

戻り値:jQuery

.toggleClass( className [, switch ] [, duration ] [, easing ] [, complete ] )

パラメータ 型 説明 デフォルト値
ClassName String 一致する要素の集合内の各要素に対して切り替える 1 つ以上の class 名。複数の class 名はスペースで区切ります。
switch Boolean class を追加するか削除するかを指定するブール値。
duration Number または String アニメーションの実行時間を指定する文字列または数値。 400
easing String 使用することを示す文字列easing関数。 swing
complete Function() アニメーションが完了したときに呼び出される関数。

.toggleClass( className [, switch ] [, options ] )

パラメータ 型 説明
ClassName String 一致する要素の集合内の各要素に対して切り替える 1 つ以上の class 名。複数の class 名はスペースで区切ります。
switch Boolean class を追加するか削除するかを指定するブール値。
options Object すべてのアニメーション設定。すべてのプロパティはオプションです。
  • duration(デフォルト値:400)
    型:Number または String
    説明:アニメーションの実行時間を指定する文字列または数値。
  • easing(デフォルト値:swing)
    型:String
    説明:使用することを示す文字列easing関数。
  • complete
    型:Function()
    説明:アニメーションが完了したときに呼び出される関数。
  • children(デフォルト値:false)
    型:Boolean
    説明:アニメーションを一致する要素のすべての子孫に適用するかどうかを指定します。この機能は慎重に使用してください。要素がアニメーションの子孫であるかを判断するコストは大きく、子孫の数に応じて線形に増加するためです。
  • queue(デフォルト値:true)
    型:Boolean または String
    説明:アニメーションをエフェクトキューに入れるかどうかを示すブール値。false の場合、アニメーションはすぐに開始されます。jQuery 1.7 以降、queue オプションは文字列も受け付けます。この場合、アニメーションは文字列で表されるキューに追加されます。

ネイティブの CSS トランジションと同様に、jQuery UI の class アニメーションは、ある状態から別の状態へのスムーズな遷移を提供し、すべてのスタイル変更の詳細が JavaScript を使用せずに CSS によって行われることを保証します。すべての class アニメーションメソッドは、.toggleClass()、アニメーションの期間とeasing関数をカスタマイズでき、アニメーションの完了時にはコールバックも提供されます。

すべてのスタイルをアニメーション化できるわけではありません。たとえば、背景画像をアニメーション化する場合です。アニメーション化できないスタイルは、アニメーションの終了時に変更されます。

このプラグインは jQuery 組み込みの.toggleClass()メソッドを拡張したものです。jQuery UI が読み込まれていない場合、.toggleClass()メソッドを呼び出しても直接失敗することはありません。このメソッドは jQuery に存在するためです。ただし、期待される動作は発生しません。

実例

一致する要素に対して class "big-blue" を切り替えます。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>.toggleClass() 演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <style>
  div {
    width: 100px;
    height: 100px;
    background-color: #ccc;
  }
  .big-blue {
    width: 200px;
    height: 200px;
    background-color: #00f;
  }
  </style>
  <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></div>
 
<script>
$( "div" ).click(function() {
  $( this ).toggleClass( "big-blue", 1000, "easeOutSine" );
});
</script>
 
</body>
</html>

その他の拡張