@react-pixi-fiber/react-17 0.0.0-stage → 1.0.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @react-pixi-fiber/react-17
+
+## 1.0.0-beta.0
+
+### Patch Changes
+
+- First beta. No new features are planned before the stable release. The API changes only to fix a problem found in use.
+
+## 1.0.0-alpha.0
+
+### Major Changes
+
+- [#377](https://github.com/michalochman/react-pixi-fiber/pull/377) [`b5e5be4`](https://github.com/michalochman/react-pixi-fiber/commit/b5e5be46120e80ee101f87775d857a7e190cd633) Thanks [@michalochman](https://github.com/michalochman)! - Initial release. The React 17 adapter for React 17.0.2 or a later 17.x. It bundles `react-reconciler` 0.26.2 and renders on a legacy root, as 2.x did; `react17({ root: "concurrent" })` renders on the experimental concurrent root of React 17 instead.
+
+### Patch Changes
+
+- Updated dependencies [[`446f761`](https://github.com/michalochman/react-pixi-fiber/commit/446f7619b852df4ffdf432d5c032e837f21968ee)]:
+  - react-pixi-fiber@3.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Michał Ochman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,31 @@
-# Temporary Holding Version
+# @react-pixi-fiber/react-17
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm](https://img.shields.io/npm/v/@react-pixi-fiber/react-17.svg)](https://npmjs.com/package/@react-pixi-fiber/react-17)
+
+React 17 adapter for [react-pixi-fiber](https://github.com/KalambaGames/react-pixi-fiber). It bundles `react-reconciler` 0.26.2 and builds the renderer that `react-pixi-fiber` uses to render PixiJS Display Objects. It needs React 17.0.2 or a later 17.x, the peer range of that `react-reconciler`.
+
+Install it next to `react-pixi-fiber`, `react` 17 and a PixiJS adapter from the [adapter table](../react-pixi-fiber/README.md#setup), then configure once in the app entry, before the first render:
+
+```js
+import { configure } from "react-pixi-fiber";
+import react17 from "@react-pixi-fiber/react-17";
+import pixiN from "@react-pixi-fiber/pixi-N"; // the PixiJS adapter for your PixiJS version
+
+configure({ react: react17(), pixi: pixiN() });
+```
+
+The tree renders on a legacy root, as 2.x did. To render it on the experimental concurrent root of React 17, as `unstable_createRoot` does, pass `react17({ root: "concurrent" })`.
+
+## Supported features
+
+The tree inside `Stage`, or inside a container passed to `render`, is its own React root. Features that are plain React work as the [React 17 documentation](https://legacy.reactjs.org/docs/getting-started.html) describes.
+
+| Feature | Support |
+| --- | --- |
+| Context, error boundaries, hooks, refs | Supported. A ref on a tag receives the PixiJS Display Object |
+| Concurrent features | With `root: "concurrent"`, experimental, as concurrent mode is in React 17: `render` commits synchronously and later updates are scheduled by React. As with `unstable_createRoot`, the whole tree is in strict mode, so React renders each component twice in development. An update from a PixiJS event handler does not get the priority of its DOM event. With the default `root: "legacy"`, not available: the root is a legacy root, as `ReactDOM.render` creates |
+| DevTools | The renderer registers with React DevTools as `react-pixi-fiber` in development |
+| Errors while rendering | Thrown from `render` and caught by error boundaries, as in React 17 |
+| `<StrictMode>` | Development prop validation runs under a `<StrictMode>` ancestor (React 17 mode bit `1`). On a concurrent root the whole tree is in strict mode, so it always runs |
+| `<Suspense>` | Supported. A suspended subtree is hidden with `visible = false` and shown again with its `visible` prop |
+| Text children | Not supported: a string child throws; use the `Text` tag |

package/dist/cjs/react-17.d.ts

@@ -0,0 +1,17 @@
+import { HostOps, ReactAdapter } from "react-pixi-fiber";
+//#region src/index.d.ts
+declare const strictModeBit = 1;
+interface React17Options {
+  /**
+   * The kind of root Stage and `render` create: `"legacy"` (the default) commits every update synchronously, as 2.x
+   * did; `"concurrent"` is the experimental concurrent mode of React 17.
+   */
+  root?: "concurrent" | "legacy";
+}
+declare function createHostConfig(hostOps: HostOps): Record<string, unknown>;
+declare function react17({ root }?: React17Options): ReactAdapter;
+//#endregion
+declare namespace react17 {
+  export { React17Options, createHostConfig, react17 as default, strictModeBit };
+}
+export = react17;