piral-react v1.8.2

Piral React ·

This is a plugin that only has a peer dependency to react@>=16 and react-dom@>=16. What piral-react brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

The set includes a React 16+ converter for any component registration, as well as a fromReact shortcut and a ReactExtension component.

By default, these API extensions are not integrated in piral, so you'd need to add them to your Piral instance.

Documentation

The following functions are brought to the Pilet API.

fromReact()

Transforms a standard React 16+ component into a component that can be used in Piral, essentially wrapping it with a reference to the corresponding converter.

ReactExtension

The extension slot component to be used in React 16+ components.

Usage

::: summary: For pilet authors

You can use the fromReact function from the Pilet API to convert your React 16+ components to components usable by your Piral instance.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import { ReactPage } from './ReactPage';

export function setup(piral: PiletApi) {
  piral.registerPage('/sample', piral.fromReact(ReactPage));
}

Within React 16+ components the Piral React 16+ extension component can be used by referring to ReactExtension, e.g.,

<ReactExtension name="name-of-extension" />

Alternatively, if piral-react has not been added to the Piral instance you can install and use the package also from a pilet directly.

import { PiletApi } from '<name-of-piral-instance>';
import { fromReact } from 'piral-react/convert';
import { ReactPage } from './ReactPage';

export function setup(piral: PiletApi) {
  piral.registerPage('/sample', fromReact(ReactPage));
}

:::

::: summary: For Piral instance developers

Using React 16+ with Piral is as simple as installing piral-react and react. For react add the following two packages to your project's dependencies:

{
  "dependencies": {
    "react`": "^18",
    "react-dom": "^18"
  }
}

Now you are ready to use the piral-react converter:

import { createReactApi } from 'piral-react';

The integration looks like:

const instance = createInstance({
  // important part
  plugins: [createReactApi()],
  // ...
});

The react package (or whatever alias you've chosen) should be shared with the pilets via the package.json:

{
  "importmap": {
    "imports": {
      "react": ""
    }
  }
}

:::

License

Piral is released using the MIT license. For more information see the license file.