docs(jsdocs): update documentation on api page

AlaskaAirlines · Apr 2, 2024 · bf1b1bb · bf1b1bb
1 parent 28852ba
commit bf1b1bb
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 2 deletions.
diff --git a/demo/api.md b/demo/api.md
@@ -1,6 +1,23 @@
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../api.md) -->
 <!-- The below content is automatically added from ./../api.md -->
 
+# auro-checkbox-group
+
+## Properties
+
+| Property                        | Attribute                       | Type      | Default     |
+|---------------------------------|---------------------------------|-----------|-------------|
+| [disabled](#disabled)                      | `disabled`                      | `boolean` | false       |
+| [error](#error)                         | `error`                         | `string`  |             |
+| [horizontal](#horizontal)                    | `horizontal`                    | `boolean` | false       |
+| [noValidate](#noValidate)                    | `noValidate`                    | `boolean` |             |
+| [required](#required)                      | `required`                      | `boolean` | false       |
+| [setCustomValidity](#setCustomValidity)             | `setCustomValidity`             | `string`  |             |
+| [setCustomValidityCustomError](#setCustomValidityCustomError)  | `setCustomValidityCustomError`  | `string`  |             |
+| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string`  |             |
+| [validity](#validity)                      | `validity`                      | `string`  | "undefined" |
+| [value](#value)                         | `value`                         | `array`   | "undefined" |
+
 # auro-checkbox
 
 Custom element for the purpose of allowing users to select one or more options of a limited number of choices.

diff --git a/docs/api.md b/docs/api.md
@@ -1,3 +1,21 @@
+# auro-checkbox-group
+
+## Properties
+
+| Property                        | Attribute                       | Type      | Default     |
+|---------------------------------|---------------------------------|-----------|-------------|
+| `disabled`                      | `disabled`                      | `boolean` | false       |
+| `error`                         | `error`                         | `string`  |             |
+| `horizontal`                    | `horizontal`                    | `boolean` | false       |
+| `noValidate`                    | `noValidate`                    | `boolean` |             |
+| `required`                      | `required`                      | `boolean` | false       |
+| `setCustomValidity`             | `setCustomValidity`             | `string`  |             |
+| `setCustomValidityCustomError`  | `setCustomValidityCustomError`  | `string`  |             |
+| `setCustomValidityValueMissing` | `setCustomValidityValueMissing` | `string`  |             |
+| `validity`                      | `validity`                      | `string`  | "undefined" |
+| `value`                         | `value`                         | `array`   | "undefined" |
+
+
 # auro-checkbox
 
 Custom element for the purpose of allowing users to select one or more options of a limited number of choices.

diff --git a/scripts/generateDocs.mjs b/scripts/generateDocs.mjs
@@ -151,7 +151,7 @@ function processDemo() {
  * Compiles `./docTemplates/api.md` -> `./demo/api.md`
  */
 
-function processApiExamples() {
+function processApi() {
   const callback = function(updatedContent, outputConfig) {
     if (fs.existsSync('./demo/api.md')) {
       fs.readFile('./demo/api.md', 'utf8', function(err, data) {
@@ -206,5 +206,5 @@ function copyReadmeLocally() {
  * Run all the actual document generation
  */
 copyReadmeLocally();
-processApiExamples();
+processApi();
 processDemo();
diff --git a/src/auro-checkbox-group.js b/src/auro-checkbox-group.js
@@ -18,6 +18,9 @@
  * @attr {Boolean} horizontal - If set, checkboxes will be aligned horizontally.
  * @event auroCheckboxGroup-validated - Notifies that the `validity` value has changed.
  * @event auroCheckboxGroup-helpText - Notifies that the `setCustomValidity` value has changed.
+ * @slot {HTMLSlotElement} legend - Allows for the legend to be overridden.
+ * @slot {HTMLSlotElement} optionalLabel - Allows for the optional label to be overridden.
+ * @slot {HTMLSlotElement} helpText - Allows for the helper text to be overridden.
  */
 
 import { LitElement, html } from "lit";
@@ -104,6 +107,13 @@ export class AuroCheckboxGroup extends LitElement {
     this.handleItems();
   }
 
+  /**
+   * Helper method to handle checkbox value changing.
+   * @private
+   * @param {String} value - The value of the checkbox.
+   * @param {Boolean} selected - The checked state of the checkbox.
+   * @returns {void}
+   */
   handleValueUpdate(value, selected) {
     if (selected) {
       // add if it isn't already in the value list
@@ -168,6 +178,11 @@ export class AuroCheckboxGroup extends LitElement {
     });
   }
 
+  /**
+   * Helper method that handles the state of preselected checkboxes.
+   * @private
+   * @returns {void}
+   */
   handlePreselectedItems() {
     let preSelectedValues = false;
 
@@ -188,6 +203,11 @@ export class AuroCheckboxGroup extends LitElement {
     }
   }
 
+  /**
+   * Helper method that handles the state of checkboxes.
+   * @private
+   * @returns {void}
+   */
   handleItems() {
     const groupTagName = this.tagName.toLowerCase();
     const checkboxTagName = groupTagName.substring(0, groupTagName.indexOf('-group'));
@@ -200,6 +220,11 @@ export class AuroCheckboxGroup extends LitElement {
     this.validation.validate(this);
   }
 
+  /**
+   * Helper method that handles attributes of checkboxes.
+   * @private
+   * @returns {void}
+   */
   handleCheckboxAttributes() {
     this.items.forEach((el) => {
       if (this.error) {