janishutz-legacy/impress.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins documentation / getting started guide (#835)

Browse Source
This commit is contained in:
Janis Hutz
2023-02-02 12:14:44 +00:00
committed by GitHub
parent 4edb9e08a0
commit 9475720f42
8 changed files with 90 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/plugins/autoplay/README.md Normal file
View File

@@ -0,0 +1,24 @@
# Autoplay
The [autoplay](/src/plugins/autoplay/autoplay.js) plugin automatically advances the presentation after a certain timeout expired.
## USAGE
You first have to enable the plugin by setting a global ```data-autoplay``` value on the impress-div. Then you can change individual ```data-autoplay``` values on each *step* by adding ```data-autoplay``` to it. If this value is set to ```0```, there will be no more auto-advancing on this *step*. The value you enter is time in seconds to switch to the next slide.
## EXAMPLE
Note: This only shows part of the HTML. If you want to know how to set up a presentation, I highly recommend you read our [Getting Started Guide](/GettingStarted.md)
```
<div id=impress data-autoplay="5">
<div class="step" data-autoplay="0">
This slide will not auto-advance
</div>
<div class="step">
This slide will auto-advance at the globally defined rate.
</div>
<div class="step" data-autoplay="10">
This slide will auto-advance after 10 seconds
</div>
</div>
```