Skip to content

Commit e80b495

Browse files
committed
docs: add note about slideshow activation based on slide visibility
1 parent 2ba8078 commit e80b495

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The following sections are editable by making changes to the following files:
2626
The `<auro-slideshow>` component is a wrapper element. All slides are slotted content and must be direct children of the component. Slides must have assigned `width` and `height` properties to display properly.
2727

2828
`<auro-slideshow>` is a fully customizable component 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.
29+
30+
**Note:** If all the slides can fit on the page at once, the slideshow will not activate.
2931
<!-- AURO-GENERATED-CONTENT:END -->
3032
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
3133
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->

docs/partials/api.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,6 @@ To enable the slideshow to show a preview of the previous and next slides, use t
207207

208208
### Full-Bleed + AutoScroll Preview
209209

210-
`autoScroll` only works if there are more slides than can fit on the page at once. If every slide is visible without scrolling, `autoScroll` will not activate.
211-
212210
<div class="exampleWrapper">
213211
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullBleedAutoScroll.html) -->
214212
<!-- AURO-GENERATED-CONTENT:END -->

docs/partials/description.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
The `<auro-slideshow>` component is a wrapper element. All slides are slotted content and must be direct children of the component. Slides must have assigned `width` and `height` properties to display properly.
44

5-
`<auro-slideshow>` is a fully customizable component 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.
5+
`<auro-slideshow>` is a fully customizable component 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.
6+
7+
**Note:** If all the slides can fit on the page at once, the slideshow will not activate.

0 commit comments

Comments
 (0)