jQuery UI API - Виджет Accordion

Категория

Виджеты

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

Описание:Превращает пару заголовков и панелей содержимого в аккордеон.

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

Разметка контейнера аккордеона требует пары заголовков и панелей содержимого.

<div id="accordion">
  <h3>First header</h3>
  <div>First content panel</div>
  <h3>Second header</h3>
  <div>Second content panel</div>
</div>

Аккордеон поддерживает произвольную разметку, но каждая панель содержимого должна быть следующим соседним элементом своего связанного заголовка. См.headerопции, чтобы узнать, как использовать пользовательскую структуру разметки.

Панели могут, установивactiveопцию, быть активированы программно.

Взаимодействие с клавиатурой

Когда фокус находится на заголовке, доступны следующие клавиатурные команды:

  • UP/LEFT - Переместить фокус на предыдущий заголовок. Если фокус на первом заголовке, переместить фокус на последний заголовок.
  • DOWN/RIGHT - Переместить фокус на следующий заголовок. Если фокус на последнем заголовке, переместить фокус на первый заголовок.
  • HOME - Переместить фокус на первый заголовок.
  • END - Переместить фокус на последний заголовок.
  • SPACE/ENTER - Активировать панель, связанную с заголовком в фокусе.

Когда фокус находится в панели, доступны следующие клавиатурные команды:

  • CTRL+UP: Переместить фокус на связанный заголовок.

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

Виджет Accordion используетjQuery UI CSS Frameworkдля определения стилизации его внешнего вида и поведения. Если вам нужно использовать стили, специфичные для аккордеона, можно использовать следующие имена CSS-классов:

  • ui-accordion: Внешний контейнер аккордеона.
    • ui-accordion-header: Заголовок аккордеона. Если заголовок содержитicons, заголовок также будет иметьui-accordion-icons класс.
    • ui-accordion-content: Панель содержимого аккордеона.

Зависимости

Дополнительные примечания

  • Для этого виджета требуется некоторый функциональный CSS, иначе он не будет работать. Если вы создаёте собственную тему, используйте CSS-файл, специфичный для виджета, в качестве отправной точки.

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

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

Параметры Type Описание Значение по умолчанию
active Boolean или Integer Какая панель в данный момент открыта.

Поддерживает несколько типов:

  • Boolean: Установитеactiveявляетсяfalseчтобы свернуть все панели. Для этого требуется, чтобыcollapsibleопция былаtrue。
  • Integer: Индекс панели для активации, отсчитываемый от нуля. Отрицательные значения выбирают панели в обратном порядке, начиная с последней панели.

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

Инициализируйте аккордеон с указаннымиactiveoption:

$( ".selector" ).accordion({ active: 2 });
    

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

// getter
var active = $( ".selector" ).accordion( "option", "active" );
 
// setter
$( ".selector" ).accordion( "option", "active", 2 );
    
0
animate Boolean, Number, String или Object Следует ли анимировать изменения панели и как.

Поддерживает несколько типов:

  • Boolean:falseзначение отключит анимацию.
  • Number: длительность сглаживания по умолчанию, в миллисекундах.
  • String: для длительности по умолчанию — названиесглаживания.
  • Object:easingиdurationНастройки анимации со свойствами.
    • Любой из вышеперечисленных параметров может содержатьdownсвойство.
    • Когда индекс активируемой панели меньше, чем у текущей активной панели, происходит анимация "Down".

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

Инициализируйте аккордеон с указаннымиanimateoption:

$( ".selector" ).accordion({ animate: "bounceslide" });
    

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

// getter
var animate = $( ".selector" ).accordion( "option", "animate" );
 
// setter
$( ".selector" ).accordion( "option", "animate", "bounceslide" );
    
{}
collapsible Boolean Можно ли закрыть все разделы одновременно. Позволяет свернуть активный раздел.

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

Инициализируйте аккордеон с указаннымиcollapsibleoption:

$( ".selector" ).accordion({ collapsible: true });
    

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

// getter
var collapsible = $( ".selector" ).accordion( "option", "collapsible" );
 
// setter
$( ".selector" ).accordion( "option", "collapsible", true );
    
false
disabled Boolean Если установлено значениеtrue, аккордеон отключён.

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

Инициализируйте аккордеон с указаннымиdisabledoption:

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

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

// getter
var disabled = $( ".selector" ).accordion( "option", "disabled" );
 
// setter
$( ".selector" ).accordion( "option", "disabled", true );
    
false
event String Событие, на которое будут реагировать заголовки аккордеона, чтобы активировать связанную панель. Можно указать несколько событий, разделённых пробелами.

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

Инициализируйте аккордеон с указаннымиeventoption:

$( ".selector" ).accordion({ event: "mouseover" });
    

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

// getter
var event = $( ".selector" ).accordion( "option", "event" );
 
// setter
$( ".selector" ).accordion( "option", "event", "mouseover" );
    
"click"
header Селектор Селектор для элемента заголовка, применяемый через .find() к главному элементу аккордеона. Панели содержимого должны быть соседними элементами, непосредственно следующими за связанными с ними заголовками.

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

Инициализируйте аккордеон с указаннымиheaderoption:

$( ".selector" ).accordion({ header: "h3" });
    

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

// getter
var header = $( ".selector" ).accordion( "option", "header" );
 
// setter
$( ".selector" ).accordion( "option", "header", "h3" );
    
