@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/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>
@@ -8,41 +8,45 @@
8
8
  "declarations": [
9
9
  {
10
10
  "kind": "class",
11
- "description": "The `auro-slideshow` element is a customizable slideshow that displays a series of slides\nwith several options such as autoplay, navigation controls, and pagination dots.",
11
+ "description": "A slideshow for presenting a series of images or other content in a space-saving way, with manual controls or automatic advancing.\n\n**Key capabilities**\n- **Autoplay**: Set `autoplay` to move to the next slide after each `delay`.\n- **Continuous scroll**: Set `autoScroll` to scroll the slides at a steady pace.\n- **Navigation arrows**: Set `navigation` to show previous and next arrows when the slides are hovered.\n- **Pagination dots**: Set `pagination` to show a dot for each slide.\n- **Looping**: Set `loop` to return to the first slide after the last.\n- **Full-bleed preview**: Set `fullBleed` to show parts of the previous and next slides.\n\n**Example**\n```html\n<auro-slideshow navigation pagination>\n <div style=\"height: 480px\">Slide 1</div>\n <div style=\"height: 480px\">Slide 2</div>\n</auro-slideshow>\n```",
12
12
  "name": "AuroSlideshow",
13
13
  "cssParts": [
14
14
  {
15
- "description": "Use to style the next button control.",
16
- "name": "next-button"
15
+ "description": "The button that goes to the next slide, shown when `navigation` is set, except on touch devices.",
16
+ "name": "next-button",
17
+ "relevantWhen": "navigation"
17
18
  },
18
19
  {
19
- "description": "Use to style the play/pause button control.",
20
+ "description": "The button that plays and pauses the slideshow, shown when `autoplay` is set, or when `autoScroll` is set on a device that isn't a touch device.",
20
21
  "name": "play-pause-button"
21
22
  },
22
23
  {
23
- "description": "Use to style the previous button control.",
24
- "name": "prev-button"
24
+ "description": "The button that goes to the previous slide, shown when `navigation` is set, except on touch devices.",
25
+ "name": "prev-button",
26
+ "relevantWhen": "navigation"
25
27
  }
26
28
  ],
27
29
  "slots": [
28
30
  {
29
- "description": "Default slot for the slides. Each child element will be treated as a slide.",
31
+ "description": "The slides. Each direct child element becomes one slide.",
30
32
  "name": ""
31
33
  },
32
34
  {
33
- "description": "The aria-label for the button navigating to the previous slide. Default is \"Previous slide\".",
34
- "name": "ariaLabel.scroll.left"
35
+ "description": "Text screen readers announce for the previous slide button. Defaults to \"Previous slide\".",
36
+ "name": "ariaLabel.scroll.left",
37
+ "relevantWhen": "navigation"
35
38
  },
36
39
  {
37
- "description": "The aria-label for the button navigating to the next slide. Default is \"Next slide\".",
38
- "name": "ariaLabel.scroll.right"
40
+ "description": "Text screen readers announce for the next slide button. Defaults to \"Next slide\".",
41
+ "name": "ariaLabel.scroll.right",
42
+ "relevantWhen": "navigation"
39
43
  },
40
44
  {
41
- "description": "The aria-label for the button that pauses the slideshow. Default is \"Pause slideshow\".",
45
+ "description": "Text screen readers announce for the button that pauses the slideshow. Defaults to \"Pause slideshow\".",
42
46
  "name": "ariaLabel.slideshow.pause"
43
47
  },
44
48
  {
45
- "description": "The aria-label for the button that starts the slideshow. Default is \"Play slideshow\".",
49
+ "description": "Text screen readers announce for the button that starts the slideshow. Defaults to \"Play slideshow\".",
46
50
  "name": "ariaLabel.slideshow.play"
47
51
  }
48
52
  ],
@@ -50,7 +54,8 @@
50
54
  {
51
55
  "kind": "field",
52
56
  "name": "_createWidthProp",
53
- "description": "Calculate the width of the slideshow-wrapper and attach a css property to the host element '--slideshow-width'",
57
+ "description": "Sets the `--slideshow-width` CSS custom property on the host element to the width of the slideshow wrapper.",
58
+ "privacy": "private",
54
59
  "return": {
55
60
  "type": {
56
61
  "text": "void"
@@ -60,10 +65,11 @@
60
65
  {
61
66
  "kind": "field",
62
67
  "name": "_customAlign",
63
- "description": "Calculate the difference between the left edge of the slideshow-wrapper and the embla container",
68
+ "description": "Calculates the difference between the left edge of the slideshow wrapper and the Embla container.",
69
+ "privacy": "private",
64
70
  "return": {
65
71
  "type": {
66
- "text": ""
72
+ "text": "() => number"
67
73
  }
68
74
  },
69
75
  "readonly": true
@@ -132,7 +138,7 @@
132
138
  "type": {
133
139
  "text": "boolean"
134
140
  },
135
- "description": "If true, the slideshow will play automatically.",
141
+ "description": "Adds a play and pause button and moves to the next slide after each `delay`. The slideshow starts playing on page load only when `playOnInit` is also set.",
136
142
  "attribute": "autoplay",
137
143
  "reflects": true
138
144
  },
@@ -143,7 +149,7 @@
143
149
  "type": {
144
150
  "text": "boolean"
145
151
  },
146
- "description": "If true, the slideshow will scroll continuously.",
152
+ "description": "Scrolls the slides at a steady pace instead of stopping on each slide, and adds a play and pause button. The slideshow starts scrolling on page load only when `playOnInit` is also set. Doesn't apply on touch devices (those with a coarse primary pointer), and `autoplay` takes priority when both are set.",
147
153
  "attribute": "autoscroll",
148
154
  "reflects": true
149
155
  },
@@ -154,10 +160,11 @@
154
160
  "type": {
155
161
  "text": "number"
156
162
  },
157
- "description": "Slide duration in milliseconds (Only used with `autoplay`).",
163
+ "description": "Sets how long each slide shows before the slideshow moves to the next one, in milliseconds. Applies only when `autoplay` is set.",
158
164
  "default": "7000",
159
165
  "attribute": "delay",
160
- "reflects": true
166
+ "reflects": true,
167
+ "relevantWhen": "autoplay"
161
168
  },
162
169
  {
163
170
  "kind": "field",
@@ -166,7 +173,7 @@
166
173
  "type": {
167
174
  "text": "boolean"
168
175
  },
169
- "description": "If set, the slideshow will take up the width of its parent container showing previous and next slides. **Note:** a parent container must have `overflow-x: hidden` to prevent horizontal scrolling.",
176
+ "description": "Stretches the slideshow to the full width of the browser window, so parts of the previous and next slides show beside the current slide. Each slide stays as wide as the slideshow's container. To prevent horizontal scrolling, set `overflow-x: hidden` on a parent container.",
170
177
  "attribute": "fullbleed",
171
178
  "reflects": true
172
179
  },
@@ -275,7 +282,7 @@
275
282
  "type": {
276
283
  "text": "boolean"
277
284
  },
278
- "description": "If true, the slideshow will loop back to the first slide after reaching the last slide.",
285
+ "description": "Goes back to the first slide after the last slide instead of stopping at the end. When `loop` isn't set, `autoplay` and `autoScroll` stop on the last slide.",
279
286
  "attribute": "loop",
280
287
  "reflects": true
281
288
  },
@@ -286,7 +293,7 @@
286
293
  "type": {
287
294
  "text": "boolean"
288
295
  },
289
- "description": "If true, the slideshow will display navigation arrows for previous and next slides when the slide container is hovered.",
296
+ "description": "Shows previous and next arrow buttons when the slides are hovered. When `loop` isn't set, the arrow for a direction is hidden at the first or last slide. The arrows don't appear on touch devices, where the primary pointer is coarse.",
290
297
  "attribute": "navigation",
291
298
  "reflects": true
292
299
  },
@@ -297,14 +304,14 @@
297
304
  "type": {
298
305
  "text": "boolean"
299
306
  },
300
- "description": "If true, the slideshow will display pagination dots for each slide. If autoplay is on, the active dot will also show a progress bar.",
307
+ "description": "Shows a dot for each slide, with a wider dot for the current slide. When `autoplay` is set, the current dot also shows a progress bar.",
301
308
  "attribute": "pagination",
302
309
  "reflects": true
303
310
  },
