@aurodesignsystem-dev/auro-backtotop 0.0.0-pr79.1 → 0.0.0-pr80.0

package/README.md

@@ -15,68 +15,128 @@ The following sections are editable by making changes to the following files:
 | Use Cases              | Examples for when to use this component           | `./docs/partials/useCases.md`       |
 | Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
 | Component Example Code | HTML sample code of the components use            | `./apiExamples/basic.html`          |
--->
-
-# {{ capitalize name }}
+-->
+
+# Backtotop
 
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- The below content is automatically added from ./docs/partials/description.md -->
+`<auro-backtotop>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of providing a quick and accessible means to jump back to the top of a long content page.
 
+The component will be hidden while the page Y scroll position is at the top. When scroll down begins the button will display in the bottom right corner of the page. While scrolling down the button will display only an arrow up icon. When scroll up occurs, the button will additionally display any slotted text content.
+<!-- AURO-GENERATED-CONTENT:END -->
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
+<!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. -->
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## UI development browser support
 
-## Use Cases
-
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/browserSupport.md) -->
+For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
 
+<!-- AURO-GENERATED-CONTENT:END -->
+
 ## Install
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentInstall.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
-
-### Define Dependency in Project
+[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-backtotop/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-backtotop/actions/workflows/testPublish.yml)
+[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-backtotop?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-backtotop)
+[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-backtotop?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
+![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
+
+```shell
+$ npm i @aurodesignsystem/auro-backtotop
+```
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Design Token CSS Custom Property dependency
+
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/designTokens.md) -->
+The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Define dependency in project component
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+Defining the component dependency within each component that is using the `<auro-backtotop>` component.
 
-<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
+
+```js
+import "@aurodesignsystem/auro-backtotop";
+```
 
-### Use CDN
+<!-- AURO-GENERATED-CONTENT:END -->
+**Reference component in HTML**
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
+<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
+
+```html
+<auro-backtotop>Back to top</auro-backtotop>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Use CDN
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
 
-## Basic Example
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-backtotop@latest/+esm"></script>
+```
 
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## auro-backtotop use cases
 
-## Custom Component Registration for Version Management
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
+<!-- The below content is automatically added from ./docs/partials/useCases.md -->
+The `<auro-backtotop>` element should be used in situations where users may:
 
-There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition.
-The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
+* Pages with large amounts of content where a shortcut to jump to the top of the page is appropriate.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## API Code Examples
+
+### Default auro-backtotop
 
-When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
+<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
+
+```html
+<auro-backtotop>Back to top</auro-backtotop>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Development
 
-However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/developmentDescription.md) -->
+In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
 
-You can do this by importing only the component class and using the `register(name)` method with a unique name:
+Please be sure to review the [contribution guidelines](https://auro.alaskaair.com/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.
 
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Start development environment
 
-<div class="exampleWrapper exampleWrapper--flex">
-  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./apiExamples/custom.html) -->
-  <!-- AURO-GENERATED-CONTENT:END -->
-</div>
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/localhost.md) -->
+Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**.
 