"> li > :first-child,> :not(li):even"
heightStyle String Управляет высотой аккордеона и каждой панели. Возможные значения:
  • "auto": Для всех панелей будет установлена высота самой высокой панели.
  • "fill": Расширяется до доступной высоты на основе высоты родительского элемента аккордеона.
  • "content": Высота каждой панели определяется её содержимым.

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

Инициализируйте аккордеон с указаннымиheightStyleoption:

$( ".selector" ).accordion({ heightStyle: "fill" });
    

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

// getter
var heightStyle = $( ".selector" ).accordion( "option", "heightStyle" );
 
// setter
$( ".selector" ).accordion( "option", "heightStyle", "fill" );
    
"auto"
icons Object Иконки, которые нужно использовать для заголовков, ииконки (Icons), предоставляемые jQuery UI CSS Framework, совпадают. Установите вfalseто иконки не отображаются.
  • header (строка, по умолчанию: "ui-icon-triangle-1-e")
  • activeHeader (строка, по умолчанию: "ui-icon-triangle-1-s")

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

Инициализируйте аккордеон с указаннымиiconsoption:

$( ".selector" ).accordion({ icons: { "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" } });
    

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

// getter
var icons = $( ".selector" ).accordion( "option", "icons" );
 
// setter
$( ".selector" ).accordion( "option", "icons", { "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" } );
    
{ "header": "ui-icon-triangle-1-e", "activeHeader": "ui-icon-triangle-1-s" }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример кода:

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

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

Пример кода:

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

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

Пример кода:

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

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

Пример кода:

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

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

Events Type Описание
activate( event, ui ) accordionactivate Срабатывает после активации панели (после завершения анимации). Если аккордеон ранее был свёрнут, тоui.oldHeaderиui.oldPanelбудет пустым объектом jQuery. Если аккордеон сворачивается, тоui.newHeaderиui.newPanelбудет пустым объектом jQuery.

Примечание: Посколькуactivateсобытие может быть вызвано только при активации панели, при создании виджета-аккордеона начальная панель не вызовет это событие. Если вам нужен хук для создания виджета, используйтеcreateсобытие.

  • event
    Тип: Event
  • ui
    Тип: Object
    • newHeader
      Тип: jQuery
      Описание: Заголовок, который только что был активирован.
    • oldHeader
      Тип: jQuery
      Описание: Заголовок, который только что был деактивирован.
    • newPanel
      Тип: jQuery
      Описание: Панель, которая только что была активирована.
    • oldPanel
      Тип: jQuery
      Описание: Панель, которая только что была деактивирована.

Пример кода:

Инициализируйте аккордеон с указанным обратным вызовом активации:

$( ".selector" ).accordion({
  activate: function( event, ui ) {}
});
    

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

$( ".selector" ).on( "accordionactivate", function( event, ui ) {} );
    
beforeActivate( event, ui ) accordionbeforeactivate Срабатывает непосредственно перед активацией панели. Можно отменить, чтобы предотвратить активацию панели. Если аккордеон в данный момент свёрнут, тоui.oldHeaderиui.oldPanelбудет пустым объектом jQuery. Если аккордеон сворачивается, тоui.newHeaderиui.newPanelбудет пустым объектом jQuery.
  • event
    Тип: Event
  • ui
    Тип: Object
    • newHeader
      Тип: jQuery
      Описание: Заголовок, который нужно активировать.
    • oldHeader
      Тип: jQuery
      Описание: Заголовок, который нужно деактивировать.
    • newPanel
      Тип: jQuery
      Описание: Панель, которую нужно активировать.
    • oldPanel
      Тип: jQuery
      Описание: Панель, которую нужно деактивировать.

Пример кода:

Инициализируйте аккордеон с указанным обратным вызовом beforeActivate:

$( ".selector" ).accordion({
  beforeActivate: function( event, ui ) {}
});
    

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

$( ".selector" ).on( "accordionbeforeactivate", function( event, ui ) {} );
    
create( event, ui ) accordioncreate Срабатывает при создании аккордеона. Если аккордеон свёрнут,ui.headerиui.panelбудет пустым объектом jQuery.
  • event
    Тип: Event
  • ui
    Тип: Object
    • header
      Тип: jQuery
      Описание: Активированный заголовок.
    • panel
      Тип: jQuery
      Описание: Активированная панель.

Пример кода:

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

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

Привязать обработчик события к событию accordioncreate:

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

Примеры

Простой аккордеон jQuery UI.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>折叠面板部件(Accordion 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>
 
<div id="accordion">
  <h3>部分 1</h3>
  <div>
    <p>Mauris mauris ante, blandit et, ultrices a, suscipit eget.
    Integer ut neque. Vivamus nisi metus, molestie vel, gravida in,
    condimentum sit amet, nunc. Nam a nibh. Donec suscipit eros.
    Nam mi. Proin viverra leo ut odio.</p>
  </div>
  <h3>部分 2</h3>
  <div>
    <p>Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus.
    Vivamus hendrerit, dolor aliquet laoreet, mauris turpis velit,
    faucibus interdum tellus libero ac justo.</p>
  </div>
  <h3>部分 3</h3>
  <div>
    <p>Nam enim risus, molestie et, porta ac, aliquam ac, risus.
    Quisque lobortis.Phasellus pellentesque purus in massa.</p>
    <ul>
      <li>List item one</li>
      <li>List item two</li>
      <li>List item three</li>
    </ul>
  </div>
</div>
 
<script>
$( "#accordion" ).accordion();
</script>
 
</body>
</html>

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