304
311
  {
305
312
  "kind": "method",
306
313
  "name": "play",
307
- "description": "Starts the slideshow playback.",
314
+ "description": "Starts automatic playback. Does nothing unless `autoplay` or `autoScroll` is set.",
308
315
  "type": {
309
316
  "text": "play() => void"
310
317
  }
@@ -316,7 +323,7 @@
316
323
  "type": {
317
324
  "text": "boolean"
318
325
  },
319
- "description": "If true, the slideshow will start playing automatically on page load when `autoplay` or `autoScroll` are on.",
326
+ "description": "Starts playback when the slideshow loads. Applies only when `autoplay` or `autoScroll` is set.",
320
327
  "attribute": "playoninit",
321
328
  "reflects": true
322
329
  },
@@ -354,7 +361,7 @@
354
361
  {
355
362
  "kind": "method",
356
363
  "name": "renderPaginationContainer",
357
- "description": "Generates the HTML for the pagination container, which includes the play button and pagination dots.\nIf autoplay or autoScroll is enabled, it will render the play button.\nIf pagination is enabled, it will render the dots.",
364
+ "description": "Generates the HTML for the pagination container, which includes the play button and pagination dots.\nIf autoplay or autoScroll is enabled, it renders the play button.\nIf pagination is enabled, it renders the dots.",
358
365
  "privacy": "private"
359
366
  },
