jQuery UI API - .toggleClass()

Categoría

Efectos (Effects) | Núcleo de efectos (Effects Core) | Sobrecarga de métodos (Method Overrides)

Uso

Descripción:Cuando el estilo de la animación cambia, según si la Class existe y el valor del parámetro switch, agrega o elimina una o más Classes para cada elemento del conjunto de elementos coincidentes.

Devuelve:jQuery

.toggleClass( className [, switch ] [, duration ] [, easing ] [, complete ] )

Parámetros Tipo Descripción Valor predeterminado
ClassName String Uno o más nombres de class para alternar en cada elemento del conjunto de elementos coincidentes; varios nombres de class se separan por espacios.
switch Boolean Un valor booleano que especifica si la class debe agregarse o eliminarse.
duration Number o String Una cadena o un número que especifica cuánto tiempo durará la animación. 400
easing String Una cadena que indica laeasingfunción. swing
complete Function() Función que se llamará cuando se complete la animación.

.toggleClass( className [, switch ] [, options ] )

Parámetros Tipo Descripción
ClassName String Uno o más nombres de class para alternar en cada elemento del conjunto de elementos coincidentes; varios nombres de class se separan por espacios.
switch Boolean Un valor booleano que especifica si la class debe agregarse o eliminarse.
options Object Todas las opciones de animación. Todas las propiedades son opcionales.
  • duration(Valor predeterminado:400)
    Tipo: Number o String
    Descripción: Una cadena o un número que especifica cuánto tiempo durará la animación.
  • easing(Valor predeterminado:swing)
    Tipo: String
    Descripción: Una cadena que indica laeasingfunción.
  • complete
    Tipo: Function()
    Descripción: Función que se llamará cuando se complete la animación.
  • children(Valor predeterminado:false)
    Tipo: Boolean
    Descripción: Especifica si la animación se aplica a todos los descendientes de los elementos coincidentes. Esta característica debe usarse con precaución, ya que determinar si un elemento es descendiente del elemento animado es costoso y crece linealmente con el número de descendientes.
  • queue(Valor predeterminado:true)
    Tipo: Boolean o String
    Descripción: Un valor booleano que indica si la animación se coloca en la cola de efectos. Si es false, la animación comenzará inmediatamente.A partir de jQuery 1.7,, la opción queue también acepta una cadena; en este caso, la animación se agrega a la cola representada por dicha cadena.

Al igual que las transiciones CSS nativas, las animaciones de class de jQuery UI proporcionan una transición suave de un estado a otro, al tiempo que garantizan que todos los detalles de los cambios de estilo se realicen mediante CSS y no requieran JavaScript. Todos los métodos de animación de class, incluido.toggleClass(), permiten personalizar la duración de la animación yeasingfunción, y también proporcionan un callback cuando la animación se completa.

No todos los estilos pueden animarse. Por ejemplo, animar una imagen de fondo. Cualquier estilo que no pueda animarse cambiará al final de la animación.

Este complemento extiende el método incorporado de jQuery.toggleClass(). Si jQuery UI no está cargado, llamar al.toggleClass()método no fallará directamente, porque ese método existe en jQuery. Pero no ocurrirá el comportamiento esperado.

Ejemplo

Alterna la class "big-blue" en los elementos coincidentes.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>.toggleClass() 演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <style>
  div {
    width: 100px;
    height: 100px;
    background-color: #ccc;
  }
  .big-blue {
    width: 200px;
    height: 200px;
    background-color: #00f;
  }
  </style>
  <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></div>
 
<script>
$( "div" ).click(function() {
  $( this ).toggleClass( "big-blue", 1000, "easeOutSine" );
});
</script>
 
</body>
</html>

Otras extensiones