Function: toggleClass()

function toggleClass(
   el, 
   className, 
   force?): boolean;

Toggles a class name on an element.

Parameters

Parameter	Type	Description
el	HTMLElement | SVGElement | null | undefined	The target element.
className	string	The class name to toggle.
force?	boolean	If true, always add the class; if false, always remove it.

Returns

boolean

true when the class is present after toggling.

Examples

toggleClass(el, 'active')
// => true

toggleClass(el, 'active', true)
// => true

Since

1.0.0