360
367
  {
@@ -385,10 +392,11 @@
385
392
  "type": {
386
393
  "text": "number"
387
394
  },
388
- "description": "Number of pixels auto scroll should advance per frame (Only used with `autoScroll`).",
395
+ "description": "Sets how fast the slides scroll, in pixels per frame. Use a higher number to scroll faster. Applies only when `autoScroll` is set.",
389
396
  "default": "0.75",
390
397
  "attribute": "scrollspeed",
391
- "reflects": true
398
+ "reflects": true,
399
+ "relevantWhen": "autoScroll"
392
400
  },
393
401
  {
394
402
  "kind": "field",
@@ -397,15 +405,16 @@
397
405
  "type": {
398
406
  "text": "number"
399
407
  },
400
- "description": "Delay in milliseconds before the auto scroll starts (Only used with `autoScroll`).",
408
+ "description": "Sets how long the slideshow waits before it starts or resumes scrolling, in milliseconds. Applies only when `autoScroll` is set.",
401
409
  "default": "1000",
402
410
  "attribute": "startdelay",
403
- "reflects": true
411
+ "reflects": true,
412
+ "relevantWhen": "autoScroll"
404
413
  },
405
414
  {
406
415
  "kind": "method",
407
416
  "name": "stop",
408
- "description": "Stops the slideshow playback.",
417
+ "description": "Stops automatic playback. Does nothing unless `autoplay` or `autoScroll` is set.",
409
418
  "type": {
410
419
  "text": "stop() => void"
411
420
  }
@@ -447,8 +456,9 @@
447
456
  "type": {
448
457
  "text": "string"
449
458
  },
450
- "description": "Accessible label for the pause button. **Deprecated:** use `ariaLabel.slideshow.pause` instead.",
459
+ "description": "Deprecated: Use `ariaLabel.slideshow.pause` instead.\nSets the text screen readers announce for the pause button. Used only when the `ariaLabel.slideshow.pause` slot is empty.",
451
460
  "deprecated": "Use `ariaLabel.slideshow.pause` instead.",
461
+ "default": "\"Pause slideshow\"",
452
462
  "attribute": "pauselabel",
453
463
  "reflects": true
454
464
  },
