jQuery UI API - Виджет Button

Категория

Виджеты

Использование

Описание:Кнопки и наборы кнопок с поддержкой тем.

Добавлено в версии:1.8

Виджет Button расширяет функциональность стандартных элементов форм, таких как кнопки, поля ввода и ссылки, чтобы оформлять их подходящими стилями при наведении и активном состоянии.

Помимо базовых кнопок, радиокнопки и флажки (типы input radio и checkbox) также можно преобразовать в кнопки. Связанная метка оформляется как кнопка, и нажатие на неё обновляет соответствующий input. Чтобы это работало правильно, input должен иметьidатрибут, и он должен указывать на labelforатрибут. Не размещайте input внутри label, иначе этовызовет проблемы с доступностью。

Чтобы сгруппировать радиокнопки, Button также предоставляет дополнительный виджет под названием Buttonset. Buttonset используется путем выбора элемента-контейнера (содержащего радиокнопки) и вызова.buttonset(). Buttonset также обеспечивает визуальную группировку, поэтому его можно рассматривать, когда есть группа кнопок. Он выбирает всех потомков и применяет.button(). Вы можете включать и отключать Buttonset, что включит и отключит все содержащиеся кнопки. Уничтожение Buttonset вызывает у каждой кнопкиdestroyметод. Для сгруппированных радиокнопок и кнопок-флажков рекомендуется использоватьlegendизfieldsetчтобы обеспечить доступную метку группы.

При использовании input типа button, submit или reset поддерживаются только простые текстовые метки без иконок.

Темы оформления

Виджет Button используетjQuery UI CSS Frameworkдля определения стиля своего внешнего вида. Если вам нужно использовать стили, специфичные для кнопок, вы можете использовать следующие имена 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-файл, специфичный для виджета, в качестве отправной точки.

Быстрая навигация

Параметры Методы Events

Параметры Type Описание Default
disabled Boolean Если установлено значениеtrue, кнопка отключена.

Примеры кода:

Инициализировать кнопку с указаннымиdisabledoption:

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

После инициализации получите или задайтеdisabledoption:

// getter
var disabled = $( ".selector" ).button( "option", "disabled" );
 
// setter
$( ".selector" ).button( "option", "disabled", true );
    
false
icons Object Иконки для отображения, включая иконки с текстом и иконки без текста (см.textопция). По умолчанию основная иконка отображается слева от текста метки, а вторичная иконка — справа. Позицией отображения можно управлять через CSS.

primaryиsecondaryЗначение атрибута должно бытьименем класса иконки, например,"ui-icon-gear". Если используется только одна иконка, тоicons: { primary: "ui-icon-locked" }. Если используются две иконки, тоicons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }。

Примеры кода:

Инициализировать кнопку с указаннымиiconsoption:

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

После инициализации получите или задайтеdisabledoption:

// 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-содержимое элемента, или если элемент является элементом input типа submit или reset, егоvalueиспользуется атрибут, или, если элемент является input-элементом типа radio или checkbox, используется HTML-содержимое связанного элемента label.

Примеры кода:

Инициализировать кнопку с указаннымиlabeloption:

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

После инициализации получите или задайтеlabeloption:

// getter
var label = $( ".selector" ).button( "option", "label" );
 
// setter
$( ".selector" ).button( "option", "label", "custom label" );
    
null
text Boolean Отображать ли метку. Если установлено вfalse, текст не отображается, ноiconsопция должна быть включена, иначеtextопция будет проигнорирована.

Примеры кода:

Инициализировать кнопку с указаннымиtextoption:

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

После инициализации получите или задайтеtextoption:

// getter
var text = $( ".selector" ).button( "option", "text" );
 
// setter
$( ".selector" ).button( "option", "text", false );
    
истина

Методы Возвращает Описание
destroy() jQuery (только плагин) Полностью удаляет функциональность кнопки. Возвращает элемент в состояние до инициализации.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод destroy:

$( ".selector" ).button( "destroy" );
    
disable() jQuery (только плагин) Отключает кнопку.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод disable:

$( ".selector" ).button( "disable" );
    
enable() jQuery (только плагин) Включает кнопку.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод enable:

$( ".selector" ).button( "enable" );
    
option( optionName ) Object Получает значение, связанное в данный момент с указаннымoptionNameпараметр.
  • optionName
    Тип: String
    Описание: Имя опции, которую нужно получить.

Примеры кода:

Вызовите метод:

var isDisabled = $( ".selector" ).button( "option", "disabled" );
    
option() PlainObject Возвращает объект, содержащий пары ключ/значение, которые представляют текущий хэш параметров кнопки.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод:

var options = $( ".selector" ).button( "option" );
    
option( optionName, value ) jQuery (только плагин) Устанавливает значение параметра кнопки, связанного с указаннымoptionNameпараметр.
  • optionName
    Тип: String
    Описание: Имя опции, которую нужно установить.
  • value
    Тип: Object
    Описание: Значение, задаваемое для параметра.

Примеры кода:

Вызовите метод:

$( ".selector" ).button( "option", "disabled", true );
    
option( options ) jQuery (только плагин) Устанавливает один или несколько параметров для кнопки.
  • options
    Тип: Object
    Описание: Пары «параметр — значение» для установки.

Примеры кода:

Вызовите метод:

$( ".selector" ).button( "option", { disabled: true } );
    
refresh() jQuery (только плагин) Обновляет визуальное состояние кнопки. Используется для обновления состояния кнопки после программного изменения состояния выбора или отключённого состояния нативного элемента.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод refresh:

$( ".selector" ).button( "refresh" );
    
widget() jQuery Возвращает объект jQuery, содержащийjQueryкнопку.
  • Этот метод не принимает аргументов.

Примеры кода:

Вызовите метод widget:

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

Events Type Описание
create( event, ui ) buttoncreate Срабатывает при создании кнопки.
  • event
    Тип: Event
  • ui
    Тип: Object

Примечание:uiОбъект пуст, и он включён сюда для согласованности с другими событиями.

Примеры кода:

Инициализируйте кнопку с указанной функцией обратного вызова create:

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

Привяжите обработчик события к событию buttoncreate:

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

Примеры

Пример 1:

Простая кнопка jQuery UI.

<!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:

Простой Buttonset jQuery UI.

<!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>

Другие расширения