Piral Preact ·

This is a plugin that only has a peer dependency to preact. What piral-preact brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

The set includes a Preact converter for any component registration, as well as a fromPreact shortcut and a PreactExtension 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.

fromPreact()

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

PreactExtension

The extension slot component to be used in Preact component.

Usage

::: summary: Modern Use (recommended)

The recommended way is to use piral-preact from your pilets. In this case, no registration in the Piral instance is required.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import { fromPreact } from 'piral-preact/convert';
import { PreactPage } from './PreactPage';

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

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

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

:::

::: summary: Legacy Use

For backwards compatibility, you can also install piral-preact in your Piral instance.

Using Preact with Piral is as simple as installing piral-preact and preact@^10.

import { createPreactApi } from 'piral-preact';

The integration looks like:

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

The preact package should be shared with the pilets via the package.json:

{
  "importmap": {
    "imports": {
      "preact": ""
    }
  }
}

:::

License

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