@aurodesignsystem-dev/auro-backtotop 0.0.0-pr67.0

package/custom-elements.json

@@ -0,0 +1,532 @@
+{
+  "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": "iconOnly",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "iconOnly",
+              "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": "'primary' | 'secondary' | 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": "field",
+              "name": "iconOnly",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "iconOnly",
+              "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": "'primary' | 'secondary' | 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.",
+          "name": "AuroBackToTop",
+          "cssParts": [
+            {
+              "description": "Apply CSS to HTML5 button.",
+              "name": "button"
+            },
+            {
+              "description": "Apply CSS to arrow up icon.",
+              "name": "icon"
+            }
+          ],
+          "slots": [
+            {
+              "description": "Default slot for the text of the button.",
+              "name": ""
+            },
+            {
+              "description": "Use this slot to pass an aria-label to the HTML5 button.",
+              "name": "ariaLabel"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "disabled",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Render the trigger inline, will always be visible.",
+              "attribute": "disabled",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "hidden",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "hidden",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "iconOnly",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "iconOnly",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "initializeProperties"
+            },
+            {
+              "kind": "field",
+              "name": "interactionActive",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "interactionActive"
+            },
+            {
+              "kind": "field",
+              "name": "lastScrollDirectionUp",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "attribute": "lastScrollDirectionUp"
+            },
+            {
+              "kind": "method",
+              "name": "onTriggerClick",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "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."
+            },
+            {
+              "kind": "method",
+              "name": "scrollTop",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "privacy": "public",
+              "type": {
+                "text": "'primary' | 'secondary' | String"
+              },
+              "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
+              "default": "\"primary\"",
+              "attribute": "variant",
+              "reflects": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Render the trigger inline, will always be visible.",
+              "fieldName": "disabled"
+            },
+            {
+              "name": "hidden",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "hidden"
+            },
+            {
+              "name": "iconOnly",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "iconOnly"
+            },
+            {
+              "name": "interactionActive",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "interactionActive"
+            },
+            {
+              "name": "lastScrollDirectionUp",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "lastScrollDirectionUp"
+            },
+            {
+              "name": "variant",
+              "type": {
+                "text": "'primary' | 'secondary' | String"
+              },
+              "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
+              "default": "\"primary\"",
+              "fieldName": "variant"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "AuroBackToTop",
+          "declaration": {
+            "name": "AuroBackToTop",
+            "module": "src/auro-backtotop.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/buttonVersion.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "12.3.0",
+            "module": "src/buttonVersion.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/iconVersion.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "9.1.0",
+            "module": "src/iconVersion.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "AuroBackToTop",
+          "declaration": {
+            "name": "AuroBackToTop",
+            "module": "src/index.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/registered.js",
+      "declarations": [],
+      "exports": []
+    }
+  ]
+}

package/demo/api.html

@@ -0,0 +1,57 @@
+<!--
+  Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
+  See LICENSE in the project root for license information.
+
+  HTML in this document is standardized and NOT to be edited.
+  All demo code should be added/edited in ./demo/api.md
+
+  With the exception of adding custom elements if needed for the demo.
+
+  ----------------------- DO NOT EDIT -----------------------------
+
+-->
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Auro Web Component Demo | auro-backtotop</title>
+
+    <!-- Prism.js Stylesheet -->
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/prismjs@1.24.1/themes/prism.css"/>
+
+    <!-- Legacy reference is still needed to support auro-backtotop's use of legacy token values at this time -->
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/legacy/auro-classic/CSSCustomProperties.css"/>
+
+    <!-- Design Token Alaska Theme -->
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/themes/alaska/CSSCustomProperties--alaska.min.css"/>
+    
+    <!-- Webcore Stylesheet Alaska Theme -->
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/themes/alaska.global.min.css" />
+    
+    <!-- Demo Specific Styles -->
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
+</head>
+  <body class="auro-markdown">
+    <main></main>
+
+    <script type="module">
+      import 'https://cdn.jsdelivr.net/npm/marked@5.1.1/marked.min.js';
+      import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
+      fetch('./api.md')
+        .then((response) => response.text())
+        .then((text) => {
+          const rawHtml = marked.parse(text);
+          document.querySelector('main').innerHTML = rawHtml;
+          Prism.highlightAll();
+        });
+    </script>
+    <script type="module" src="./api.min.js" data-demo-script="true"></script>
+
+    <!-- If additional elements are needed for the demo, add them here. -->
+    <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm"></script>
+    <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/+esm"></script>
+  </body>
+</html>

package/demo/api.js

@@ -0,0 +1 @@
+import "../src/registered";