@aurodesignsystem-dev/auro-slideshow 0.0.0-pr80.0 → 0.0.0-pr80.2

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/index.md CHANGED
@@ -1,35 +1,35 @@
1
1
  <!--
2
2
  THIS PAGE'S CONTENT SHOULD BE KEPT MINIMAL.
3
- ONLY ADD EXAMPLES THAT ARE TRULY NECESSARY FOR THE INDEX PAGE — THE BASIC EXAMPLE IS USUALLY ENOUGH.
3
+ ONLY ADD EXAMPLES THAT ARE TRULY NECESSARY FOR THE INDEX PAGE. THE BASIC EXAMPLE IS USUALLY ENOUGH.
4
4
  ALL OTHER EXAMPLES SHOULD GO IN THE API DOCUMENTATION.
5
5
  -->
6
6
 
7
- # Slideshow
7
+ # Slideshow
8
8
 
9
9
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
10
10
  <!-- The below content is automatically added from ./../docs/partials/description.md -->
11
- `<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.
11
+ `<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.
12
12
 
13
- 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.
13
+ 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.
14
14
 
15
- `<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.
15
+ No features are on by default. Turn on a feature by adding its attribute to the element.
16
16
 
17
- **Note:** If all the slides can fit on the screen at once, the slideshow will not activate.
17
+ **Note:** If all the slides fit on the screen at once, the slideshow doesn't activate.
18
18
  <!-- AURO-GENERATED-CONTENT:END -->
19
19
 
20
- ## Use Cases
20
+ ## Use cases
21
21
 
22
22
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) -->
23
23
  <!-- The below content is automatically added from ./../docs/partials/useCases.md -->
24
- The `<auro-slideshow>` element should be used in situations where:
24
+ Use `<auro-slideshow>` when you need to:
25
25
 
26
- * A series of images or content needs to be displayed in a space-saving way
27
- * Autoplaying or autoscrolling functionality is needed
28
- * A current slide indicator is required
26
+ * Show a series of images or content in a space-saving way
27
+ * Advance slides automatically or scroll them continuously
28
+ * Show which slide is current
29
29
  <!-- AURO-GENERATED-CONTENT:END -->
30
30
 
31
- ## Example(s)
32
-
31
+ ## Examples
32
+
33
33
  ### Autoplay
34
34
 
35
35
  <div class="exampleWrapper">
@@ -75,7 +75,7 @@ The `<auro-slideshow>` element should be used in situations where:
75
75
  &lt;div style="height: 480px"&gt;
76
76
  &lt;img style="object-fit: cover;" src="https://picsum.photos/1000/480?random=5" alt="Random image 5"&gt;
77
77
  &lt;/div&gt;
78
- &lt;/auro-slideshow&gt;</code></pre>
78
+ &lt;/auro-slideshow&gt;</code></pre>
79
79
  <!-- AURO-GENERATED-CONTENT:END -->
80
80
  </auro-accordion>
81
81
 
@@ -124,6 +124,6 @@ The `<auro-slideshow>` element should be used in situations where:
124
124
  &lt;div style="height: 480px; max-width: 400px;"&gt;
125
125
  &lt;img style="object-fit: cover;" src="https://picsum.photos/400/480?random=5" alt="Random image 5"&gt;
126
126
  &lt;/div&gt;
127
- &lt;/auro-slideshow&gt;</code></pre>
127
+ &lt;/auro-slideshow&gt;</code></pre>
128
128
  <!-- AURO-GENERATED-CONTENT:END -->
129
129
  </auro-accordion>