piral-react-15
TypeScript icon, indicating that this package has built-in type declarations

1.5.3 • Public • Published

Piral Logo

This is a plugin that only has a peer dependency to react@^15 and react-dom@^15. What piral-react-15 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 15.x converter for any component registration, as well as a fromReact15 shortcut and a React15Extension 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.

fromReact15()

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

React15Extension

The extension slot component to be used in React 15.x components.

Usage

::: summary: For pilet authors

You can use the fromReact15 function from the Pilet API to convert your React v15 components to components usable by your Piral instance.

Example use:

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

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

Within React v15 components the Piral React v15 extension component can be used by referring to React15Extension, e.g.,

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

Alternatively, if piral-react-15 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 { fromReact15 } from 'piral-react-15/convert';
import { React15Page } from './React15Page';

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

:::

::: summary: For Piral instance developers

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

{
  "dependencies": {
    "react-15`": "npm:react@^15",
    "react-dom-15": "npm:react@^15"
  }
}

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

import { createReact15Api } from 'piral-react-15';

The integration looks like:

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

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

{
  "importmap": {
    "imports": {
      "react-15": ""
    }
  }
}

:::

License

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

Package Sidebar

Install

npm i piral-react-15

Homepage

piral.io

Weekly Downloads

227

Version

1.5.3

License

MIT

Unpacked Size

34.5 kB

Total Files

48

Last publish

Collaborators

  • florianrappl