@quantabit/gamification-sdk
v1.0.2
Published
QuantaBit Gamification SDK - Achievement system, leaderboards, challenge tasks, and badge collection
Maintainers
Readme
@quantabit/gamification-sdk
QuantaBit Gamification SDK - Achievement system, leaderboards, and challenge tasks
📦 Installation
npm install @quantabit/gamification-sdk
# or
yarn add @quantabit/gamification-sdk🚀 Quick Start
Using Components
import { AchievementCard, AchievementList, AchievementUnlockToast, LeaderboardEntry, LeaderboardTabs, MyRankCard } from '@quantabit/gamification-sdk';
<AchievementCard />
<AchievementList />
<AchievementUnlockToast />Using Hooks
import { useAchievements, useBadges, useLeaderboard, useChallenges, useGamification } from '@quantabit/gamification-sdk';
function MyComponent() {
const result = useAchievements();
const result = useBadges();
const result = useLeaderboard();
return <div>...</div>;
}API Client
import { gamificationApi } from '@quantabit/gamification-sdk';
// Use gamificationApi for direct API calls
const data = await gamificationApi.list();📚 Components
| Component | Description |
| --------- | ----------- |
| AchievementCard | Achievement Card component |
| AchievementList | Achievement List component |
| AchievementUnlockToast | Achievement Unlock Toast component |
| LeaderboardEntry | Leaderboard Entry component |
| LeaderboardTabs | Leaderboard Tabs component |
| MyRankCard | My Rank Card component |
| Leaderboard | Leaderboard component |
| BadgeCard | Badge Card component |
| BadgeGrid | Badge Grid component |
| BadgeShowcase | Badge Showcase component |
🪝 Hooks
| Hook | Description |
| ---- | ----------- |
| useAchievements | Achievements management |
| useBadges | Badges management |
| useLeaderboard | Leaderboard management |
| useChallenges | Challenges management |
| useGamification | Gamification management |
📖 Type Definitions
import { AchievementType, BadgeRarity, LeaderboardType, ChallengeStatus } from '@quantabit/gamification-sdk';🌐 Internationalization
import { setLanguage, t } from '@quantabit/gamification-sdk';
setLanguage("en");📄 License
MIT License
🌐 Brand & Links
- Official Mainnet: QuantaBit Chain
- Developer Platform: Developer Platform
- Open Platform: Open Platform
- Payment Platform: Pay Platform
- Feedback: Feedback
