docs(jsdoc): basic class and event defs

Author: Ryan A. Johnson

src/helix-ui/elements/HXAccordionElement.js

@@ -9,7 +9,7 @@ import { HXElement } from './HXElement';
  */
 
 /**
- * Defines behavior for an `<hx-accordion>` element.
+ * Defines behavior for the `<hx-accordion>` element.
  *
  * @emits Accordion:panelchange
  * @extends HXElement
@@ -140,4 +140,4 @@ export class HXAccordionElement extends HXElement {
             });
         }
     }
-}//HXAccordionElement
+}

src/helix-ui/elements/HXAccordionPanelElement.js

@@ -3,23 +3,23 @@ import shadowMarkup from './HXAccordionPanelElement.html';
 import shadowStyles from './HXAccordionPanelElement.less';
 
 /**
- * Fires when contents of the accordion panel are revealed.
+ * Fires when the element's contents are concealed.
  *
- * @event AccordionPanel:open
- * @since 0.4.0
+ * @event AccordionPanel:close
+ * @since 0.6.0
  * @type {CustomEvent}
  */
 
 /**
- * Fires when contents of the accordion panel are disclosed.
+ * Fires when the element's contents are revealed.
  *
- * @event AccordionPanel:close
- * @since 0.6.0
+ * @event AccordionPanel:open
+ * @since 0.4.0
  * @type {CustomEvent}
  */
 
 /**
- * Defines behavior for an `<hx-accordion-panel>` element.
+ * Defines behavior for the `<hx-accordion-panel>` element.
  *
  * @emits AccordionPanel:close
  * @emits AccordionPanel:open

src/helix-ui/elements/HXAlertElement.js

@@ -10,23 +10,23 @@ const ICONS = {
 };
 
 /**
- * Fires when the user triggers the dismiss button.
+ * Fires when the dismiss button ("X") is pressed.
  *
  * @event Alert:dismiss
  * @since 0.6.0
  * @type {CustomEvent}
  */
 
 /**
- * Fires when the user triggers the CTA button.
+ * Fires when the CTA button is pressed.
  *
  * @event Alert:submit
  * @since 0.6.0
  * @type {CustomEvent}
  */
 
 /**
- * Defines behavior for an `<hx-alert>` element.
+ * Defines behavior for the `<hx-alert>` element.
  *
  * @emits Alert:dismiss
  * @emits Alert:submit

src/helix-ui/elements/HXBusyElement.js

@@ -1,10 +1,11 @@
 import { HXElement } from './HXElement';
 
 /**
- * Defines behavior for an `<hx-busy>` element.
+ * Defines behavior for the `<hx-busy>` element.
  *
  * @extends HXElement
  * @hideconstructor
+ * @since 0.4.0
  */
 export class HXBusyElement extends HXElement {
     static get is () {
@@ -36,4 +37,4 @@ export class HXBusyElement extends HXElement {
             this.removeAttribute('paused');
         }
     }
-}//HXBusyElement
+}

src/helix-ui/elements/HXCheckboxElement.js

@@ -4,17 +4,16 @@ import shadowMarkup from './HXCheckboxElement.html';
 import shadowStyles from './HXCheckboxElement.less';
 
 /**
- * Fires when the checked state changes
+ * Fires when the element's `checked` state changes
  *
  * @event Checkbox:change
  * @since 0.1.8
  * @type {CustomEvent}
  */
 
 /**
- * Defines behavior for an `<hx-checkbox>` element.
+ * Defines behavior for the `<hx-checkbox>` element.
  *
- * @class
  * @emits Checkbox:change
  * @extends HXElement
  * @hideconstructor
@@ -118,4 +117,4 @@ export class HXCheckboxElement extends HXElement {
     get _input () {
         return this.shadowRoot.getElementById('nativeControl');
     }
-}//HXCheckboxElement
+}

src/helix-ui/elements/HXDisclosureElement.js

@@ -2,10 +2,11 @@ import { HXElement } from './HXElement';
 import { KEYS } from '../util';
 
 /**
- * Defines behavior for an `<hx-disclosure>` element.
+ * Defines behavior for the `<hx-disclosure>` element.
  *
  * @extends HXElement
  * @hideconstructor
+ * @since 0.2.0
  */
 export class HXDisclosureElement extends HXElement {
     static get is () {
@@ -124,4 +125,4 @@ export class HXDisclosureElement extends HXElement {
     _onTargetClose () {
         this.expanded = false;
     }
-}//HXDisclosureElement
+}

src/helix-ui/elements/HXElement.js

@@ -17,6 +17,7 @@ import { KEYS } from '../util';
  * @extends external:HTMLElement
  * @hideconstructor
  * @requires util
+ * @since 0.2.0
  */
 export class HXElement extends HTMLElement {
     /**
@@ -319,4 +320,4 @@ export class HXElement extends HTMLElement {
             this.removeAttribute('disabled');
         }
     }
-}//HXElement
+}

src/helix-ui/elements/HXErrorElement.js

@@ -2,6 +2,13 @@ import { HXElement } from './HXElement';
 import shadowStyles from './HXErrorElement.less';
 import shadowMarkup from './HXErrorElement.html';
 
+/**
+ * Defines behavior for the `<hx-error>` element.
+ *
+ * @extends HXElement
+ * @hideconstructor
+ * @since 0.4.0
+ */
 export class HXErrorElement extends HXElement {
     static get is () {
         return 'hx-error';
@@ -10,4 +17,4 @@ export class HXErrorElement extends HXElement {
     static get template () {
         return `<style>${shadowStyles}</style>${shadowMarkup}`;
     }
-}//HXErrorElement
+}

src/helix-ui/elements/HXIconElement.js

@@ -1,6 +1,12 @@
 import { HXElement } from './HXElement';
 import Icons from '../icons';
 
+/**
+ * Defines behavior for the `<hx-icon>` element.
+ *
+ * @extends HXElement
+ * @since 0.1.0
+ */
 export class HXIconElement extends HXElement {
     static get is () {
         return 'hx-icon';
@@ -57,4 +63,4 @@ export class HXIconElement extends HXElement {
             this.appendChild(svg);
         }
     }//_render()
-}//HXIconElement
+}

src/helix-ui/elements/HXMenuElement.js

@@ -1,6 +1,31 @@
 import { HXElement } from './HXElement';
 import { getPosition } from '../util';
 
+/**
+ * Fires when the element is concealed.
+ *
+ * @event Menu:close
+ * @since 0.6.0
+ * @type {CustomEvent}
+ */
+
+/**
+ * Fires when the element is revealed.
+ *
+ * @event Menu:open
+ * @since 0.6.0
+ * @type {CustomEvent}
+ */
+
+/**
+ * Defines behavior for the `<hx-menu>` element.
+ *
+ * @emits Menu:close
+ * @emits Menu:open
+ * @extends HXElement
+ * @hideconstructor
+ * @since 0.2.0
+ */
 export class HXMenuElement extends HXElement {
     static get is () {
         return 'hx-menu';
@@ -110,4 +135,4 @@ export class HXMenuElement extends HXElement {
             this.open = false;
         }
     }
-}//HXMenuElement
+}