@aurodesignsystem-dev/auro-slideshow 0.0.0-pr48.1 → 0.0.0-pr54.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 (13) hide show
  1. package/README.md +16 -50
  2. package/demo/api.js +1 -1
  3. package/demo/auro-slideshow.min.js +84 -1397
  4. package/demo/index.html +1 -1
  5. package/demo/{demo-index.js → index.js} +1 -1
  6. package/demo/index.md +6 -5
  7. package/dist/auro-slideshow-B6wRoVRO.js +123 -0
  8. package/dist/index.d.ts +128 -157
  9. package/dist/index.js +1 -1
  10. package/dist/registered.js +1 -1
  11. package/package.json +19 -77
  12. package/dist/auro-slideshow-D1Ts-rd_.js +0 -109
  13. /package/demo/{demo-index.min.js → index.min.js} +0 -0
package/README.md CHANGED
@@ -4,8 +4,8 @@ The README.md file is a compiled document. No edits should be made directly to t
4
4
  README.md is created by running `npm run build:docs`.
5
5
 
6
6
  This file is generated based on a template fetched from
7
- `https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
8
- and copied to `./componentDocs/README.md` each time the the docs are compiled.
7
+ `https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/README.md`
8
+ and copied to `./componentDocs/README.md` each time the docs are compiled.
9
9
 
10
10
  The following sections are editable by making changes to the following files:
11
11
 
@@ -45,14 +45,14 @@ On mobile devices, `autoScroll` and `navigation` controls are automatically disa
45
45
 
46
46
  ## UI development browser support
47
47
 
48
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
48
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/browserSupport.md) -->
49
49
  For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
50
50
 
51
51
  <!-- AURO-GENERATED-CONTENT:END -->
52
52
 
53
53
  ## Install
54
54
 
55
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
55
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentInstall.md) -->
56
56
  [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-slideshow/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-slideshow/actions/workflows/testPublish.yml)
57
57
  [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-slideshow?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-slideshow)
58
58
  [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-slideshow?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -62,24 +62,22 @@ For the most up to date information on [UI development browser support](https://
62
62
  $ npm i @aurodesignsystem/auro-slideshow
63
63
  ```
64
64
 
65
- Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
66
-
67
65
  <!-- AURO-GENERATED-CONTENT:END -->
68
66
 
69
67
  ### Design Token CSS Custom Property dependency
70
68
 
71
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
69
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/designTokens.md) -->
72
70
  The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
73
71
 
74
72
  <!-- AURO-GENERATED-CONTENT:END -->
75
73
 
76
74
  ### Define dependency in project component
77
75
 
78
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
76
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
79
77
  Defining the component dependency within each component that is using the `<auro-slideshow>` component.
80
78
 
81
79
  <!-- AURO-GENERATED-CONTENT:END -->
82
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
80
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
83
81
 
84
82
  ```js
85
83
  import "@aurodesignsystem/auro-slideshow";
@@ -111,23 +109,13 @@ import "@aurodesignsystem/auro-slideshow";
111
109
  ```
112
110
  <!-- AURO-GENERATED-CONTENT:END -->
113
111
 
114
- ## Install bundled assets from CDN
115
-
116
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
117
- In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-slideshow__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
118
-
119
- **WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.
112
+ ## Use CDN
120
113
 
121
- <!-- AURO-GENERATED-CONTENT:END -->
122
-
123
- ### Bundle example code
114
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
115
+ 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.
124
116
 
125
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->
126
-
127
117
  ```html
128
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@/dist/auro-classic/CSSCustomProperties.css" />
129
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@/dist/bundled/essentials.css" />
130
- <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-slideshow@0.0.0/dist/auro-slideshow__bundled.js" type="module"></script>
118
+ <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-slideshow@latest/+esm"></script>
131
119
  ```
132
120
 
133
121
  <!-- AURO-GENERATED-CONTENT:END -->
@@ -173,7 +161,7 @@ The `<auro-slideshow>` element should be used in situations where:
173
161
 
174
162
  ## Development
175
163
 
176
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) -->
164
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/developmentDescription.md) -->
177
165
  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.
178
166
 
179
167
  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.
@@ -182,42 +170,20 @@ Please be sure to review the [contribution guidelines](https://auro.alaskaair.co
182
170
 
183
171
  ### Start development environment
184
172
 
185
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) -->
173
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/localhost.md) -->
186
174
  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**.
187
175
 
188
176
  ```shell
189
177
  $ npm run dev
190
178
  ```
191
179
 
192
- Open [localhost:8000](http://localhost:8000/)
193
-
194
- If running separate sessions is preferred, please run the following commands in individual terminal shells.
195
-
196
- ```shell
197
- $ npm run build:watch
198
-
199
- $ npm run serve
200
- ```
201
-
202
- <!-- AURO-GENERATED-CONTENT:END -->
180
+ Open [localhost:8000](http://localhost:8000/)
203
181
 
204
- ### API generation
205
-
206
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) -->
207
- The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
208
-
209
182
  <!-- AURO-GENERATED-CONTENT:END -->
210
183
 
211
184
  ### Testing
212
185
 
213
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
214
- Automated tests are required for every Auro component. See `.\test\auro-slideshow.test.js` for the tests for this component. Run `npm 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.
215
-
216
- <!-- AURO-GENERATED-CONTENT:END -->
217
-
218
- ### Bundled assets
219
-
220
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) -->
221
- Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.
186
+ <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/testing.md) -->
187
+ Automated tests are required for every Auro component. See `.\test\auro-slideshow.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.
222
188
 
223
189
  <!-- AURO-GENERATED-CONTENT:END -->
package/demo/api.js CHANGED
@@ -1 +1 @@
1
- import "../src/registered.js";
1
+ import "../src/registered";