-<auro-accordion alignRight>
-  <span slot="trigger">See code</span>
+```shell
+$ npm run dev
+```
 
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/custom.html) -->
-<!-- AURO-GENERATED-CONTENT:END -->
+Open [localhost:8000](http://localhost:8000/)
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Testing
 
-</auro-accordion>
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/testing.md) -->
+Automated tests are required for every Auro component. See `.\test\auro-backtotop.test.js` for the tests for this component. Run `npm run test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
 
+<!-- AURO-GENERATED-CONTENT:END -->

package/custom-elements.json

@@ -2,13 +2,266 @@
   "schemaVersion": "1.0.0",
   "readme": "",
   "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "scripts/wca/auro-backtotop.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "The auro-backtotop element provides users a way to quickly return to page top.",
+          "name": "AuroBackToTopWCA",
+          "superclass": {
+            "name": "AuroBackToTop",
+            "module": "/src/auro-backtotop.js"
+          },
+          "tagName": "auro-backtotop",
+          "customElement": true,
+          "slots": [
+            {
+              "description": "Default slot for the text of the button.",
+              "name": "",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "description": "Use this slot to pass an aria-label to the HTML5 button.",
+              "name": "ariaLabel",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            }
+          ],
+          "cssParts": [
+            {
+              "description": "Apply CSS to HTML5 button.",
+              "name": "button",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "description": "Apply CSS to arrow up icon.",
+              "name": "icon",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Render the trigger inline, will always be visible.",
+              "fieldName": "disabled",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "name": "hidden",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "hidden",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "name": "interactionActive",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "interactionActive",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "name": "lastScrollDirectionUp",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "lastScrollDirectionUp",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "name": "variant",
+              "type": {
+                "text": "string"
+              },
+              "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
+              "default": "\"primary\"",
+              "fieldName": "variant",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "disabled",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Render the trigger inline, will always be visible.",
+              "attribute": "disabled",
+              "reflects": true,
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "hidden",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "hidden",
+              "reflects": true,
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "initializeProperties",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "interactionActive",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "interactionActive",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "lastScrollDirectionUp",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "lastScrollDirectionUp",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "onTriggerClick",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "register",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "name",
+                  "default": "\"auro-backtotop\"",
+                  "description": "The name of element that you want to register to.",
+                  "optional": true,
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "description": "This will register this element with the browser.",
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "scrollTop",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "privacy": "public",
+              "type": {
+                "text": "string"
+              },
+              "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
+              "default": "\"primary\"",
+              "attribute": "variant",
+              "reflects": true,
+              "inheritedFrom": {
+                "name": "AuroBackToTop",
+                "module": "src/auro-backtotop.js"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "auro-backtotop",
+          "declaration": {
+            "name": "AuroBackToTopWCA",
+            "module": "scripts/wca/auro-backtotop.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/auro-backtotop.js",
       "declarations": [
         {
           "kind": "class",
-          "description": "The `auro-backtotop` element provides users a way to quickly return to page top.",
+          "description": "The auro-backtotop element provides users a way to quickly return to page top.",
           "name": "AuroBackToTop",
           "cssParts": [
             {
@@ -31,13 +284,6 @@
             }
           ],
           "members": [
-            {
-              "kind": "method",
-              "name": "_initializeDefaults",
-              "type": {
-                "text": "_initializeDefaults() => void"
-              }
-            },
             {
               "kind": "field",
               "name": "disabled",
@@ -46,7 +292,6 @@
                 "text": "boolean"
               },
               "description": "Render the trigger inline, will always be visible.",
-              "default": "false",
               "attribute": "disabled",
               "reflects": true
             },
@@ -57,7 +302,12 @@
               "type": {
                 "text": "boolean"
               },
-              "attribute": "hidden"
+              "attribute": "hidden",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "initializeProperties"
             },
             {
               "kind": "field",
@@ -95,17 +345,14 @@
                 {
                   "name": "name",
                   "default": "\"auro-backtotop\"",
-                  "description": "The name of the element that you want to register.",
+                  "description": "The name of element that you want to register to.",
                   "optional": true,
                   "type": {
                     "text": "string"
                   }
                 }
               ],
-              "description": "This will register this element with the browser.",
-              "type": {
-                "text": "register(name?: string = \"auro-backtotop\") => void"
-              }
+              "description": "This will register this element with the browser."
             },
             {
               "kind": "method",
@@ -122,10 +369,10 @@
               "name": "variant",
               "privacy": "public",
               "type": {
-                "text": "'primary' | 'secondary'"
+                "text": "string"
               },
               "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
-              "default": "'primary'",
+              "default": "\"primary\"",
               "attribute": "variant",
               "reflects": true
             }
@@ -137,7 +384,6 @@
                 "text": "boolean"
               },
               "description": "Render the trigger inline, will always be visible.",
-              "default": "false",
               "fieldName": "disabled"
             },
             {
@@ -164,10 +410,10 @@
             {
               "name": "variant",
               "type": {
-                "text": "'primary' | 'secondary'"
+                "text": "string"
               },
               "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
-              "default": "'primary'",
+              "default": "\"primary\"",
               "fieldName": "variant"
             }
           ],
@@ -175,9 +421,7 @@
             "name": "LitElement",
             "package": "lit"
           },
-          "tagName": "auro-backtotop",
-          "customElement": true,
-          "modulePath": "src/auro-backtotop.js"
+          "customElement": true
         }
       ],
       "exports": [