← Back to Index

.toggleClass()

Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument.

Examples

1. Toggle class

// <div class="box"></div>
$('div').toggleClass('active');

Result

<div class="box active"></div>

2. Force Add (state=true)

$('div').toggleClass('active', true);

Result

// Adds 'active' regardless of current state
<div class="box active"></div>

3. Force Remove (state=false)

$('div').toggleClass('active', false);

Result

// Removes 'active'
<div class="box"></div>

Parameters

Parameter	Type	Description
className	string	One or more class names (separated by spaces) to be toggled for each element in the matched set.
state	boolean	Optional. A boolean (true for adding, false for removing) to force the class state.

Returns: The original SR object for chaining.