Skip to content

Commit

Permalink
Modular Packages (#407)
Browse files Browse the repository at this point in the history
* rollup config tweaks

* package tweaks

* clean up animated package

* split out invariant util into its own package

* split out react-components package

* split out react-reconciler into react-fiber package

* add react-modular package to wire everything together

* update main pixi-react package to be a wrapper for other modules

* codesandbox ci tweaks

---------

Co-authored-by: Alex Prokop <[email protected]>
  • Loading branch information
baseten and Alex Prokop authored Mar 13, 2023
1 parent c565745 commit f277550
Show file tree
Hide file tree
Showing 118 changed files with 36,934 additions and 50,749 deletions.
4 changes: 4 additions & 0 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"buildCommand": "build:force",
"packages": [
"packages/react-invariant",
"packages/react-components",
"packages/react-fiber",
"packages/react-modular",
"packages/react",
"packages/animated"
],
Expand Down
82,440 changes: 33,138 additions & 49,302 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
"@react-spring/types": "^9.6.1",
"react": "^18.0.0",
"react-dom": "^18.0.0",
"react-reconciler": "0.29.0",
"react-spring": "^9.6.1"
},
"devDependencies": {
Expand Down
6 changes: 2 additions & 4 deletions packages/animated/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@
"test:watch": "jest --watch"
},
"sideEffects": false,
"dependencies": {
"@pixi/react": "^7.0.2"
},
"devDependencies": {
"@pixi/react": "*",
"@pixi/app": "^7.1.1",
"@pixi/core": "^7.1.1",
"@pixi/display": "^7.1.1",
Expand All @@ -57,7 +55,7 @@
"@pixi/math": ">=7.0.0",
"@pixi/mesh-extras": ">=7.0.0",
"@pixi/particle-container": ">=7.0.0",
"@pixi/react": "*",
"@pixi/react": ">=7.0.0",
"@pixi/sprite": ">=7.0.0",
"@pixi/sprite-animated": ">=7.0.0",
"@pixi/sprite-tiling": ">=7.0.0",
Expand Down
44 changes: 22 additions & 22 deletions packages/animated/rollup.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@ import { getRollupConfig, isProductionBuild } from '../../shared/getRollupConfig

const buildType = isProductionBuild() ? '' : '-dev';

const external = [
'@pixi/react',
'@pixi/app',
'@pixi/core',
'@pixi/display',
'@pixi/graphics',
'@pixi/math',
'@pixi/mesh-extras',
'@pixi/text',
'@pixi/text-bitmap',
'@pixi/ticker',
'@pixi/sprite',
'@pixi/sprite-tiling',
'@pixi/sprite-animated',
'@pixi/particle-container',
'@react-spring/animated',
'react',
'react-dom',
'react-spring'
];

const builds = ['cjs', 'es'].map(
(format) => getRollupConfig(
`dist/index.${format}${buildType}.js`,
format,
{
external: [
'@pixi/react',
'@pixi/app',
'@pixi/core',
'@pixi/display',
'@pixi/graphics',
'@pixi/math',
'@pixi/mesh-extras',
'@pixi/text',
'@pixi/text-bitmap',
'@pixi/ticker',
'@pixi/sprite',
'@pixi/sprite-tiling',
'@pixi/sprite-animated',
'@pixi/particle-container',
'@react-spring/animated',
'react',
'react-dom',
'react-spring'
]
}
{ external }
)
);

Expand Down
2 changes: 1 addition & 1 deletion packages/animated/test/__snapshots__/index.spec.js.snap
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`index export modules for react-spring 1`] = `
exports[`index export modules for react-animated 1`] = `
{
"AnimatedSprite": {
"$$typeof": Symbol(react.forward_ref),
Expand Down
4 changes: 2 additions & 2 deletions packages/animated/test/index.spec.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import * as index from '../src/index';
import * as index from '../src';

describe('index', () =>
{
test('export modules for react-spring', () =>
test('export modules for react-animated', () =>
{
expect(index).toMatchSnapshot();
});
Expand Down
115 changes: 115 additions & 0 deletions packages/react-components-pixi-7/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/232559/142733492-3c106f68-8b8e-459c-95f9-aca77561d438.png" alt="pixi-react" width="310" />
</p>

<h1 align="center">
Pixi React
</h1>

<p align="center">
<strong>Simply the best way to write PIXI applications in React</strong>
<br />
<sub>Write <a href="http://www.pixijs.com/">PIXI</a> applications using React declarative style 👌</sub>
</p>

<br />

<p align="center">
<img src="https://img.shields.io/github/v/release/pixijs/pixi-react" alt="release" />
<img src="https://img.shields.io/npm/dm/@pixi/react" alt="downloads" />
<img src="https://img.shields.io/circleci/project/github/pixijs/pixi-react/master.svg" alt="ci tests" />
<img src="https://img.shields.io/badge/license-MIT-green.svg" alt="license" />
<img src="https://img.shields.io/badge/react-latest-ff69b4.svg" alt="react version" />
<img src="https://img.shields.io/badge/pixi-v6+-ff69b4.svg" alt="pixi version" />
</p>

<br />

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

## News!

We're delighted to announce Pixi React v7.0.0, the first major release since making it an official Pixi package!

While all the core components remain the same, there have been some significant changes under the hood:

* Full React 18 support including a new `createRoot` API, matching the signature of [React 18's `ReactDOM/client`](https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html#updates-to-client-rendering-apis)
* Full Pixi V7 support
* New up-to-date [docs site](https://pixijs.io/pixi-react/)
* Repository converted to a monorepo with separate [`@pixi/react`](https://www.npmjs.com/package/@pixi/react) and [`@pixi/animated`](https://www.npmjs.com/package/@pixi/react-animated) packages
* Internally all `pixi.js` library imports were replaced with `@pixi/` scoped package versions, providing bundlesize improvements for users who use modular builds
* Scoped imports allowed us to remove `@pixi/react-legacy` and `@pixi/react-animated-legacy` packages, with rendering deferred to a user's installed `pixi.js` package
* `sideEffects: false` added to `package.json` to support tree-shaking

We're excited to see what the community builds with the library and as ever please let us know on [GitHub](https://github.com/pixijs/pixi-react/issues) if you run into any issues, or reach out to us on the [Discord](https://discord.com/channels/734147990985375826/968068526566965279) to chat.

Thanks!
PixiJS Team

## Get started

### Quick start

If you want to start a new React project from scratch, we recommend [Create React App](https://github.com/facebook/create-react-app).
To add to an existing React application, just install the dependencies:

#### Start New React Project "my-app" with Create React App:
```bash
# for typescript add "--template typescript"
npx create-react-app my-app
cd my-app
```

#### Install Pixi React Dependencies:
```bash
npm install pixi.js @pixi/react
```

#### Usage:
```jsx
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>
<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](https://pixijs.io/pixi-react/) for guides and a full API reference.

Or checkout [our examples](https://codepen.io/collection/XPpGdb) on codepen for inspiration.

## Contribute

Want to contribute to Pixi React? Our [contributing guide](/CONTRIBUTING.md) has you covered.

## License

Pixi React is MIT licensed.

This projects codebase was originally forked from @michalochman 's [react-pixi-fiber](https://github.com/michalochman/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](https://discord.gg/zqbXQAADuM)
Loading

0 comments on commit f277550

Please sign in to comment.