narraleaf-react/dist/game/player/elements/type.d.ts

A React visual novel player framework

import React, { ErrorInfo } from "react";
import { IDialogProps, SayElementProps } from "../elements/say/type";
import { IUserMenuProps, MenuElementProps } from "../elements/menu/type";
import { Story } from "../../nlcore/elements/story";
import clsx from "clsx";
import { Game } from "../../nlcore/game";
import { GameState } from "../gameState";
import { Storable } from "../../nlcore/elements/persistent/storable";
import { LiveGame } from "../../nlcore/game/liveGame";
import { INotificationsProps, NotificationsProps } from "./notification/type";
export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
export type SayComponent = Components<IDialogProps>;
export type MenuComponent = Components<IUserMenuProps>;
export type NotificationComponent = Components<INotificationsProps>;
export type ComponentsTypes = {
    say: SayComponent;
    menu: MenuComponent;
    notification: NotificationComponent;
};
export type { SayElementProps, MenuElementProps, NotificationsProps as INotificationProps, };
export type PlayerEventContext = {
    game: Game;
    gameState: GameState;
    liveGame: LiveGame;
    storable: Storable;
};
export interface PlayerProps {
    story?: Story;
    width?: string | number;
    height?: string | number;
    className?: clsx.ClassValue;
    /**
     * Once the game is ready to be played
     *
     * only called each lifecycle once
     */
    onReady?: (ctx: PlayerEventContext) => void;
    /**
     * Once the game is ended
     *
     * only called each lifecycle once
     */
    onEnd?: (ctx: PlayerEventContext) => void;
    /**
     * Once the game encounters an error
     *
     * only called each lifecycle once
     */
    onError?: (error: Error, errorInfo: ErrorInfo) => void;
    children?: React.ReactNode;
    /**
     * Whether to show the player
     *
     * Even the active is false, the pages will be rendered
     *
     * @default true
     */
    active?: boolean;
}