react-achievements 1.0.5 → 1.0.7
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/README.md +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# Welcome to React-Achievements!
|
|
2
2
|
|
|
3
|
+
## THIS IS STILL A WORK IN PROGRESS
|
|
3
4
|
A flexible and customizable achievement system for React applications.
|
|
4
5
|
|
|
5
6
|
## Installation
|
|
@@ -76,6 +77,19 @@ const achievementConfig = {
|
|
|
76
77
|
export default achievementConfig;
|
|
77
78
|
```
|
|
78
79
|
|
|
80
|
+
### Update the location of the badges button
|
|
81
|
+
You can specify the position of the badges button by passing
|
|
82
|
+
badgesButtonPosition to the AchievementProvider:
|
|
83
|
+
```javascript
|
|
84
|
+
<AchievementProvider config={achievementConfig} badgesButtonPosition="bottom-right">
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
The possible values for badgesButtonPosition are
|
|
88
|
+
- `'top-left'`
|
|
89
|
+
- `'top-right'`
|
|
90
|
+
- `'bottom-left'`
|
|
91
|
+
- `'bottom-right'`
|
|
92
|
+
|
|
79
93
|
### Use the useAchievement hook
|
|
80
94
|
In your components, use the useAchievement hook to update metrics and trigger achievement checks:
|
|
81
95
|
```javascript
|