Skip to content

Commit

Permalink
Merge pull request #205 from wingkwong/develop
Browse files Browse the repository at this point in the history
0.8.0 Release
  • Loading branch information
wingkwong authored Jan 21, 2024
2 parents 5e95a87 + b499aa4 commit 1e23e71
Show file tree
Hide file tree
Showing 14 changed files with 600 additions and 348 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# CHANGELOG

## 0.8.0

- Bumped dependencies
- Introduced Timer Support with Pause / Resume
- Supported unanswered questions

## 0.7.1

- Bumped dependencies
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ react-quiz-component is a ReactJS component allowing users to attempt a quiz.
- Allow Picture in Question
- Scoring System
- Shuffling Questions / Answers
- Timer Support
- Support Pause/Resume Timer
- Shows unanswered questions

## Installing

Expand Down Expand Up @@ -258,6 +261,24 @@ import { quiz } from './quiz';
<Quiz quiz={quiz} continueTillCorrect={true}/>
```


## Timer Feature

```js
import { quiz } from './quiz';
...
<Quiz quiz={quiz} timer={60}/>
```


## Pause / Resume Timer Feature

```js
import { quiz } from './quiz';
...
<Quiz quiz={quiz} timer={60} allowPauseTimer={true}/>
```

## Props

|Name|Type|Default|Required|Description|
Expand All @@ -272,6 +293,8 @@ import { quiz } from './quiz';
|continueTillCorrect|`boolean`|`false`|N|Continue to select an answer until it is correct|
|onQuestionSubmit|`function`|`null`|N|A user response for a question will be returned|
|disableSynopsis|`boolean`|`false`|N|Disable synopsis before quiz|
|timer|`number`|`false`|N|Sets timer in seconds|
|allowPauseTimer|`boolean`|`false`|N|Pause / Resume timer|

## Contribution

Expand Down
4 changes: 2 additions & 2 deletions dist/index.es.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/bundle.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/main.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1e23e71

Please sign in to comment.