jQuery UI API - ボタンウィジェット(Button Widget)

所属カテゴリ

ウィジェット(Widgets)

使用方法

説明:テーマ化可能なボタンとボタンセット。

追加されたバージョン:1.8

ボタンウィジェット(Button Widget)は、ボタン(button)、入力(input)、アンカー(anchor)などの標準フォーム要素の機能を強化し、適切なホバー(hover)およびアクティブ(active)スタイルでボタンをテーマ化します。

基本的なボタンに加えて、ラジオボタンとチェックボックス(input タイプが radio と checkbox)もボタンに変換できます。関連するラベル(label)はボタンのスタイルとして設計され、クリックすると基になる入力が更新されます。正常に動作させるには、input に...を指定する必要があります。id属性を指定し、ラベル(label)の...属性を指すようにします。for属性。input をラベル(label)内に配置しないでください。そうしないとアクセシビリティの問題が発生します。。

ラジオボタンをグループ化するために、Button は Buttonset という追加のウィジェットも提供します。Buttonset は、コンテナ要素(ラジオボタンを含む)を選択して...を呼び出すことで.buttonset()使用します。Buttonset は視覚的なグループ化も提供するため、ボタンのグループがある場合は常に使用を検討できます。すべての子孫を選択し、それらに...を適用します。.button()ボタンセットを有効または無効にすることができ、これにより含まれるすべてのボタンが有効または無効になります。ボタンセットを破棄すると、各ボタンの...メソッドが呼び出されます。destroyメソッド。グループ化されたラジオボタンとチェックボックスボタンには、...を使用することをお勧めしますlegendのfieldsetアクセシブルなグループラベルを提供します。

タイプが button、submit、または reset の input を使用する場合、アイコンなしのプレーンテキストラベルのみがサポートされます。

テーマ化

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

  • ui-button:ボタンの DOM 要素を表します。この要素は...オプションに応じてtextとicons次のクラスのいずれかが追加されます:ui-button-text-only、ui-button-icon-only、ui-button-icons-only、ui-button-text-icons。
    • ui-button-icon-primary:ボタンのメインアイコンを表示するための要素。メインアイコンが...でiconsオプションで提供されている場合にのみ表示されます。
    • ui-button-text:ボタンのテキストコンテンツの周囲にあるコンテナ。
    • ui-button-icon-secondary:ボタンのセカンダリアイコンを表示するための要素。セカンダリアイコンが...でiconsオプションで提供されている場合にのみ表示されます。
  • ui-buttonset:Buttonset の外側のコンテナ。

依存関係

追加の説明

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

クイックナビゲーション

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

オプション 型 説明 デフォルト値
disabled Boolean ...に設定した場合、trueこの button は無効になります。

コード例:

指定されたdisabledオプションの button を初期化します:

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

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

// getter
var disabled = $( ".selector" ).button( "option", "disabled" );
 
// setter
$( ".selector" ).button( "option", "disabled", true );
    
false
icons Object 表示するアイコン。テキスト付きアイコンとテキストなしアイコンが含まれます(...を参照textオプション)。デフォルトでは、メインアイコンはラベルテキストの左側に表示され、セカンダリアイコンは右側に表示されます。表示位置は CSS で制御できます。

primaryとsecondary属性値は...である必要がありますアイコンクラス名、例えば、"ui-icon-gear"。アイコンを1つだけ使用する場合は、icons: { primary: "ui-icon-locked" }2つのアイコンを使用する場合は、icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }。

コード例:

指定されたiconsオプションの button を初期化します:

$( ".selector" ).button({ icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" } });
    

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

// getter
var icons = $( ".selector" ).button( "option", "icons" );
 
// setter
$( ".selector" ).button( "option", "icons", { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" } );
    
{ primary: null, secondary: null }
label String ボタンに表示するテキスト。未指定の場合(null)、要素の HTML コンテンツが使用されます。または、要素が submit または reset タイプの input 要素の場合は、そのvalue属性が使用されます。または、要素が radio または checkbox タイプの input 要素の場合は、関連する label 要素の HTML コンテンツが使用されます。

コード例:

指定されたlabelオプションの button を初期化します:

$( ".selector" ).button({ label: "custom label" });
    

初期化後、...を取得または設定します:labelオプション:

// getter
var label = $( ".selector" ).button( "option", "label" );
 
// setter
$( ".selector" ).button( "option", "label", "custom label" );
    
null
text Boolean ラベルを表示するかどうか。...に設定するとfalse、テキストは表示されませんが、その場合...を有効にする必要がありますiconsオプション。そうしないとtextオプションは無視されます。

コード例:

指定されたtextオプションの button を初期化します:

$( ".selector" ).button({ text: false });
    

初期化後、...を取得または設定します:textオプション:

// getter
var text = $( ".selector" ).button( "option", "text" );
 
// setter
$( ".selector" ).button( "option", "text", false );
    
true

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

コード例:

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

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

コード例:

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

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

コード例:

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

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

コード例:

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

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

コード例:

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

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

コード例:

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

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

コード例:

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

$( ".selector" ).button( "option", { disabled: true } );
    
refresh() jQuery (plugin only) ボタンの視覚状態を更新します。ネイティブ要素の選択状態または無効状態をプログラムで変更した後に、ボタンの状態を更新するために使用します。
  • このメソッドはパラメータを受け付けません。

コード例:

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

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

コード例:

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

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

イベント 型 説明
create( event, ui ) buttoncreate button が作成されたときにトリガーされます。
  • event
    型:Event
  • ui
    型:Object

注:uiオブジェクトは空です。他のイベントとの一貫性を保つためにここに含まれています。

コード例:

指定された create コールバックを使用して button を初期化します:

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

イベントリスナーを buttoncreate イベントにバインドします:

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

サンプル

サンプル 1:

シンプルな jQuery UI ボタン(Button)。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>按钮部件(Button 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>
 
<button>按钮标签</button>
 
<script>
$( "button" ).button();
</script>
 
</body>
</html>

サンプル 2:

シンプルな jQuery UI ボタンセット(Buttonset)。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>按钮部件(Button 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>
 
<form>
  <fieldset>
    <legend>最喜欢的 jQuery 项目</legend>
    <div id="radio">
      <input type="radio" id="sizzle" name="project">
      <label for="sizzle">Sizzle</label>
 
      <input type="radio" id="qunit" name="project" checked="checked">
      <label for="qunit">QUnit</label>
 
      <input type="radio" id="color" name="project">
      <label for="color">Color</label>
    </div>
  </fieldset>
</form>
 
<script>
$( "#radio" ).buttonset();
</script>
 
</body>
</html>

その他の拡張