attributes.js

  1. /**
  2.  * Id, class and attribute related functions
  3.  *
  4.  * @namespace Attributes
  5.  */
  7. /**
  8.  * Add one or more classes to an element
  9.  * @memberof Attributes
  10.  * @param { Element } el
  11.  * @param { ...String } className
  12.  */
  13. function addClass(el, ...className) {
  14.     el.classList.add(...className);
  15. }
  17. /**
  18.  * Check if an element has a given class
  19.  * @memberof Attributes
  20.  * @param { Element } el
  21.  * @param { String } className
  22.  * @return { Bool }
  23.  */
  24. function hasClass(el, className) {
  25.     return el.classList.contains(className);
  26. }
  28. /**
  29.  * Remove a class from an element
  30.  * @memberof Attributes
  31.  * @param { Element } el
  32.  * @param { String } className
  33.  */
  34. function removeClass(el, className) {
  35.     el.classList.remove(className);
  36. }
  38. /**
  39.  * Toggle a class on an element
  40.  * @memberof Attributes
  41.  * @param { Element } el
  42.  * @param { String } className
  43.  */
  44. function toggleClass(el, className) {
  45.     if (hasClass(el, className)) removeClass(el, className);
  46.     else addClass(el, className);
  47. }
  49. /**
  50.  * Check if an element has a given attribute
  51.  * @memberof Attributes
  52.  * @param { Element } el
  53.  * @param { String } attr
  54.  * @return { Bool }
  55.  */
  56. function hasAttribute(el, attr) {
  57.     return el.hasAttribute(attr);
  58. }
  60. /**
  61.  * Get an attribute's value from an element
  62.  * @memberof Attributes
  63.  * @param { Element } el
  64.  * @param { String } attr The attribute's name
  65.  * @return { String }
  66.  */
  67. function getAttribute(el, attr) {
  68.     return el.getAttribute(attr);
  69. }
  71. /**
  72.  * Add or set an attribute on an element
  73.  * @memberof Attributes
  74.  * @param { Element } el
  75.  * @param { String } attr The attribute's name
  76.  * @param { String } val The attribute's value
  77.  */
  78. function setAttribute(el, attr, val) {
  79.     el.setAttribute(attr, val);
  80. }
  82. /**
  83.  * Remove an attribute from an element
  84.  * @memberof Attributes
  85.  * @param { Element } el
  86.  * @param { String } attr The attribute's name
  87.  */
  88. function removeAttribute(el, attr) {
  89.     el.removeAttribute(attr);
  90. }
  92. export {
  93.     addClass,
  94.     hasClass,
  95.     removeClass,
  96.     toggleClass,
  97.     hasAttribute,
  98.     getAttribute,
  99.     setAttribute,
  100.     removeAttribute
  101. };