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

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/demo/readme.md CHANGED
@@ -12,46 +12,46 @@ 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
21
21
 
22
22
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
23
23
  <!-- The below content is automatically added from ./docs/partials/description.md -->
24
- `<auro-slideshow>` is an [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of displaying a sequence of slides, which can automatically advance through the content or be manually controlled by the user.
24
+ `<auro-slideshow>` is an [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) that displays a sequence of slides. Slides can advance on their own or be controlled by the user.
25
25
 
26
- The `<auro-slideshow>` element is a wrapper element. All slides are slotted content and must be direct children of the element. Slides must have assigned `width` and `height` properties to display properly.
26
+ The `<auro-slideshow>` element is a wrapper. Slides are slotted content and must be direct children of the element. Slides fill the width of the slideshow by default. To show more than one slide at a time, set a `max-width` on each slide.
27
27
 
28
- `<auro-slideshow>` is a fully customizable element and does not come with any features turned on by default. The features of `<auro-slideshow>` are turned on by including the proper attributes on the element.
28
+ No features are on by default. Turn on a feature by adding its attribute to the element.
29
29
 
30
- **Note:** If all the slides can fit on the screen at once, the slideshow will not activate.
30
+ **Note:** If all the slides fit on the screen at once, the slideshow doesn't activate.
31
31
  <!-- AURO-GENERATED-CONTENT:END -->
32
32
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
33
33
  <!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
34
34
 
35
- ### Properties usage
35
+ ### Properties usage
36
36
 
37
- `autoplay` and `autoScroll` are mutually exclusive properties and should not be used together on the same component instance.
37
+ `autoplay` and `autoScroll` can't be used together. If you set both, the slideshow turns off `autoScroll` and logs a warning in the console.
38
38
 
39
- Both `navigation` and `pagination` can be used together, but at least one must be used to give users a clear way to control the slides manually.
39
+ Use `navigation`, `pagination`, or both, so users have a clear way to move through the slides manually.
40
40
 
41
41
  ### Mobile behavior
42
42
 
43
- On mobile devices, `autoScroll` and `navigation` controls are automatically disabled. Users can navigate the slideshow by swiping left or right.
43
+ On touch devices, where the primary pointer is coarse, `autoScroll` and `navigation` are turned off. Users can swipe left or right to move through the slides.
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 -->
50
- The `<auro-slideshow>` element should be used in situations where:
50
+ Use `<auro-slideshow>` when you need to:
51
51
 
52
- * A series of images or content needs to be displayed in a space-saving way
53
- * Autoplaying or autoscrolling functionality is needed
54
- * A current slide indicator is required
52
+ * Show a series of images or content in a space-saving way
53
+ * Advance slides automatically or scroll them continuously
54
+ * Show which slide is current
55
55
  <!-- AURO-GENERATED-CONTENT:END -->
56
56
 
57
57
  ## Install
@@ -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
- <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>
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 -->
@@ -108,19 +108,19 @@ In cases where the project is not able to process JS assets, there are pre-proce
108
108
  &lt;div style="height: 480px"&gt;
109
109
  &lt;img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=5" alt="Random image 5"&gt;
110
110
  &lt;/div&gt;
111
- &lt;/auro-slideshow&gt;</code></pre>
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 -->
@@ -130,19 +130,19 @@ import { AuroSlideshow } from '@aurodesignsystem/auro-slideshow/class';
130
130
  // Register with a custom name if desired
131
131
  AuroSlideshow.register('custom-slideshow');</code></pre>
132
132
 
133
- This will create a new custom element `<custom-slideshow>` that behaves exactly like `<auro-slideshow>`, allowing both to coexist on the same page without interfering with each other.
133
+ This registers a new custom element, `<custom-slideshow>`, that behaves like `<auro-slideshow>`. Both can be on the same page without interfering with each other.
134
134
  <!-- AURO-GENERATED-CONTENT:END -->
135
135
  <div class="exampleWrapper exampleWrapper--flex">
136
136
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./apiExamples/custom.html) -->
137
137
  <!-- The below content is automatically added from ./apiExamples/custom.html -->
138
138
  <custom-slideshow navigation>
139
- <div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
139
+ <div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
140
140
  <p>Slide 1</p>
141
141
  </div>
142
- <div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
142
+ <div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
143
143
  <p>Slide 2</p>
144
144
  </div>
145
- <div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
145
+ <div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;">
146
146
  <p>Slide 3</p>
147
147
  </div>
148
148
  </custom-slideshow>
@@ -154,15 +154,15 @@ This will create a new custom element `<custom-slideshow>` that behaves exactly
154
154
  <!-- The below code snippet is automatically added from ./apiExamples/custom.html -->
155
155
 
156
156
  <pre class="language-html"><code class="language-html">&lt;custom-slideshow navigation&gt;
157
- &lt;div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
157
+ &lt;div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
158
158
  &lt;p&gt;Slide 1&lt;/p&gt;
159
159
  &lt;/div&gt;
160
- &lt;div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
160
+ &lt;div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
161
161
  &lt;p&gt;Slide 2&lt;/p&gt;
162
162
  &lt;/div&gt;
163
- &lt;div style="width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
163
+ &lt;div style="max-width: 400px; border: 2px solid #000; display: flex; justify-content: center;"&gt;
164
164
  &lt;p&gt;Slide 3&lt;/p&gt;
165
165
  &lt;/div&gt;
166
- &lt;/custom-slideshow&gt;</code></pre>
166
+ &lt;/custom-slideshow&gt;</code></pre>
167
167
  <!-- AURO-GENERATED-CONTENT:END -->
168
168
  </auro-accordion>