@@ -459,8 +469,9 @@
459
469
  "type": {
460
470
  "text": "string"
461
471
  },
462
- "description": "Accessible label for the play button. **Deprecated:** use `ariaLabel.slideshow.play` instead.",
472
+ "description": "Deprecated: Use `ariaLabel.slideshow.play` instead.\nSets the text screen readers announce for the play button. Used only when the `ariaLabel.slideshow.play` slot is empty.",
463
473
  "deprecated": "Use `ariaLabel.slideshow.play` instead.",
474
+ "default": "\"Play slideshow\"",
464
475
  "attribute": "playlabel",
465
476
  "reflects": true
466
477
  }
@@ -471,7 +482,7 @@
471
482
  "type": {
472
483
  "text": "boolean"
473
484
  },
474
- "description": "If true, the slideshow will play automatically.",
485
+ "description": "Adds a play and pause button and moves to the next slide after each `delay`. The slideshow starts playing on page load only when `playOnInit` is also set.",
475
486
  "fieldName": "autoplay"
476
487
  },
477
488
  {
@@ -479,7 +490,7 @@
479
490
  "type": {
480
491
  "text": "boolean"
481
492
  },
482
- "description": "If true, the slideshow will scroll continuously.",
493
+ "description": "Scrolls the slides at a steady pace instead of stopping on each slide, and adds a play and pause button. The slideshow starts scrolling on page load only when `playOnInit` is also set. Doesn't apply on touch devices (those with a coarse primary pointer), and `autoplay` takes priority when both are set.",
483
494
  "fieldName": "autoScroll"
484
495
  },
485
496
  {
@@ -487,16 +498,17 @@
487
498
  "type": {
488
499
  "text": "number"
489
500
  },
490
- "description": "Slide duration in milliseconds (Only used with `autoplay`).",
501
+ "description": "Sets how long each slide shows before the slideshow moves to the next one, in milliseconds. Applies only when `autoplay` is set.",
491
502
  "default": "7000",
492
- "fieldName": "delay"
503
+ "fieldName": "delay",
504
+ "relevantWhen": "autoplay"
493
505
  },
494
506
  {
495
507
  "name": "fullbleed",
496
508
  "type": {
497
509
  "text": "boolean"
498
510
  },
499
- "description": "If set, the slideshow will take up the width of its parent container showing previous and next slides. **Note:** a parent container must have `overflow-x: hidden` to prevent horizontal scrolling.",
511
+ "description": "Stretches the slideshow to the full width of the browser window, so parts of the previous and next slides show beside the current slide. Each slide stays as wide as the slideshow's container. To prevent horizontal scrolling, set `overflow-x: hidden` on a parent container.",
500
512
  "fieldName": "fullBleed"
501
513
  },
502
514
  {
@@ -504,7 +516,7 @@
504
516
  "type": {
505
517
  "text": "boolean"
506
518
  },
507
- "description": "If true, the slideshow will loop back to the first slide after reaching the last slide.",
519
+ "description": "Goes back to the first slide after the last slide instead of stopping at the end. When `loop` isn't set, `autoplay` and `autoScroll` stop on the last slide.",
508
520
  "fieldName": "loop"
509
521
  },
510
522
  {
@@ -512,7 +524,7 @@
512
524
  "type": {
513
525
  "text": "boolean"
514
526
  },
515
- "description": "If true, the slideshow will display navigation arrows for previous and next slides when the slide container is hovered.",
527
+ "description": "Shows previous and next arrow buttons when the slides are hovered. When `loop` isn't set, the arrow for a direction is hidden at the first or last slide. The arrows don't appear on touch devices, where the primary pointer is coarse.",
516
528
  "fieldName": "navigation"
517
529
  },
