classes.js
Utilities for adding, removing and setting classes.

File Location

dom/classes.js

Public Protected Private

Global Functions

goog.dom.classes.add(element, var_args) ⇒
boolean
Adds a class or classes to an element. Does not add multiples of class names.
Arguments:
element :
(Node | null)
DOM node to add class to.
var_args :
(string | undefined)
Class names to add.
Returns: 
boolean
  Whether class was added (or all classes were added).
code »
goog.dom.classes.addRemove(element, classesToRemove, classesToAdd)
Adds zero or more classes to an element and removes zero or more as a single operation. Unlike calling goog.dom.classes.add and goog.dom.classes.remove separately, this is more efficient as it only parses the class property once. If a class is in both the remove and add lists, it will be added. Thus, you can use this instead of goog.dom.classes.swap when you have more than two class names that you want to swap.
Arguments:
element :
(Node | null)
DOM node to swap classes on.
classesToRemove :
(Array | null | string)
Class or classes to remove, if null no classes are removed.
classesToAdd :
(Array | null | string)
Class or classes to add, if null no classes are added.
code »
goog.dom.classes.add_(classes, args) ⇒
boolean
Helper method for goog.dom.classes.add and goog.dom.classes.addRemove. Adds one or more classes to the supplied classes array.
Arguments:
classes :
(Array | null)
All class names for the element, will be updated to have the classes supplied in args added.
args :
(Array | null)
Class names to add.
Returns: 
boolean
  Whether all classes in were added.
code »
goog.dom.classes.add.apply()
No description.
code »
goog.dom.classes.remove.apply()
No description.
code »
goog.dom.classes.enable(element, className, enabled)
Adds or removes a class depending on the enabled argument.
Arguments:
element :
(Node | 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).
code »
goog.dom.classes.get(element) ⇒
(Array | null)
Gets an array of class names on an element
Arguments:
element :
(Node | null)
DOM node to get class of.
Returns: 
(Array | null)
  Class names on element.
code »
goog.dom.classes.has(element, className) ⇒
boolean
Returns true if an element has a class.
Arguments:
element :
(Node | null)
DOM node to test.
className :
string
Class name to test for.
Returns: 
boolean
  Whether element has the class.
code »
goog.dom.classes.remove(element, var_args) ⇒
boolean
Removes a class or classes from an element.
Arguments:
element :
(Node | null)
DOM node to remove class from.
var_args :
(string | undefined)
Class name(s) to remove.
Returns: 
boolean
  Whether all classes in var_args were found and removed.
code »
goog.dom.classes.remove_(classes, args) ⇒
boolean
Helper method for goog.dom.classes.remove and goog.dom.classes.addRemove. Removes one or more classes from the supplied classes array.
Arguments:
classes :
(Array | null)
All class names for the element, will be updated to have the classes supplied in args removed.
args :
(Array | null)
Class names to remove.
Returns: 
boolean
  Whether all classes in were found and removed.
code »
goog.dom.classes.set(element, className)
Sets the entire class name of an element.
Arguments:
element :
(Node | null)
DOM node to set class of.
className :
string
Class name(s) to apply to element.
code »
goog.dom.classes.swap(element, fromClass, toClass) ⇒
boolean
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.
Arguments:
element :
(Node | null)
DOM node to swap classes on.
fromClass :
string
Class to remove.
toClass :
string
Class to add.
Returns: 
boolean
  Whether classes were switched.
code »
goog.dom.classes.toggle(element, className) ⇒
boolean
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.
Arguments:
element :
(Node | 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).
code »

Directory dom

File Reference