piral-inferno
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 inferno. What piral-inferno brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

The set includes an Inferno converter for any component registration, as well as a fromInferno shortcut and a InfernoExtension 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.

fromInferno()

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

InfernoExtension

The extension slot component to be used in Inferno components.

Usage

::: summary: For pilet authors

You can use the fromInferno function from the Pilet API to convert your Inferno components to components usable by your Piral instance.

Example use:

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

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

Within Inferno components the Piral Inferno extension component can be used by referring to InfernoExtension, e.g.,

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

Alternatively, if piral-inferno 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 { fromInferno } from 'piral-inferno/convert';
import { InfernoPage } from './InfernoPage';

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

:::

::: summary: For Piral instance developers

Using Inferno with Piral is as simple as installing piral-inferno and the Inferno packages:

  • inferno
  • inferno-create-element
import { createInfernoApi } from 'piral-inferno';

The integration looks like:

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

The inferno and inferno-create-element package should be shared with the pilets via the package.json:

{
  "importmap": {
    "imports": {
      "inferno": "",
      "inferno-create-element": ""
    }
  }
}

:::

License

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

Package Sidebar

Install

npm i piral-inferno

Homepage

piral.io

Weekly Downloads

704

Version

1.5.3

License

MIT

Unpacked Size

34.3 kB

Total Files

47

Last publish

Collaborators

  • florianrappl