518
530
  {
@@ -520,7 +532,7 @@
520
532
  "type": {
521
533
  "text": "boolean"
522
534
  },
523
- "description": "If true, the slideshow will display pagination dots for each slide. If autoplay is on, the active dot will also show a progress bar.",
535
+ "description": "Shows a dot for each slide, with a wider dot for the current slide. When `autoplay` is set, the current dot also shows a progress bar.",
524
536
  "fieldName": "pagination"
525
537
  },
526
538
  {
@@ -528,7 +540,7 @@
528
540
  "type": {
529
541
  "text": "boolean"
530
542
  },
531
- "description": "If true, the slideshow will start playing automatically on page load when `autoplay` or `autoScroll` are on.",
543
+ "description": "Starts playback when the slideshow loads. Applies only when `autoplay` or `autoScroll` is set.",
532
544
  "fieldName": "playOnInit"
533
545
  },
534
546
  {
@@ -536,26 +548,29 @@
536
548
  "type": {
537
549
  "text": "number"
538
550
  },
539
- "description": "Number of pixels auto scroll should advance per frame (Only used with `autoScroll`).",
551
+ "description": "Sets how fast the slides scroll, in pixels per frame. Use a higher number to scroll faster. Applies only when `autoScroll` is set.",
540
552
  "default": "0.75",
541
- "fieldName": "scrollSpeed"
553
+ "fieldName": "scrollSpeed",
554
+ "relevantWhen": "autoScroll"
542
555
  },
543
556
  {
544
557
  "name": "startdelay",
545
558
  "type": {
546
559
  "text": "number"
547
560
  },
548
- "description": "Delay in milliseconds before the auto scroll starts (Only used with `autoScroll`).",
561
+ "description": "Sets how long the slideshow waits before it starts or resumes scrolling, in milliseconds. Applies only when `autoScroll` is set.",
549
562
  "default": "1000",
550
- "fieldName": "startDelay"
563
+ "fieldName": "startDelay",
564
+ "relevantWhen": "autoScroll"
551
565
  },
552
566
  {
553
567
  "name": "pauselabel",
554
568
  "type": {
555
569
  "text": "string"
556
570
  },
557
- "description": "Accessible label for the pause button. **Deprecated:** use `ariaLabel.slideshow.pause` instead.",
571
+ "description": "Deprecated: Use `ariaLabel.slideshow.pause` instead.\nSets the text screen readers announce for the pause button. Used only when the `ariaLabel.slideshow.pause` slot is empty.",
558
572
  "deprecated": "Use `ariaLabel.slideshow.pause` instead.",
573
+ "default": "\"Pause slideshow\"",
559
574
  "fieldName": "pauseLabel"
560
575
  },
561
576
  {
@@ -563,8 +578,9 @@
563
578
  "type": {
564
579
  "text": "string"
565
580
  },
566
- "description": "Accessible label for the play button. **Deprecated:** use `ariaLabel.slideshow.play` instead.",
581
+ "description": "Deprecated: Use `ariaLabel.slideshow.play` instead.\nSets the text screen readers announce for the play button. Used only when the `ariaLabel.slideshow.play` slot is empty.",
567
582
  "deprecated": "Use `ariaLabel.slideshow.play` instead.",
583
+ "default": "\"Play slideshow\"",
568
584
  "fieldName": "playLabel"
569
585
  }
570
586
  ],
@@ -574,6 +590,7 @@
574
590
  },
575
591
  "tagName": "auro-slideshow",
576
592
  "customElement": true,
593
+ "summary": "A customizable slideshow with autoplay, continuous scrolling, navigation arrows, and pagination dots.",
577
594
  "modulePath": "src/auro-slideshow.js"
578
595
  }
579
596
  ],
@@ -639,5 +656,6 @@
639
656
  "declarations": [],
640
657
  "exports": []
641
658
  }
642
- ]
659
+ ],
660
+ "package": "@aurodesignsystem-dev/auro-slideshow@0.0.0-pr80.1"
643
661
  }