Skip to content

pixijs/pixi-react

Repository files navigation

pixi-react

Pixi React

Simply the best way to write PixiJS applications in React
Write PixiJS applications using React declarative style 👌


release downloads ci tests license react version pixi version


Pixi React is an open-source, production-ready library to render high performant PixiJS applications in React.

Features

  • React 17 and 18 support
  • PixiJS v6 and v7 support
  • react-spring compatible animated components

Get started

Quick start

If you want to start a new React project from scratch, we recommend Vite. To add to an existing React application, just install the dependencies:

Start New React Project "my-app" with Create React Vite:

# for typescript use "--template react-ts"
npx create-vite@latest --template react my-app
cd my-app

Install Pixi React Dependencies:

npm install pixi.js@7 @pixi/react@7

Usage:

import { BlurFilter } from 'pixi.js';
import { Stage, Container, Sprite, Text } from '@pixi/react';
import { useMemo } from 'react';

export const MyComponent = () =>
{
  const blurFilter = useMemo(() => new BlurFilter(4), []);

  return (
    <Stage options={{ background: 0xffffff }}>
      <Sprite
        image="https://pixijs.io/pixi-react/img/bunny.png"
        x={400}
        y={270}
        anchor={{ x: 0.5, y: 0.5 }}
      />

      <Container x={400} y={330}>
        <Text text="Hello World" anchor={{ x: 0.5, y: 0.5 }} filters={[blurFilter]} />
      </Container>
    </Stage>
  );
};

Docs

Check out our documentation for guides and a full API reference.

Or checkout our examples on codepen for inspiration.

Contribute

Want to contribute to Pixi React? Our contributing guide has you covered.

License

Pixi React is MIT licensed.

This project was originally created and maintained by @inlet. He graciously gave the Pixi team the keys to maintain and push the project forward. Big thanks for all the hard work on making this project so awesome.

This projects codebase was originally forked from @michalochman 's react-pixi-fiber.

Meet fellow developers

You have an amazing feature in mind or just want to get in touch with other developers? Feel free to join our Discord channel.

Join us on Discord