@aurodesignsystem-dev/auro-slideshow 0.0.0-pr79.0 → 0.0.0-pr80.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.
package/README.md CHANGED
@@ -127,7 +127,6 @@ You can do this by importing only the component class and using the `register(na
127
127
 
128
128
  <pre class="language-js"><code class="language-js">// Import the class only
129
129
  import { AuroSlideshow } from '@aurodesignsystem/auro-slideshow/class';
130
- ​
131
130
  // Register with a custom name if desired
132
131
  AuroSlideshow.register('custom-slideshow');</code></pre>
133
132
 
@@ -639,5 +639,6 @@
639
639
  "declarations": [],
640
640
  "exports": []
641
641
  }
642
- ]
642
+ ],
643
+ "package": "@aurodesignsystem-dev/auro-slideshow@0.0.0-pr80.0"
643
644
  }
package/demo/readme.md CHANGED
@@ -12,9 +12,9 @@ The following sections are editable by making changes to the following files:
12
12
  | SECTION | DESCRIPTION | FILE LOCATION |
13
13
  |------------------------|---------------------------------------------------|-------------------------------------|
14
14
  | Description | Description of the component | `./docs/partials/description.md` |
15
- | Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
16
- | Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
17
- | Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
15
+ | Use cases | Examples for when to use this component | `./docs/partials/useCases.md` |
16
+ | Additional information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
17
+ | Component example code | HTML sample code of the components use | `./apiExamples/basic.html` |
18
18
  -->
19
19
 
20
20
  # Slideshow
@@ -43,7 +43,7 @@ Both `navigation` and `pagination` can be used together, but at least one must b
43
43
  On mobile devices, `autoScroll` and `navigation` controls are automatically disabled. Users can navigate the slideshow by swiping left or right.
44
44
  <!-- AURO-GENERATED-CONTENT:END -->
45
45
 
46
- ## Use Cases
46
+ ## Use cases
47
47
 
48
48
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
49
49
  <!-- The below content is automatically added from ./docs/partials/useCases.md -->
@@ -66,10 +66,10 @@ The `<auro-slideshow>` element should be used in situations where:
66
66
 
67
67
  <!-- AURO-GENERATED-CONTENT:END -->
68
68
 
69
- ### Define Dependency in Project
69
+ ### Define dependency in project
70
70
 
71
71
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
72
- Defining the dependency within each project that is using the `<auro-slideshow>` component.
72
+ Import the component in each project that uses `<auro-slideshow>`.
73
73
 
74
74
  <!-- AURO-GENERATED-CONTENT:END -->
75
75
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
@@ -81,13 +81,13 @@ Defining the dependency within each project that is using the `<auro-slideshow>`
81
81
  ### Use CDN
82
82
 
83
83
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
84
- 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.
84
+ If your project can't process JS assets, use the pre-processed assets. Legacy browsers, such as IE11, aren't supported.
85
85
 
86
86
  <pre class="language-html"><code class="language-html">&lt;script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-slideshow@latest/+esm"&gt;&lt;/script&gt;</code></pre>
87
87
 
88
88
  <!-- AURO-GENERATED-CONTENT:END -->
89
89
 
90
- ## Basic Example
90
+ ## Basic example
91
91
 
92
92
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
93
93
  <!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
@@ -111,23 +111,22 @@ In cases where the project is not able to process JS assets, there are pre-proce
111
111
  &lt;/auro-slideshow&gt;</code></pre>
112
112
  <!-- AURO-GENERATED-CONTENT:END -->
113
113
 
114
- ## Custom Component Registration for Version Management
114
+ ## Custom component registration for version management
115
115
 
116
- 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.
116
+ Every Auro component has two key parts: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition.
117
117
  The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
118
118
 
119
- When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
119
+ Installing the component as described in the Install section imports the class and registers the component globally for you.
120
120
 
121
- 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.
121
+ 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), register the class manually under a custom element name to avoid conflicts.
122
122
 
123
- You can do this by importing only the component class and using the `register(name)` method with a unique name:
123
+ To do this, import only the component class and call the `register(name)` method with a unique name:
124
124
 
125
125
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
126
126
  <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
127
127
 
128
128
  <pre class="language-js"><code class="language-js">// Import the class only
129
129
  import { AuroSlideshow } from '@aurodesignsystem/auro-slideshow/class';
130
- ​
131
130
  // Register with a custom name if desired
132
131
  AuroSlideshow.register('custom-slideshow');</code></pre>
133
132
 
package/package.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "================================================================================"
8
8
  ],
9
9
  "name": "@aurodesignsystem-dev/auro-slideshow",
10
- "version": "0.0.0-pr79.0",
10
+ "version": "0.0.0-pr80.0",
11
11
  "description": "auro-slideshow HTML custom element",
12
12
  "repository": {
13
13
  "type": "git",