@pixi/react/types/typedefs/ApplicationProps.d.ts

Write PixiJS applications using React declarative style.

import { type Application, type ApplicationOptions, type ExtensionFormatLoose, type TextStyle, type TextStyleOptions } from 'pixi.js';
import { type Key, type RefObject } from 'react';
import { type PixiReactChildNode } from './PixiReactChildNode';
export interface BaseApplicationProps {
    /** @description CSS classes to be applied to the Pixi Application's canvas element. */
    className?: string;
    /** @description Child components. */
    children?: PixiReactChildNode;
    /** @description The default style to be applied to text nodes. */
    defaultTextStyle?: TextStyle | TextStyleOptions;
    /** @description An array of Pixi extensions to be loaded before initialisation. */
    extensions?: (ExtensionFormatLoose | any)[];
    /** @description A unique key which allows React to manage this component across changes in parent state. */
    key?: Key;
    /** @description Callback to be fired when the application finishes initializing. */
    onInit?: (app: Application) => void;
    /** @description An element (or React ref) to which the application's canvas will be resized. */
    resizeTo?: HTMLElement | Window | RefObject<HTMLElement | null>;
}
export type ApplicationProps = BaseApplicationProps & Partial<{
    [K in keyof ApplicationOptions as K]?: K extends keyof BaseApplicationProps ? BaseApplicationProps[K] : ApplicationOptions[K];
}>;