jQuery UI API - Widget de Acordeón (Accordion Widget)
Categoría
Uso
Descripción:Convierte un par de encabezado y panel de contenido en un acordeón.
Novedad en la versión:1.0
El marcado del contenedor del acordeón requiere un par de encabezado y panel de contenido.
<div id="accordion"> <h3>First header</h3> <div>First content panel</div> <h3>Second header</h3> <div>Second content panel</div> </div>
El acordeón admite cualquier marcado, pero cada panel de contenido debe ser el hermano siguiente del panel de encabezado correspondiente. Consulteheaderla opción para saber cómo usar una estructura de marcado personalizada.
Los paneles pueden activarse mediante programación estableciendo laactiveopción.
Interacción con el teclado
Cuando el foco está en el encabezado, están disponibles los siguientes comandos de teclado:
- ARRIBA/IZQUIERDA - Mueve el foco al encabezado anterior. Si está en el primer encabezado, mueve el foco al último encabezado.
- ABAJO/DERECHA - Mueve el foco al siguiente encabezado. Si está en el último encabezado, mueve el foco al primer encabezado.
- INICIO - Mueve el foco al primer encabezado.
- FIN - Mueve el foco al último encabezado.
- ESPACIO/ENTRAR - Activa el panel asociado al encabezado que tiene el foco.
Cuando el foco está en el panel, están disponibles los siguientes comandos de teclado:
- CTRL+ARRIBA: Mueve el foco al encabezado correspondiente.
Tematización
El widget de acordeón (Accordion Widget) utiliza elmarco CSS de jQuery UIpara definir el estilo de su apariencia y comportamiento. Si necesita usar estilos específicos del acordeón, puede usar los siguientes nombres de clase CSS:
ui-accordion: Contenedor exterior del acordeón.ui-accordion-header: Encabezado del acordeón. Si el encabezado contiene unicons, el encabezado tendrá además unui-accordion-iconsclass。ui-accordion-content: Panel de contenido del acordeón.
Dependencias
- Núcleo UI (UI Core)
- Fábrica de widgets (Widget Factory)
- Núcleo de efectos (Effects Core)(Opcional; cuando se usa con la
animateopción)
Notas adicionales
- Este widget requiere algo de CSS funcional; de lo contrario, no funcionará. Si crea un tema personalizado, utilice el archivo CSS específico del widget como punto de partida.
Navegación rápida
| Opciones | Métodos | Eventos |
|---|---|---|
| Opciones | Tipo | Descripción | Valor por defecto |
|---|---|---|---|
| active | Boolean o Integer | Qué panel está abierto actualmente. Admite varios tipos:
Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ active: 2 });
Después de la inicialización, obtener o establecer la opción // getter var active = $( ".selector" ).accordion( "option", "active" ); // setter $( ".selector" ).accordion( "option", "active", 2 ); |
0 |
| animate | Boolean, Number, String u Object | Si se usan animaciones para cambiar los paneles y cómo se usan. Admite varios tipos:
Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ animate: "bounceslide" });
Después de la inicialización, obtener o establecer la opción // getter var animate = $( ".selector" ).accordion( "option", "animate" ); // setter $( ".selector" ).accordion( "option", "animate", "bounceslide" ); |
{} |
| collapsible | Boolean | Si todas las secciones se pueden cerrar inmediatamente. Permite plegar la sección activa. Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ collapsible: true });
Después de la inicialización, obtener o establecer la opción // getter var collapsible = $( ".selector" ).accordion( "option", "collapsible" ); // setter $( ".selector" ).accordion( "option", "collapsible", true ); |
false |
| disabled | Boolean | Si se establece entrue, el acordeón se deshabilita.Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ disabled: true });
Después de la inicialización, obtener o establecer la opción // getter var disabled = $( ".selector" ).accordion( "option", "disabled" ); // setter $( ".selector" ).accordion( "option", "disabled", true ); |
false |
| event | String | El evento al que reacciona el encabezado del acordeón para activar el panel correspondiente. Se pueden especificar varios eventos separados por espacios. Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ event: "mouseover" });
Después de la inicialización, obtener o establecer la opción // getter var event = $( ".selector" ).accordion( "option", "event" ); // setter $( ".selector" ).accordion( "option", "event", "mouseover" ); |
"click" |
| header | Selector | Selector para los elementos de encabezado, aplicado mediante .find() sobre el elemento principal del acordeón. Los paneles de contenido deben ser elementos hermanos que sigan inmediatamente al encabezado correspondiente. Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ header: "h3" });
Después de la inicialización, obtener o establecer la opción // getter var header = $( ".selector" ).accordion( "option", "header" ); // setter $( ".selector" ).accordion( "option", "header", "h3" ); |
"> li > :first-child,> :not(li):even" |
| heightStyle | String | Controla la altura del acordeón y de cada panel. Valores posibles:
Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ heightStyle: "fill" });
Después de la inicialización, obtener o establecer la opción // getter var heightStyle = $( ".selector" ).accordion( "option", "heightStyle" ); // setter $( ".selector" ).accordion( "option", "heightStyle", "fill" ); |
"auto" |
| icons | Object | Iconos a usar para los encabezados, que coinciden con losiconos (Icons) proporcionados por el marco CSS de jQuery UI. Si se establece enfalse, no se muestran iconos.
Ejemplo de código: Inicializar el acordeón con la opción
$( ".selector" ).accordion({ icons: { "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" } });
Después de la inicialización, obtener o establecer la opción
// 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" } |
| Métodos | Devuelve | Descripción |
|---|---|---|
| destroy() | jQuery (plugin only) | Elimina por completo la funcionalidad del acordeón. Esto devuelve el elemento a su estado anterior a la inicialización.
Ejemplo de código: Llamar al método destroy: $( ".selector" ).accordion( "destroy" ); |
| disable() | jQuery (plugin only) | Deshabilita el acordeón.
Ejemplo de código: Llamar al método disable: $( ".selector" ).accordion( "disable" ); |
| enable() | jQuery (plugin only) | Habilita el acordeón.
Ejemplo de código: Llamar al método enable: $( ".selector" ).accordion( "enable" ); |
| option( optionName ) | Object | Obtiene el valor actualmente asociado con laoptionNameopción especificada.
Ejemplo de código: Llamar al método: var isDisabled = $( ".selector" ).accordion( "option", "disabled" ); |
| option() | PlainObject | Obtiene un objeto con pares clave/valor que representan el hash de opciones actual del acordeón.
Ejemplo de código: Llamar al método: var options = $( ".selector" ).accordion( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | Establece el valor de la opción del acordeón asociada a laoptionNameopción especificada.
Ejemplo de código: Llamar al método: $( ".selector" ).accordion( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | Establece una o más opciones para el accordion.
Ejemplo de código: Llamar al método:
$( ".selector" ).accordion( "option", { disabled: true } );
|
| refresh() | jQuery (plugin only) | Procesa cualquier encabezado o panel añadido o eliminado directamente en el DOM y recalcula la altura del accordion. El resultado depende del contenido yheightStyle las opciones.
Ejemplo de código: Llamar al método refresh: $( ".selector" ).accordion( "refresh" ); |
| widget() | jQuery | Devuelve un objeto que contiene eljQueryaccordion.
Ejemplo de código: Llamar al método widget: var widget = $( ".selector" ).accordion( "widget" ); |
| Eventos | Tipo | Descripción |
|---|---|---|
| activate( event, ui ) | accordionactivate | Se dispara después de que un panel sea activado (después de que la animación se complete). Si el accordion estaba previamente colapsado, entoncesui.oldHeaderyui.oldPanelserá un objeto jQuery vacío. Si el accordion se está colapsando, entoncesui.newHeaderyui.newPanelserá un objeto jQuery vacío.Nota: dado que el
Ejemplo de código: Inicializa el accordion con el callback activate especificado:
$( ".selector" ).accordion({
activate: function( event, ui ) {}
});
Vincula un detector de eventos al evento accordionactivate:
$( ".selector" ).on( "accordionactivate", function( event, ui ) {} );
|
| beforeActivate( event, ui ) | accordionbeforeactivate | Se dispara directamente antes de que un panel sea activado. Puede cancelarse para evitar que el panel se active. Si el accordion está actualmente colapsado, entoncesui.oldHeaderyui.oldPanelserá un objeto jQuery vacío. Si el accordion se está colapsando, entoncesui.newHeaderyui.newPanelserá un objeto jQuery vacío.
Ejemplo de código: Inicializa el accordion con el callback beforeActivate especificado:
$( ".selector" ).accordion({
beforeActivate: function( event, ui ) {}
});
Vincula un detector de eventos al evento accordionbeforeactivate:
$( ".selector" ).on( "accordionbeforeactivate", function( event, ui ) {} );
|
| create( event, ui ) | accordioncreate | Se dispara cuando se crea el accordion. Si el accordion está colapsado,ui.headeryui.panelserá un objeto jQuery vacío.
Ejemplo de código: Inicializa el accordion con el callback create especificado:
$( ".selector" ).accordion({
create: function( event, ui ) {}
});
Vincula un detector de eventos al evento accordioncreate:
$( ".selector" ).on( "accordioncreate", function( event, ui ) {} );
|
Ejemplos
Un simple acordeón (Accordion) de 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>
Otras extensiones