PixiCanvas

The PixiCanvas component is the primary way to create a PixiJS application in a pixi-solid application. It handles creating and managing the HTML canvas element, the Pixi.js Application instance, and provides context to child components for accessing the application and ticker.

Features

Automatically creates and manages a Pixi.Application instance
Wraps the canvas in a responsive container that automatically resizes
Provides context for ticker-based utilities (onTick, getTicker, etc.)
Accepts all standard PixiJS Application options as props
Can be used standalone or with PixiApplicationProvider for more control

Usage

Simple Standalone Usage

The simplest way to use PixiCanvas is standalone. It will automatically create and manage the Pixi Application for you:

import { PixiCanvas, Sprite, Container } from "pixi-solid";
import { Texture } from "pixi.js";

export const App = () => (
  <PixiCanvas style={{ width: "100%", height: "100dvh" }} background="#1099bb">
    <Container>
      <Sprite texture={Texture.WHITE} x={100} y={100} scale={50} tint="#ff0000" />
    </Container>
  </PixiCanvas>
);

Props

PixiCanvas accepts two types of props:

import type { PixiCanvasProps } from "pixi-solid";

DOM Props (for the wrapper div)

Standard HTML element props that control the wrapper container:

style - CSS styles for the wrapper div
class / classList - CSS classes
id, title, role, tabIndex - Standard HTML attributes
aria-* attributes - ARIA accessibility attributes
data-* attributes - Data attributes
ref - Reference to the wrapper HTMLDivElement
DOM event handlers (without the on: prefix)

PixiJS Application Options

Any valid Pixi.ApplicationOptions property:

background - Background color (hex or CSS color)
antialias - Enable antialiasing
resolution - Canvas resolution
width / height - Canvas dimensions (if not using CSS)
preserveDrawingBuffer - Preserve the drawing buffer
And many more...

See the PixiJS docs for the complete list of options.

Special Props

children - The pixi-solid components to render inside the canvas (required)

Examples

Responsive Canvas with Background

<PixiCanvas style={{ width: "100%", height: "100vh" }} background="#1099bb" antialias={true}>
  <MyContent />
</PixiCanvas>

Canvas with Custom Resolution

<PixiCanvas style={{ width: "800px", height: "600px" }} resolution={2}>
  <MyContent />
</PixiCanvas>

Canvas with Data Attributes

<PixiCanvas
  data-testid="pixi-canvas"
  style={{ width: "100%", height: "100%", backgroundColor: "black" }}
>
  <MyContent />
</PixiCanvas>

How It Works

Creates an internal wrapper <div> element with the provided DOM props
Automatically creates a Pixi.Application instance with the provided options
Mounts the Pixi canvas into the internal wrapper div
Sets up automatic resizing based on the internal wrapper div's size (not just the window size)
Provides context to child components for accessing the application and ticker
Cleans up the application when the component unmounts

When to use it

For all basic Pixi.js applications in Pixi Solid
When you want the simplest possible setup
When you don't need to share the application with external HTML components

PixiApplicationProvider - When you need HTML components outside the canvas to access pixi-solid hooks
TickerProvider - For ticker functionality without a full application