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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README.md +37 -97
  2. package/custom-elements.json +20 -264
  3. package/demo/api.md +35 -164
  4. package/demo/auro-backtotop.min.js +11 -9
  5. package/demo/index.md +16 -43
  6. package/dist/{auro-backtotop-BcarFpWB.js → auro-backtotop-DbVpaEcC.js} +1 -1
  7. package/dist/index.d.ts +198 -104
  8. package/dist/index.js +1 -1
  9. package/dist/registered.js +1 -1
  10. package/package.json +8 -4
package/README.md CHANGED
@@ -15,128 +15,68 @@ The following sections are editable by making changes to the following files:
15
15
  | Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
16
16
  | Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
17
17
  | Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
18
- -->
19
-
20
- # Backtotop
18
+ -->
19
+
20
+ # {{ capitalize name }}
21
21
 
22
22
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
23
- <!-- The below content is automatically added from ./docs/partials/description.md -->
24
- `<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.
23
+ <!-- AURO-GENERATED-CONTENT:END -->
25
24
 
26
- 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.
27
- <!-- AURO-GENERATED-CONTENT:END -->
28
25
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
29
- <!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
30
- <!-- 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. -->
31
- <!-- AURO-GENERATED-CONTENT:END -->
32
-
33
- ## UI development browser support
26
+ <!-- AURO-GENERATED-CONTENT:END -->
34
27
 
35
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/browserSupport.md) -->
36
- For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
28
+ ## Use Cases
29
+
30
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
31
+ <!-- AURO-GENERATED-CONTENT:END -->
37
32
 
38
- <!-- AURO-GENERATED-CONTENT:END -->
39
-
40
33
  ## Install
41
34
 
42
35
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentInstall.md) -->
43
- [![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)
44
- [![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)
45
- [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-backtotop?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
46
- ![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
47
-
48
- ```shell
49
- $ npm i @aurodesignsystem/auro-backtotop
50
- ```
51
-
52
- <!-- AURO-GENERATED-CONTENT:END -->
53
-
54
- ### Design Token CSS Custom Property dependency
55
-
56
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/designTokens.md) -->
57
- The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
58
-
59
- <!-- AURO-GENERATED-CONTENT:END -->
60
-
61
- ### Define dependency in project component
36
+ <!-- AURO-GENERATED-CONTENT:END -->
37
+
38
+ ### Define Dependency in Project
62
39
 
63
40
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
64
- Defining the component dependency within each component that is using the `<auro-backtotop>` component.
41
+ <!-- AURO-GENERATED-CONTENT:END -->
65
42
 
66
- <!-- AURO-GENERATED-CONTENT:END -->
67
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
68
-
69
- ```js
70
- import "@aurodesignsystem/auro-backtotop";
71
- ```
43
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
44
+ <!-- AURO-GENERATED-CONTENT:END -->
72
45
 
73
- <!-- AURO-GENERATED-CONTENT:END -->
74
- **Reference component in HTML**
75
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
76
- <!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
77
-
78
- ```html
79
- <auro-backtotop>Back to top</auro-backtotop>
80
- ```
81
- <!-- AURO-GENERATED-CONTENT:END -->
82
-
83
- ## Use CDN
46
+ ### Use CDN
84
47
 
85
48
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
86
- 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.
49
+ <!-- AURO-GENERATED-CONTENT:END -->
87
50
 
88
- ```html
89
- <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-backtotop@latest/+esm"></script>
90
- ```
51
+ ## Basic Example
91
52
 
92
- <!-- AURO-GENERATED-CONTENT:END -->
93
-
94
- ## auro-backtotop use cases
53
+ <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
54
+ <!-- AURO-GENERATED-CONTENT:END -->
95
55
 
96
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
97
- <!-- The below content is automatically added from ./docs/partials/useCases.md -->
98
- The `<auro-backtotop>` element should be used in situations where users may:
56
+ ## Custom Component Registration for Version Management
99
57
 
100
- * Pages with large amounts of content where a shortcut to jump to the top of the page is appropriate.
101
- <!-- AURO-GENERATED-CONTENT:END -->
102
-
103
- ## API Code Examples
104
-
105
- ### Default auro-backtotop
58
+ 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.
59
+ The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
106
60
 
107
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
108
- <!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
109
-
110
- ```html
111
- <auro-backtotop>Back to top</auro-backtotop>
112
- ```
113
- <!-- AURO-GENERATED-CONTENT:END -->
114
-
115
- ## Development
61
+ When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
116
62
 
117
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/developmentDescription.md) -->
118
- 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.
63
+ 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.
119
64
 
120
- 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.
65
+ You can do this by importing only the component class and using the `register(name)` method with a unique name:
121
66
 
122
- <!-- AURO-GENERATED-CONTENT:END -->
123
-
124
- ### Start development environment
67
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
68
+ <!-- AURO-GENERATED-CONTENT:END -->
125
69
 
126
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/localhost.md) -->
127
- 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**.
70
+ <div class="exampleWrapper exampleWrapper--flex">
71
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./apiExamples/custom.html) -->
72
+ <!-- AURO-GENERATED-CONTENT:END -->
73
+ </div>
128
74
 
129
- ```shell
130
- $ npm run dev
131
- ```
75
+ <auro-accordion alignRight>
76
+ <span slot="trigger">See code</span>
132
77
 
133
- Open [localhost:8000](http://localhost:8000/)
134
-
135
- <!-- AURO-GENERATED-CONTENT:END -->
136
-
137
- ### Testing
78
+ <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/custom.html) -->
79
+ <!-- AURO-GENERATED-CONTENT:END -->
138
80
 
139
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/testing.md) -->
140
- 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.
81
+ </auro-accordion>
141
82
 
142
- <!-- AURO-GENERATED-CONTENT:END -->
package/custom-elements.json CHANGED
@@ -2,266 +2,13 @@
2
2
  "schemaVersion": "1.0.0",
3
3
  "readme": "",
4
4
  "modules": [
5
- {
6
- "kind": "javascript-module",
7
- "path": "scripts/wca/auro-backtotop.js",
8
- "declarations": [
9
- {
10
- "kind": "class",
11
- "description": "The auro-backtotop element provides users a way to quickly return to page top.",
12
- "name": "AuroBackToTopWCA",
13
- "superclass": {
14
- "name": "AuroBackToTop",
15
- "module": "/src/auro-backtotop.js"
16
- },
17
- "tagName": "auro-backtotop",
18
- "customElement": true,
19
- "slots": [
20
- {
21
- "description": "Default slot for the text of the button.",
22
- "name": "",
23
- "inheritedFrom": {
24
- "name": "AuroBackToTop",
25
- "module": "src/auro-backtotop.js"
26
- }
27
- },
28
- {
29
- "description": "Use this slot to pass an aria-label to the HTML5 button.",
30
- "name": "ariaLabel",
31
- "inheritedFrom": {
32
- "name": "AuroBackToTop",
33
- "module": "src/auro-backtotop.js"
34
- }
35
- }
36
- ],
37
- "cssParts": [
38
- {
39
- "description": "Apply CSS to HTML5 button.",
40
- "name": "button",
41
- "inheritedFrom": {
42
- "name": "AuroBackToTop",
43
- "module": "src/auro-backtotop.js"
44
- }
45
- },
46
- {
47
- "description": "Apply CSS to arrow up icon.",
48
- "name": "icon",
49
- "inheritedFrom": {
50
- "name": "AuroBackToTop",
51
- "module": "src/auro-backtotop.js"
52
- }
53
- }
54
- ],
55
- "attributes": [
56
- {
57
- "name": "disabled",
58
- "type": {
59
- "text": "boolean"
60
- },
61
- "description": "Render the trigger inline, will always be visible.",
62
- "fieldName": "disabled",
63
- "inheritedFrom": {
64
- "name": "AuroBackToTop",
65
- "module": "src/auro-backtotop.js"
66
- }
67
- },
68
- {
69
- "name": "hidden",
70
- "type": {
71
- "text": "boolean"
72
- },
73
- "fieldName": "hidden",
74
- "inheritedFrom": {
75
- "name": "AuroBackToTop",
76
- "module": "src/auro-backtotop.js"
77
- }
78
- },
79
- {
80
- "name": "interactionActive",
81
- "type": {
82
- "text": "boolean"
83
- },
84
- "fieldName": "interactionActive",
85
- "inheritedFrom": {
86
- "name": "AuroBackToTop",
87
- "module": "src/auro-backtotop.js"
88
- }
89
- },
90
- {
91
- "name": "lastScrollDirectionUp",
92
- "type": {
93
- "text": "boolean"
94
- },
95
- "fieldName": "lastScrollDirectionUp",
96
- "inheritedFrom": {
97
- "name": "AuroBackToTop",
98
- "module": "src/auro-backtotop.js"
99
- }
100
- },
101
- {
102
- "name": "variant",
103
- "type": {
104
- "text": "string"
105
- },
106
- "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
107
- "default": "\"primary\"",
108
- "fieldName": "variant",
109
- "inheritedFrom": {
110
- "name": "AuroBackToTop",
111
- "module": "src/auro-backtotop.js"
112
- }
113
- }
114
- ],
115
- "members": [
116
- {
117
- "kind": "field",
118
- "name": "disabled",
119
- "privacy": "public",
120
- "type": {
121
- "text": "boolean"
122
- },
123
- "description": "Render the trigger inline, will always be visible.",
124
- "attribute": "disabled",
125
- "reflects": true,
126
- "inheritedFrom": {
127
- "name": "AuroBackToTop",
128
- "module": "src/auro-backtotop.js"
129
- }
130
- },
131
- {
132
- "kind": "field",
133
- "name": "hidden",
134
- "privacy": "public",
135
- "type": {
136
- "text": "boolean"
137
- },
138
- "attribute": "hidden",
139
- "reflects": true,
140
- "inheritedFrom": {
141
- "name": "AuroBackToTop",
142
- "module": "src/auro-backtotop.js"
143
- }
144
- },
145
- {
146
- "kind": "method",
147
- "name": "initializeProperties",
148
- "inheritedFrom": {
149
- "name": "AuroBackToTop",
150
- "module": "src/auro-backtotop.js"
151
- }
152
- },
153
- {
154
- "kind": "field",
155
- "name": "interactionActive",
156
- "privacy": "public",
157
- "type": {
158
- "text": "boolean"
159
- },
160
- "attribute": "interactionActive",
161
- "inheritedFrom": {
162
- "name": "AuroBackToTop",
163
- "module": "src/auro-backtotop.js"
164
- }
165
- },
166
- {
167
- "kind": "field",
168
- "name": "lastScrollDirectionUp",
169
- "privacy": "public",
170
- "type": {
171
- "text": "boolean"
172
- },
173
- "attribute": "lastScrollDirectionUp",
174
- "inheritedFrom": {
175
- "name": "AuroBackToTop",
176
- "module": "src/auro-backtotop.js"
177
- }
178
- },
179
- {
180
- "kind": "method",
181
- "name": "onTriggerClick",
182
- "privacy": "private",
183
- "return": {
184
- "type": {
185
- "text": "void"
186
- }
187
- },
188
- "inheritedFrom": {
189
- "name": "AuroBackToTop",
190
- "module": "src/auro-backtotop.js"
191
- }
192
- },
193
- {
194
- "kind": "method",
195
- "name": "register",
196
- "static": true,
197
- "parameters": [
198
- {
199
- "name": "name",
200
- "default": "\"auro-backtotop\"",
201
- "description": "The name of element that you want to register to.",
202
- "optional": true,
203
- "type": {
204
- "text": "string"
205
- }
206
- }
207
- ],
208
- "description": "This will register this element with the browser.",
209
- "inheritedFrom": {
210
- "name": "AuroBackToTop",
211
- "module": "src/auro-backtotop.js"
212
- }
213
- },
214
- {
215
- "kind": "method",
216
- "name": "scrollTop",
217
- "privacy": "private",
218
- "return": {
219
- "type": {
220
- "text": "void"
221
- }
222
- },
223
- "inheritedFrom": {
224
- "name": "AuroBackToTop",
225
- "module": "src/auro-backtotop.js"
226
- }
227
- },
228
- {
229
- "kind": "field",
230
- "name": "variant",
231
- "privacy": "public",
232
- "type": {
233
- "text": "string"
234
- },
235
- "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
236
- "default": "\"primary\"",
237
- "attribute": "variant",
238
- "reflects": true,
239
- "inheritedFrom": {
240
- "name": "AuroBackToTop",
241
- "module": "src/auro-backtotop.js"
242
- }
243
- }
244
- ]
245
- }
246
- ],
247
- "exports": [
248
- {
249
- "kind": "custom-element-definition",
250
- "name": "auro-backtotop",
251
- "declaration": {
252
- "name": "AuroBackToTopWCA",
253
- "module": "scripts/wca/auro-backtotop.js"
254
- }
255
- }
256
- ]
257
- },
258
5
  {
259
6
  "kind": "javascript-module",
260
7
  "path": "src/auro-backtotop.js",
261
8
  "declarations": [
262
9
  {
263
10
  "kind": "class",
264
- "description": "The auro-backtotop element provides users a way to quickly return to page top.",
11
+ "description": "The `auro-backtotop` element provides users a way to quickly return to page top.",
265
12
  "name": "AuroBackToTop",
266
13
  "cssParts": [
267
14
  {
@@ -292,6 +39,7 @@
292
39
  "text": "boolean"
293
40
  },
294
41
  "description": "Render the trigger inline, will always be visible.",
42
+ "default": "false",
295
43
  "attribute": "disabled",
296
44
  "reflects": true
297
45
  },
@@ -302,12 +50,14 @@
302
50
  "type": {
303
51
  "text": "boolean"
304
52
  },
305
- "attribute": "hidden",
306
- "reflects": true
53
+ "attribute": "hidden"
307
54
  },
308
55
  {
309
56
  "kind": "method",
310
- "name": "initializeProperties"
57
+ "name": "initializeProperties",
58
+ "type": {
59
+ "text": "initializeProperties() => void"
60
+ }
311
61
  },
312
62
  {
313
63
  "kind": "field",
@@ -345,14 +95,17 @@
345
95
  {
346
96
  "name": "name",
347
97
  "default": "\"auro-backtotop\"",
348
- "description": "The name of element that you want to register to.",
98
+ "description": "The name of the element that you want to register.",
349
99
  "optional": true,
350
100
  "type": {
351
101
  "text": "string"
352
102
  }
353
103
  }
354
104
  ],
355
- "description": "This will register this element with the browser."
105
+ "description": "This will register this element with the browser.",
106
+ "type": {
107
+ "text": "register(name?: string = \"auro-backtotop\") => void"
108
+ }
356
109
  },
357
110
  {
358
111
  "kind": "method",
@@ -369,10 +122,10 @@
369
122
  "name": "variant",
370
123
  "privacy": "public",
371
124
  "type": {
372
- "text": "string"
125
+ "text": "'primary' | 'secondary'"
373
126
  },
374
127
  "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
375
- "default": "\"primary\"",
128
+ "default": "'primary'",
376
129
  "attribute": "variant",
377
130
  "reflects": true
378
131
  }
@@ -384,6 +137,7 @@
384
137
  "text": "boolean"
385
138
  },
386
139
  "description": "Render the trigger inline, will always be visible.",
140
+ "default": "false",
387
141
  "fieldName": "disabled"
388
142
  },
389
143
  {
@@ -410,10 +164,10 @@
410
164
  {
411
165
  "name": "variant",
412
166
  "type": {
413
- "text": "string"
167
+ "text": "'primary' | 'secondary'"
414
168
  },
415
169
  "description": "The variant attribute allows for rendering the button using the primary (default) or secondary styles.",
416
- "default": "\"primary\"",
170
+ "default": "'primary'",
417
171
  "fieldName": "variant"
418
172
  }
419
173
  ],
@@ -421,7 +175,9 @@
421
175
  "name": "LitElement",
422
176
  "package": "lit"
423
177
  },
424
- "customElement": true
178
+ "tagName": "auro-backtotop",
179
+ "customElement": true,
180
+ "modulePath": "src/auro-backtotop.js"
425
181
  }
426
182
  ],
427
183
  "exports": [