reveal-quiz
v0.0.10
Published
reveal.js plugin that allows adding quizes as slides.
Downloads
3
Readme
reveal-quiz
reveal.js plugin that allows adding quizzes as slides.
usage
Create a simple question slide in markdown:
<section data-quiz>
- Who won the 2018 football world cup ?
- [x] France
- [ ] Germany
- [ ] Italy
- [ ] Brazil
</section>
The question itself should be a simple text. The answers are written as Markdown task lists. The checked answers are the valid ones. If only one answer is valid, answers will be displayed as radio buttons, otherwise they will be displayed as check boxes.
configuration
Configuration can be made global, or slide-specific.
Global configuration is passed to the plugin using standard reveal.js configuration, with the quiz
property:
<script type="module">
import Reveal from './node_modules/reveal.js/dist/reveal.esm.js';
import markdown from './node_modules/reveal.js/plugin/markdown/markdown.esm.js';
import RevealQuizz from './node_modules/reveal-quiz/dist/reveal-quiz-bundle-esm.js';
Reveal.initialize({
quiz: {
useTimer: true,
defaultTimerDuration: 60,
},
plugins: [markdown, RevealQuizz],
});
</script>
slide-specific configuration is passed using data-quiz-config-*
attributes on quiz slides.
<section data-quiz data-quiz-config-useTimer="true" data-quiz-config-timerDuration="30">
- Who won the 2018 football world cup ?
- [x] France
- [ ] Germany
- [ ] Italy
- [ ] Brazil
</section>
available configuration properties
| global property | slide property | default value | description |
|-------------------|------------------------------------|---------------|-----------------------------------------------------|
| useTimer | data-quiz-config-userTimer | false | set to true
to activate a timer on questions |
| timerDuration | data-quiz-config-timerDuration | 60 | the duration of the timer |
| randomizeAnswers | data-quiz-config-randomizeAnswers | false | set to true
to randomize the answers on questions |