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

    Props for DeckBoard.

    interface DeckBoardProps {
        cardSx?: SxProps<Theme>;
        colors?: Partial<GameColors>;
        columns?: number;
        dense?: boolean;
        game?: string;
        instructions?: false | GameInstructions | readonly GameInstructions[];
        labels?: Partial<GameLabels>;
        mascot?: false | MascotName;
        maxTries?: number;
        names?: Partial<IntervalNames>;
        onAnother?: () => void;
        onCardSettled?: (round: DeckRound, index: number) => void;
        onDeckCompleted?: (summary: DeckSummary, record: DeckRecord) => void;
        onError?: (error: Error) => void;
        onResult?: (result: GameResult) => void;
        player?: { id: string; name?: string };
        prompt?: PromptPlacement;
        resultStore?: ResultStore;
        retryUntilRight?: boolean;
        samples?: SampleSource;
        scoreLabels?: Partial<DeckScoreCardLabels>;
        seed: number;
        settings: DeckSettings;
        showInstructionsFirst?: boolean;
        showScore?: boolean;
        showScoreCard?: boolean;
        sounds?: boolean;
        sx?: SxProps<Theme>;
        theoryNames?: Partial<TheoryNames>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cardSx?: SxProps<Theme>

    Each card's frame

    colors?: Partial<GameColors>
    columns?: number

    Cards across (default: 2)

    dense?: boolean

    Smaller cards, so a whole board fits one screen (default: true when there are three or more columns)

    game?: string

    The game's name, stamped on its results (default: the kinds of its cards)

    instructions?: false | GameInstructions | readonly GameInstructions[]

    How to play, shown from the help button and on first play (default: made from the kinds of cards; false hides the help button)

    labels?: Partial<GameLabels>
    mascot?: false | MascotName

    The mascot who reacts to answers (default: 'owl'; false for none)

    maxTries?: number

    With retryUntilRight, the goes a card gets before it is settled and its answer shown (default: 3; Infinity for no end)

    names?: Partial<IntervalNames>
    onAnother?: () => void

    Another board with the same settings; the score card shows the button when given

    onCardSettled?: (round: DeckRound, index: number) => void

    A card was settled

    onDeckCompleted?: (summary: DeckSummary, record: DeckRecord) => void

    Every card was settled

    onError?: (error: Error) => void
    onResult?: (result: GameResult) => void

    A result was made, whether or not a store kept it

    player?: { id: string; name?: string }

    Who is playing, stamped on results

    Where each card's prompt goes (default: 'below', as on a printed board)

    resultStore?: ResultStore

    Where results go; nothing is kept without it

    retryUntilRight?: boolean

    After a wrong answer, let the player try again (default: true) — up to maxTries goes, and only once on a card of two choices, after which the card is settled and its right answer shown; otherwise one answer settles the card. A card judged move by move goes on until it is done

    samples?: SampleSource

    Recorded piano samples for the notes the cards play (see UseGameSoundsOptions); without them a small built-in voice plays

    scoreLabels?: Partial<DeckScoreCardLabels>
    seed: number
    settings: DeckSettings
    showInstructionsFirst?: boolean

    Show how to play before the first card (default: false)

    showScore?: boolean

    Show points, stars and streak as the game goes (default: true)

    showScoreCard?: boolean

    Show the score card under the board once every card is settled (default: true)

    sounds?: boolean

    Sound notes as they are placed, and a tone on right and wrong (default: true)

    sx?: SxProps<Theme>

    The board's grid

    theoryNames?: Partial<TheoryNames>