jQuery UI API - Componente de botón (Button Widget)
Categoría
Uso
Descripción:Botones y conjuntos de botones tematizables.
Nuevo en la versión:1.8
El componente de botón (Button Widget) mejora la funcionalidad de los elementos de formulario estándar, como botones (button), entradas (input) y anclas (anchor), tematizando los botones con estilos apropiados de hover y active.
Además de los botones básicos, los botones de opción y las casillas de verificación (input de tipo radio y checkbox) también se pueden convertir en botones. La etiqueta (label) asociada se diseña con el estilo de un botón y, al hacer clic, actualiza el input subyacente. Para que funcione correctamente, se debe dar al input unidatributo, y apuntar al de la etiqueta (label)foratributo. No coloque el input dentro de la etiqueta (label), de lo contrariocausará problemas de accesibilidad.。
Para agrupar botones de opción, Button también proporciona un widget adicional llamado Buttonset. Buttonset se usa seleccionando un elemento contenedor (que contiene los botones de opción) y llamando a.buttonset()para usarlo. Buttonset también proporciona agrupación visual, por lo que siempre que haya un grupo de botones se puede considerar su uso. Selecciona todos los descendientes y les aplica.button(). Puede habilitar y deshabilitar un conjunto de botones, lo que habilitará y deshabilitará todos los botones contenidos. Destruir el conjunto de botones llamará al de cada botóndestroymétodo. Para botones de opción y casillas de verificación agrupados, se recomienda usarlegenddefieldsetpara proporcionar una etiqueta de grupo accesible.
Cuando se usa un input de tipo button, submit o reset, solo se admiten etiquetas de texto sin iconos.
Tematización
El componente de botón (Button Widget) utilizael framework CSS de jQuery UIpara definir el estilo de su apariencia y sensación. Si necesita utilizar estilos específicos del botón, puede usar los siguientes nombres de clase CSS:
ui-button: representa el elemento DOM del botón. Este elemento, según latextyiconsopción, agregará una de las siguientes clases:ui-button-text-only、ui-button-icon-only、ui-button-icons-only、ui-button-text-icons。ui-button-icon-primary: elemento que muestra el icono principal del botón. Solo cuando el icono principal se proporciona en laiconsopción.ui-button-text: contenedor alrededor del contenido de texto del botón.ui-button-icon-secondary: se utiliza para mostrar el icono secundario del botón. Solo cuando el icono secundario se proporciona en laiconsopción.
ui-buttonset: contenedor externo del conjunto de botones (Buttonset).
Dependencias
Notas adicionales
- Este widget requiere algo de CSS funcional; de lo contrario, no funcionará. Si ha creado un tema personalizado, use 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 |
|---|---|---|---|
| disabled | Boolean | Si se establece entrue, el button queda deshabilitado.Ejemplo de código: Inicializa el button con la
$( ".selector" ).button({ disabled: true });
Después de la inicialización, obtenga o establezca la // getter var disabled = $( ".selector" ).button( "option", "disabled" ); // setter $( ".selector" ).button( "option", "disabled", true ); |
false |
| icons | Object | Iconos a mostrar, incluyendo iconos con texto e iconos sin texto (vertextopción). De forma predeterminada, el icono principal se muestra a la izquierda del texto de la etiqueta, y el icono secundario a la derecha. La posición de visualización se puede controlar mediante CSS.
Ejemplo de código: Inicializa el button con la
$( ".selector" ).button({ icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" } });
Después de la inicialización, obtenga o establezca la
// 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 | El texto a mostrar en el botón. Cuando no se especifica (null), se utiliza el contenido HTML del elemento, o si el elemento es un input de tipo submit o reset, se utiliza suvalueatributo, o si el elemento es un input de tipo radio o checkbox, se utiliza el contenido HTML del elemento label relacionado.Ejemplo de código: Inicializa el button con la
$( ".selector" ).button({ label: "custom label" });
Después de la inicialización, obtenga o establezca la // getter var label = $( ".selector" ).button( "option", "label" ); // setter $( ".selector" ).button( "option", "label", "custom label" ); |
null |
| text | Boolean | Si se muestra la etiqueta. Cuando se establece enfalse, no se muestra el texto, pero entonces debe habilitarse laiconsopción, de lo contrariotextla opción será ignorada.Ejemplo de código: Inicializa el button con la
$( ".selector" ).button({ text: false });
Después de la inicialización, obtenga o establezca la // getter var text = $( ".selector" ).button( "option", "text" ); // setter $( ".selector" ).button( "option", "text", false ); |
true |
| Métodos | Devuelve | Descripción |
|---|---|---|
| destroy() | jQuery (plugin only) | Elimina por completo la funcionalidad del button. Esto devuelve el elemento a su estado anterior a la inicialización.
Ejemplo de código: Llame al método destroy: $( ".selector" ).button( "destroy" ); |
| disable() | jQuery (plugin only) | Deshabilita el button.
Ejemplo de código: Llame al método disable: $( ".selector" ).button( "disable" ); |
| enable() | jQuery (plugin only) | Habilita el button.
Ejemplo de código: Llame al método enable: $( ".selector" ).button( "enable" ); |
| option( optionName ) | Object | Obtiene el valor actual asociado conoptionNamela opción especificada.
Ejemplo de código: Llame a este método: var isDisabled = $( ".selector" ).button( "option", "disabled" ); |
| option() | PlainObject | Obtiene un objeto que contiene pares clave/valor que representan el hash de opciones actual del button.
Ejemplo de código: Llame a este método: var options = $( ".selector" ).button( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | Establece el valor de la opción del button asociada con laoptionNameopción especificada.
Ejemplo de código: Llame a este método: $( ".selector" ).button( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | Establece una o más opciones para el button.
Ejemplo de código: Llame a este método:
$( ".selector" ).button( "option", { disabled: true } );
|
| refresh() | jQuery (plugin only) | Actualiza el estado visual del botón. Se usa para actualizar el estado del botón después de cambiar mediante programación el estado seleccionado o deshabilitado del elemento nativo.
Ejemplo de código: Llame al método refresh: $( ".selector" ).button( "refresh" ); |
| widget() | jQuery | Devuelve unjQueryobjeto que contiene el button.
Ejemplo de código: Llame al método widget: var widget = $( ".selector" ).button( "widget" ); |
| Eventos | Tipo | Descripción |
|---|---|---|
| create( event, ui ) | buttoncreate | Se activa cuando se crea el botón button.
Nota: Ejemplo de código: Inicializa el button con la devolución de llamada create especificada:
$( ".selector" ).button({
create: function( event, ui ) {}
});
Vincula un detector de eventos al evento buttoncreate:
$( ".selector" ).on( "buttoncreate", function( event, ui ) {} );
|
Ejemplos
Ejemplo 1:Un botón (Button) sencillo de 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>Ejemplo 2:
Un conjunto de botones (Buttonset) sencillo de 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>
Otras extensiones