gamify-ui-core/dist/src/hooks/useGamify.d.ts

🚀 The ultimate gamification engine for modern web applications. Framework-agnostic, real-time leaderboards, custom rule engine, streaks, missions, and AI-powered features.

import React from 'react';
import { GamifyEngine } from '../core/GamifyEngine';
import { User, Achievement, GamifyHookReturn } from '../types';
export declare const GamifyProvider: React.FC<{
    engine: GamifyEngine;
    children: React.ReactNode;
}>;
/**
 * Main hook to use the gamification engine
 */
export declare const useGamify: (userId?: string) => GamifyHookReturn;
/**
 * Hook for level up notifications
 */
export declare const useLevelUp: (userId?: string) => {
    user: User;
    level: number;
} | null;
/**
 * Hook for achievement notifications
 */
export declare const useAchievement: (userId?: string) => {
    user: User;
    achievement: Achievement;
} | null;
/**
 * Hook for leaderboard data
 */
export declare const useLeaderboard: (limit?: number) => any[];
/**
 * Hook for missions
 */
export declare const useMissions: (userId?: string) => any[];
/**
 * Hook for user statistics
 */
export declare const useUserStats: (userId?: string) => {
    totalXp: number;
    totalBadges: number;
    totalAchievements: number;
    activeStreaks: number;
    averageLevel: number;
    rank: number;
};
/**
 * Hook for theme
 */
export declare const useTheme: () => import("../types").Theme;
/**
 * Hook for configuration
 */
export declare const useConfig: () => import("../types").GamifyConfig;
//# sourceMappingURL=useGamify.d.ts.map