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

    Props for GameShell: the frame every game is built in.

    interface GameShellProps {
        celebrate?: boolean;
        children?: ReactNode;
        hud?: ReactNode;
        look?: GameLookName | GameLook;
        onLayout?: (layout: GameShellLayout) => void;
        overlay?: ReactNode;
        panel?: ReactNode | ((view: GameStageView) => ReactNode);
        peek?: ReactNode;
        sheet?: "up" | "down" | "hidden";
        stage?: ReactNode | ((view: GameStageView) => ReactNode);
        sx?: SxProps<Theme>;
        world?: ReactNode | ((view: GameStageView) => ReactNode);
    }
    Index

    Properties

    celebrate?: boolean

    Confetti over the frame

    children?: ReactNode

    Anything else that should know the frame's layout and look: How to play, say

    hud?: ReactNode

    The HUD row (a GameHud)

    The look of the glass and buttons (default: 'night')

    onLayout?: (layout: GameShellLayout) => void

    The layout was worked out, or changed with the frame's size

    overlay?: ReactNode

    The Ready or End screen, over the world

    panel?: ReactNode | ((view: GameStageView) => ReactNode)

    The card: in a panel beside the stage on a wide screen, in a bottom sheet on a phone; a function is told the layout

    peek?: ReactNode

    A short bar over the bottom of the world while the sheet is lowered: what is happening now

    sheet?: "up" | "down" | "hidden"

    Where the sheet is on a phone: raised for a question, lowered while the piece moves (showing peek), or hidden (default: 'up' when there is a panel)

    stage?: ReactNode | ((view: GameStageView) => ReactNode)

    The play area — a board, a railway — filling the space the HUD and the panel leave; a function is told the layout and what the sheet covers

    sx?: SxProps<Theme>
    world?: ReactNode | ((view: GameStageView) => ReactNode)

    The world behind everything — sky, hills, water — filling the frame; a function is told the layout