.toggleClass()S2C Home « Attributes & Properties « .toggleClass()

• <<    .removeClass()
• .css()     >>

Toggling classes in CSS.

Description

The .toggleClass() method is used to add or remove the specified class(es) from each element of the matched set.

• If no parameters are passed to the .toggleClass() method, the first time the method is activated all classes will be toggled off. To reactivate these classes you would then have to use the .toggleClass() method with parameters or the .addClass() method.

The .toggleClass( [ switch ] ) method was depercated in jQuery 3.0.

The .toggleClass( classNames [, switch ] ) method was added in jQuery 3.3.

Syntax

Parameters

Return

A jQuery object.

.toggleClass( [ switch ] ) **DEPRECATED 3.0** ExampleTop

Remove all classes for each element within the matched set optionally filtered with a boolean switch.

In the example below when we press the left button we toggle off (remove) all classes from the table below. Further clicks do nothing unles we add more classes through this or another method.

When we click the right button we check to see if the table below contains the class 'testtable'. If it doesn't it has been toggled off either through this button or the left button and we add the classes back to the table. If 'testtable' exists we set a boolean primitive to true and then use this primitive in our call to the .toggleClass( switch ) signature.

$(function(){
  $('#btn9').on('click', function() {
    $('.testtable').toggleClass(); 
  });
  $('#btn10').on('click', function() {
    var aBoolean = false;
    $('#table1').each(function (index, tableElement) { 
       if ($(this).hasClass('testtable')) { 
    	   aBoolean = true; // class exists
       };
    });
    if (aBoolean) {
    	alert('We are toggling the classes off');
    	$('.testtable').toggleClass( aBoolean );
    } else {
    	alert('We are adding the classes');
        $('#table1').addClass('javatable testtable');
    };
  });
});

.toggleClass( className [, switch ] ) ExamplesTop

Toggle one or more classes for each element within the matched set optionally filtered with a boolean switch.

In the example below when we press the left button we toggle the 'turnAqua' class on and off to change table data in the table below to aqua or revert them to their original colour.

When we press the right button we check the table to see if the 'turnAqua' class exists and if so we toggle it off using a JavaScript Boolean object as the second parameter. If the 'turnAqua' class doesn't exist we toggle it on using a JavaScript Boolean object as the second parameter.

.turnAqua {
  background-color: aqua;
}

$(function(){
  $('#btn11').on('click', function() {
    $('.testtable2').toggleClass('turnAqua'); 
  });
  $('#btn12').on('click', function() {
    trueBoolean = new Boolean(true);
    var aBoolean = false;
    $('.testtable2 tr').each(function (index, tableElement) { 
      if ($(this).hasClass('turnAqua')) { 
        aBoolean = true;
      };
    });
    if (aBoolean) {
        alert('We are toggling the turnAqua class off');
        $('.testtable2 tr').toggleClass('turnAqua', trueBoolean);
    } else {
        alert('We are toggling the turnAqua class on');
        $('.testtable2 tr').toggleClass('turnAqua', trueBoolean);
    };
  });
});

.toggleClass( classNames [, switch ] ) ExamplesTop

Toggle an array of classes for each element within the matched set optionally filtered with a boolean switch.

In the example below when we press the left button we toggle the 'turnAqua' and 'turnColorWhite' classes on and off to change table data in the table below to aqua with white writing or revert them to their original colour.

When we press the right button we check the table to see if the 'turnAqua' class exists and if so we toggle it and the 'turnColorWhite' class off using a JavaScript Boolean object as the second parameter. If the 'turnAqua' class doesn't exist we toggle it and the 'turnColorWhite' class on using a JavaScript Boolean object as the second parameter.

.turnAqua {
  background-color: aqua;
}
.turnColorWhite {
  color:white;
}

$(function(){
  $('#btn19').on('click', function() {
    $('.testtable5').toggleClass(['turnAqua', 'turnColorWhite']); 
  });
  
  $('#btn20').on('click', function() {
    trueBoolean = new Boolean(true);
    var aBoolean = false;
    $('.testtable5 tr').each(function (index, tableElement) { 
      if ($(this).hasClass('turnAqua')) { 
        aBoolean = true;
      };
    });
    if (aBoolean) {
        alert('We are toggling the turnAqua and turnColorWhite classes off');
        $('.testtable5 tr').toggleClass(['turnAqua', 'turnColorWhite'], trueBoolean);
    } else {
        alert('We are toggling the turnAqua and turnColorWhite classes on');
        $('.testtable5 tr').toggleClass(['turnAqua', 'turnColorWhite'], trueBoolean);
    };
  });
});

.toggleClass( function(index, class [, switch ] ) ExamplesTop

A function returning one or more classes to be removed from each element within the matched set.

In the example below when we press the button we select all 'td' elements within the table with an id of 'testtable3'. We then iterate over the collection toggling (in this case removing) any classes. We end up with all rows returned to a colour of orange.

$(function(){
  $('#btn13').on('click', function() {
    $('.testtable3 td').toggleClass( function( index, class) {
      return class;
    });
  });
});

In the example below we never action anything as the Boolean we pass is set to false.

$(function(){
  $('#btn14').on('click', function() {
    var idValue = $(this).attr('id');     // btn14
    var toNum = idValue.charAt(4);        // 4
    aBoolean = new Boolean(toNum % 2);    // 0 so false
    alert(aBoolean);
    $('.testtable4 td').toggleClass( function( index, currentClass, aBoolean) {
      if (aBoolean) {
        return currentClass;
      }	else {
        return '';
      }
    });
  });
});

• <<    .removeClass()
• .css()     >>