goog.dom.classlist

Provided By	`goog.dom.classlist`

No description available.

VIEW SOURCE

Functions

Adds a class to an element. Does not add multiples of class names. This method may throw a DOM exception for an invalid or empty class name if DOMTokenList is used.

Parameters

`element`	`(Element\|null)`
	DOM node to add class to.
`className`	`string`
	Class name to add.

VIEW SOURCE

Convenience method to add a number of class names at once.

Parameters

`element`	`(Element\|null)`
	The element to which to add classes.
`classesToAdd`	`(IArrayLike<string>\|null)`
	An array-like object containing a collection of class names to add to the element. This method may throw a DOM exception if classesToAdd contains invalid or empty class names.

VIEW SOURCE

Adds and removes a class of an element. Unlike goog.dom.classlist.swap, this method adds the classToAdd regardless of whether the classToRemove was present and had been removed. This method may throw a DOM exception if the class names are empty or invalid.

Parameters

`element`	`(Element\|null)`
	DOM node to swap classes on.
`classToRemove`	`string`
	Class to remove.
`classToAdd`	`string`
	Class to add.

VIEW SOURCE

Returns true if an element has a class. This method may throw a DOM exception for an invalid or empty class name if DOMTokenList is used.

Parameters

`element`	`(Element\|null)`
	DOM node to test.
`className`	`string`
	Class name to test for.

Returns

boolean

Whether element has the class.

VIEW SOURCE

Adds or removes a class depending on the enabled argument. This method may throw a DOM exception for an invalid or empty class name if DOMTokenList is used.

Parameters

`element`	`(Element\|null)`
	DOM node to add or remove the class on.
`className`	`string`
	Class name to add or remove.
`enabled`	`boolean`
	Whether to add or remove the class (true adds, false removes).

VIEW SOURCE

Adds or removes a set of classes depending on the enabled argument. This method may throw a DOM exception for an invalid or empty class name if DOMTokenList is used.

Parameters

`element`	`Element`
	DOM node to add or remove the class on.
`classesToEnable`	`(IArrayLike<string>\|null)`
	An array-like object containing a collection of class names to add or remove from the element.
`enabled`	`boolean`
	Whether to add or remove the classes (true adds, false removes).

VIEW SOURCE

Gets an array-like object of class names on an element.

Parameters

`element`	`(Element\|null)`
	DOM node to get the classes of.

Returns

IArrayLike<?>

Class names on element.

VIEW SOURCE

Removes a class from an element. This method may throw a DOM exception for an invalid or empty class name if DOMTokenList is used.

Parameters

`element`	`(Element\|null)`
	DOM node to remove class from.
`className`	`string`
	Class name to remove.

VIEW SOURCE

Removes a set of classes from an element. Prefer this call to repeatedly calling goog.dom.classlist.remove if you want to remove a large set of class names at once.

Parameters

`element`	`(Element\|null)`
	The element from which to remove classes.
`classesToRemove`	`(IArrayLike<string>\|null)`
	An array-like object containing a collection of class names to remove from the element. This method may throw a DOM exception if classesToRemove contains invalid or empty class names.

VIEW SOURCE

Sets the entire class name of an element.

Parameters

`element`	`(Element\|null)`
	DOM node to set class of.
`className`	`string`
	Class name(s) to apply to element.

VIEW SOURCE

Switches a class on an element from one to another without disturbing other classes. If the fromClass isn't removed, the toClass won't be added. This method may throw a DOM exception if the class names are empty or invalid.

Parameters

`element`	`(Element\|null)`
	DOM node to swap classes on.
`fromClass`	`string`
	Class to remove.
`toClass`	`string`
	Class to add.

Returns

boolean

Whether classes were switched.

VIEW SOURCE

Removes a class if an element has it, and adds it the element doesn't have it. Won't affect other classes on the node. This method may throw a DOM exception if the class name is empty or invalid.

Parameters

`element`	`(Element\|null)`
	DOM node to toggle class on.
`className`	`string`
	Class to toggle.

Returns

boolean

True if class was added, false if it was removed (in other words, whether element has the class after this function has been called).

VIEW SOURCE

Compiler Constants

Override this define at build-time if you know your target supports it.

VIEW SOURCE

goog.dom.classlist

Functions

add( `element`, `className` ) `→` `void`

addAll( `element`, `classesToAdd` ) `→` `void`

addRemove( `element`, `classToRemove`, `classToAdd` ) `→` `void`

contains( `element`, `className` ) `→` `boolean`

enable( `element`, `className`, `enabled` ) `→` `void`

enableAll( `element`, `classesToEnable`, `enabled` ) `→` `void`

get( `element` ) `→` `IArrayLike<?>`

remove( `element`, `className` ) `→` `void`

removeAll( `element`, `classesToRemove` ) `→` `void`

set( `element`, `className` ) `→` `void`

swap( `element`, `fromClass`, `toClass` ) `→` `boolean`

toggle( `element`, `className` ) `→` `boolean`

Compiler Constants