Hiyve Components - v1.0.0
    Preparing search index...

    Props for GameHud: the one row over the world.

    interface GameHudProps {
        extra?: ReactNode;
        labels?: Partial<GameShellLabels>;
        look?: GameLookName | GameLook;
        mascot?: false | MascotName;
        mood?: MascotMood;
        muted?: boolean;
        onHelp?: () => void;
        onMutedChange?: (muted: boolean) => void;
        progress?: ReactNode;
        score?: { points: number; stars: number } | null;
        streak?: number;
        subtitle?: string;
        sx?: SxProps<Theme>;
        tip?: string;
        title?: string;
    }
    Index

    Properties

    extra?: ReactNode

    More chips beside the progress — a clock, the keys — kept on a phone too

    labels?: Partial<GameShellLabels>

    The look of the chips and buttons (default: the frame's)

    mascot?: false | MascotName

    In the medallion at the start of the row

    mood?: MascotMood
    muted?: boolean

    The sound button shows when onMutedChange is given

    onHelp?: () => void

    The help button shows when given

    onMutedChange?: (muted: boolean) => void
    progress?: ReactNode

    The game's own progress: a space, a bucket, a song or a gate (a HudChip)

    score?: { points: number; stars: number } | null

    Points and stars; null hides them

    streak?: number

    Right answers in a row; a flame shows from two

    subtitle?: string

    Under the title, on a wide screen

    sx?: SxProps<Theme>
    tip?: string

    The lightbulb's tip; the button shows when given (on a phone the tip is in How to play instead)

    title?: string