jQuery UI API - 選択可能ウィジェット(Selectable Widget)
カテゴリ
使用方法
説明:マウスを使用して単一の要素または要素グループを選択します。
追加されたバージョン:1.0
依存関係:
注釈:jQuery UI の選択可能(Selectable)プラグインは、マウスのドラッグによる要素の選択(「投げ縄」と呼ばれることもあります)を許可します。ctrl/meta キーを押しながらクリックまたはドラッグすることで、複数の(連続しない)要素を選択できます。
追加の説明:このウィジェットは機能するための CSS が必要です。そうでないと動作しません。カスタムテーマを作成する場合は、ウィジェット指定の CSS ファイルを開始点として使用してください。
クイックナビゲーション
| オプション | メソッド | イベント |
|---|---|---|
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| appendTo | Selector | 選択ヘルパー(投げ縄)をどの要素に追加するか。 コード例: 指定された
$( ".selector" ).selectable({ appendTo: "#someElem" });
初期化後に、取得または設定します // getter var appendTo = $( ".selector" ).selectable( "option", "appendTo" ); // setter $( ".selector" ).selectable( "option", "appendTo", "#someElem" ); |
"body" |
| autoRefresh | Boolean | このオプションは、各選択操作の開始時に各選択項目の位置とサイズを更新(再計算)するかどうかを決定します。項目が多数ある場合は、このオプションを false に設定し、手動でrefresh()メソッドを呼び出します。コード例: 指定された
$( ".selector" ).selectable({ autoRefresh: false });
初期化後に、取得または設定します // getter var autoRefresh = $( ".selector" ).selectable( "option", "autoRefresh" ); // setter $( ".selector" ).selectable( "option", "autoRefresh", false ); |
true |
| cancel | Selector | セレクタに一致する要素から選択を開始するのを防ぎます。 コード例: 指定された
$( ".selector" ).selectable({ cancel: "a,.cancel" });
初期化後に、取得または設定します // getter var cancel = $( ".selector" ).selectable( "option", "cancel" ); // setter $( ".selector" ).selectable( "option", "cancel", "a,.cancel" ); |
"input, textarea, button, select, option" |
| delay | Number | マウスを押してから選択が開始されるまでの時間(ミリ秒単位)。このオプションは、要素をクリックしたときに不要な選択が行われるのを防ぐことができます。 コード例: 指定された
$( ".selector" ).selectable({ delay: 150 });
初期化後に、取得または設定します // getter var delay = $( ".selector" ).selectable( "option", "delay" ); // setter $( ".selector" ).selectable( "option", "delay", 150 ); |
0 |
| disabled | Boolean | に設定すると、trueこの selectable は無効になります。コード例: 指定された
$( ".selector" ).selectable({ disabled: true });
初期化後に、取得または設定します // getter var disabled = $( ".selector" ).selectable( "option", "disabled" ); // setter $( ".selector" ).selectable( "option", "disabled", true ); |
false |
| distance | Number | マウスを押した後、選択が開始されるまでに移動しなければならない距離(ピクセル単位)。このオプションを指定すると、マウスのドラッグが指定距離を超えた場合にのみ選択が開始されます。このオプションは、要素をクリックしたときに不要な選択が行われるのを防ぐことができます。 コード例: 指定された
$( ".selector" ).selectable({ distance: 30 });
初期化後に、取得または設定します // getter var distance = $( ".selector" ).selectable( "option", "distance" ); // setter $( ".selector" ).selectable( "option", "distance", 30 ); |
0 |
| filter | Selector | 選択可能にする要素に一致する子要素。 コード例: 指定された
$( ".selector" ).selectable({ filter: "li" });
初期化後に、取得または設定します // getter var filter = $( ".selector" ).selectable( "option", "filter" ); // setter $( ".selector" ).selectable( "option", "filter", "li" ); |
"*" |
| tolerance | String | 投げ縄が項目を選択するかどうかをテストするためのモードを指定します。可能な値:
コード例: 指定された
$( ".selector" ).selectable({ tolerance: "fit" });
初期化後に、取得または設定します // getter var tolerance = $( ".selector" ).selectable( "option", "tolerance" ); // setter $( ".selector" ).selectable( "option", "tolerance", "fit" ); |
"touch" |
| メソッド | 戻り値 | 説明 |
|---|---|---|
| destroy() | jQuery (plugin only) | selectable 機能を完全に削除します。これにより、要素は初期化前の状態に戻ります。
コード例: destroy メソッドを呼び出します: $( ".selector" ).selectable( "destroy" ); |
| disable() | jQuery (plugin only) | selectable を無効にします。
コード例: disable メソッドを呼び出します: $( ".selector" ).selectable( "disable" ); |
| enable() | jQuery (plugin only) | selectable を有効にします。
コード例: enable メソッドを呼び出します: $( ".selector" ).selectable( "enable" ); |
| option( optionName ) | Object | 指定されたoptionNameに関連付けられた現在の値を取得します。
コード例: このメソッドを呼び出します: var isDisabled = $( ".selector" ).selectable( "option", "disabled" ); |
| option() | PlainObject | 現在の selectable オプションハッシュを表すキーと値のペアを含むオブジェクトを取得します。
コード例: このメソッドを呼び出します: var options = $( ".selector" ).selectable( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | 指定されたoptionNameに関連付けられた selectable オプションの値を設定します。
コード例: このメソッドを呼び出します: $( ".selector" ).selectable( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | selectable に 1 つ以上のオプションを設定します。
コード例: このメソッドを呼び出します:
$( ".selector" ).selectable( "option", { disabled: true } );
|
| refresh() | jQuery (plugin only) | 各選択項目要素の位置とサイズを更新します。autoRefreshオプションが false に設定されている場合、このメソッドを使用して各選択項目の位置とサイズを手動で再計算できます。
コード例: refresh メソッドを呼び出します: $( ".selector" ).selectable( "refresh" ); |
| widget() | jQuery | selectable 要素を含むjQueryオブジェクトを返します。
コード例: widget メソッドを呼び出します: var widget = $( ".selector" ).selectable( "widget" ); |
| イベント | 型 | 説明 |
|---|---|---|
| create( event, ui ) | selectablecreate | selectable が作成されたときにトリガーされます。
注: コード例: 指定された create コールバックを持つ selectable を初期化:
$( ".selector" ).selectable({
create: function( event, ui ) {}
});
selectablecreate イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectablecreate", function( event, ui ) {} );
|
| selected( event, ui ) | selectableselected | 各要素が選択に追加されたとき、選択操作の終わりにトリガーされます。
コード例: 指定された selected コールバックを持つ selectable を初期化:
$( ".selector" ).selectable({
selected: function( event, ui ) {}
});
selectableselected イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectableselected", function( event, ui ) {} );
|
| selecting( event, ui ) | selectableselecting | 各要素が選択に追加されたとき、選択操作の間にトリガーされます。
コード例: 指定された selecting コールバックを持つ selectable を初期化:
$( ".selector" ).selectable({
selecting: function( event, ui ) {}
});
selectableselecting イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectableselecting", function( event, ui ) {} );
|
| start( event, ui ) | selectablestart | 選択操作の開始時にトリガーされます。
注: コード例: 指定された start コールバックを持つ selectable を初期化:
$( ".selector" ).selectable({
start: function( event, ui ) {}
});
selectablestart イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectablestart", function( event, ui ) {} );
|
| stop( event, ui ) | selectablestop | 選択操作の最後にトリガーされます。
注意: コード例: 指定された stop コールバックを持つ selectable を初期化します:
$( ".selector" ).selectable({
stop: function( event, ui ) {}
});
selectablestop イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectablestop", function( event, ui ) {} );
|
| unselected( event, ui ) | selectableunselected | 各要素が選択から削除されると、選択操作の最後にトリガーされます。
コード例: 指定された unselected コールバックを持つ selectable を初期化します:
$( ".selector" ).selectable({
unselected: function( event, ui ) {}
});
selectableunselected イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectableunselected", function( event, ui ) {} );
|
| unselecting( event, ui ) | selectableunselecting | 各要素が選択から削除されると、選択操作中にトリガーされます。
コード例: 指定された unselecting コールバックを持つ selectable を初期化します:
$( ".selector" ).selectable({
unselecting: function( event, ui ) {}
});
selectableunselecting イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "selectableunselecting", function( event, ui ) {} );
|
例
シンプルな jQuery UI セレクタブルウィジェット(Selectable Widget)。
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>可选择小部件(Selectable Widget)演示</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
<style>
#selectable .ui-selecting {
background: #ccc;
}
#selectable .ui-selected {
background: #999;
}
</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>
<ul id="selectable">
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
<li>Item 4</li>
<li>Item 5</li>
</ul>
<script>
$( "#selectable" ).selectable();
</script>
</body>
</html>
その他の拡張