Tooltip 1.9 追加

本来のツールチップをテーマ別にカスタマイズされたものに置き換えます。

ブラウザが表示するツールチップをテーマ毎のもの、またはカスタマイズしたものに置き換えます。

  • タイトルだけでなく、インライン脚注やAjaxを介して取得したコンテンツを表示します。
  • 位置の調整をします。例えば、「要素の下の中央」といった指定が可能です。
  • 拡張したスタイルを追加することで、警告やエラーといった表現をすることが可能です。

ツールチップの表示、非表示にはフェードアニメーションが使用されています。 このアニメーションはshowとhideオプションで変更することが可能です。

itemsとcontentsは同期されている必要があります。 片方を変更する場合は、もう片方も変更するようにしてください。

通常、無効になっている要素はDOMイベントをトリガしません。 したがって、無効な要素のツールチップのプロパティを制御することが出来ず、 ツールチップを表示/非表示する際には、イベントをリッスンし続けなければいけません。 結果としてjQuery UIは無効な要素に対してのツールチップの挙動を保証することが出来ません。 そのため、残念ながら無効な要素に対してツールチップを実装する必要がある場合、 jQuery UIのツールチップとネイティブのツールチップが混合してしまうかもしれません。

ツールチップはいくつかの機能的なCSSを必要とします。 このCSSが読み込めないと機能しないため、最初に必要とするCSSを読み込むようにしてください。

依存関係

  • UI Core(jquery.ui.core.js)
  • Widget Factory
  • Position
  • Effects Core(jquery.ui.effect.js, showとhideオプションで使用)
オプション 説明
content

型:Function() or String 初期値:(title属性を返す関数)

ツールチップの内容を指定します。 このオプションを変更する際には、同様にitemsオプションも変更するようにしてください。

$( ".selector" ).tooltip({ content: "Awesome title!" });
// getter
var content = $( ".selector" ).tooltip( "option", "content" );

// setter
$( ".selector" ).tooltip( "option", "content", "Awesome title!" );
disabled

型:Boolean
初期値:false

trueを指定すると、ツールチップを無効化します。

hide

型:Boolean or Number or String or Object
初期値:null

ツールチップを隠す際にアニメーションするか、またどのようにアニメーションするかを指定します。

Boolean
falseが指定されるとアニメーションはされず、即座に非表示になります。 trueを指定すると、デフォルト指定されているdurationとeasingによるフェードアウトアニメーションになります。
Number
指定された値のdurationとデフォルト指定のeasingによるフェードアウトになります。
String
指定されたエフェクト名でhideアニメーションを行います。
"slideUp"のようなjQueryのエフェクトも、"fold"のようなjQuery UIのエフェクトのどちらも指定可能です。
いずれの場合もdurationとeasingはデフォルトのものが使用されます。
Object
オブジェクトの場合は、effect, duration, easingのプロパティが提供されています。
effectにjQueryのメソッド名が指定されればそれを使用し、そうでなければjQuery UIのエフェクト名が指定されたとみなして処理します。 もし、jQuery UI effectに追加の設定をしていれば、それを使用することも可能です。
durationまたはeasingが省略された場合は、デフォルト値が使用されます。 effectが省略された場合は、"fadeOut"が使用されます。
items

型:Selector
初期値:[title]

ツールチップとして表示したいセレクタを指定します。 title属性以外のものをツールチップのコンテンツとしたい場合や イベントによってセレクタを変えたい場合にカスタマイズをします。 このオプションを変更する場合は、contentオプションも同じように変更する必要があります。

position

型:Object
初期値:{ my: "left top+15", at: "left bottom", collision: "flipfit" }

位置の設定を行います。 ofプロパティの初期値は対象要素になっていますが、これは上書き可能です。 以前は初期値は、 { my: "left+15 center", at: "right center", collision: "flipfit" }でしたが、 jQuery UI 1.9.0ではよりネイティブのツールチップに近い位置に変更されました。

show

型:Boolean or Number or String or Object
初期値:null

ツールチップを表示する際にアニメーションするか、またどのようにアニメーションするかを指定します。

Boolean
falseが指定されるとアニメーションはされず、即座に表示されます。 trueを指定すると、デフォルト指定されているdurationとeasingによるフェードインアニメーションになります。
Number
指定された値のdurationとデフォルト指定のeasingによるフェードインになります。
String
指定されたエフェクト名でhideアニメーションを行います。
"slideUp"のようなjQueryのエフェクトも、"fold"のようなjQuery UIのエフェクトのどちらも指定可能です。
いずれの場合もdurationとeasingはデフォルトのものが使用されます。
Object
オブジェクトの場合は、effect, duration, easingのプロパティが提供されています。
effectにjQueryのメソッド名が指定されればそれを使用し、そうでなければjQuery UIのエフェクト名が指定されたとみなして処理します。 もし、jQuery UI effectに追加の設定をしていれば、それを使用することも可能です。
durationまたはeasingが省略された場合は、デフォルト値が使用されます。 effectが省略された場合は、"fadeIn"が使用されます。
tooltipClass

型:String 初期値:null

ツールチップのウィジットにclassを追加します。 警告やエラー用のスタイルを表現する際などに使用されます。 これはclassesオプションに取って代えられる可能性があります。

track

型:Boolean 初期値:false

ツールチップがマウスに追従するか否かを指定します。

メソッド説明
close()

ツールチップを閉じます。 これは非委任ツールチップ(ツールチップに紐づけている要素とは関係ない要素?)から呼ばれるために用意されています。

$( ".selector" ).tooltip( "close" );
destroy()

ツールチップの機能を完全に削除します。

disable()

ツールチップを無効化します。

enable()

ツールチップを有効にします。

open()

ツールチップを開きます。 これは非委任ツールチップ(ツールチップに紐づけている要素とは関係ない要素?)から呼ばれるために用意されています。

option( optionName )

戻り値:Object

optionNameに指定したオプションの現在の値を取得します。

optionName
型:String
取得したいオプションの名前を指定します。
option()

戻り値:PlainObject

オプションの各キーと値がペアとなったオブジェクトを返します。

option( optionName, value )

引数のoptionNameのオプションに値を設定します。

optionName
型:String
設定したいオプションの名前を指定します。
value
型:Object
設定したい値を指定します。
option( options )

オプションに設定したい各キーと値がペアとなったオブジェクトを指定します。

option
型:Object
設定したいオプションのキーと名前のペアを指定します。
widget()

戻り値:Object

ツールチップを含めたjQueryオブジェクトを返します。

イベント 説明
close( event, ui )

型:tooltipclose

ui.tooltip
型:jQuery
生成されたツールチップ要素です。

フォーカスが外れた(focusout)、またはマウスポインタが外れた(mouseleave)りして、 ツールチップが閉じられた際にトリガされます。

$( ".selector" ).tooltip({
    close: function( event, ui ) {}
});
$( ".selector" ).on( "tooltipclose", function( event, ui ) {} );
create( event, ui )

型:tooltipcreate

ツールチップが生成された際にトリガされます。

open( event, ui )

型:tooltipopen

ui.tooltip
型:jQuery
生成されたツールチップ要素です。

フォーカスが当たった(focusin)、またはマウスポオーバー(mouseover)したなど、 ツールチップが表示された際にトリガされます。

 Back to top

© 2010 - 2017 STUDIO KINGDOM