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

    0.14.8 • Public • Published

    Piral Logo

    Piral Preact · GitHub License npm version tested with jest Gitter Chat

    This is a plugin that only has a peer dependency to piral-core. 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: For pilet authors

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

    Example use:

    import { PiletApi } from '<name-of-piral-instance>';
    import { PreactPage } from './PreactPage';
    
    export function setup(piral: PiletApi) {
      piral.registerPage('/sample', piral.fromPreact(PreactPage));
    }

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

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

    Alternatively, if piral-preact 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 { fromPreact } from 'piral-preact/convert';
    import { PreactPage } from './PreactPage';
    
    export function setup(piral: PiletApi) {
      piral.registerPage('/sample', fromPreact(PreactPage));
    }

    :::

    ::: summary: For Piral instance developers

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

    import 'preact';
    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:

    {
      "pilets": {
        "externals": [
          "preact"
        ]
      }
    }

    :::

    License

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

    Install

    npm i piral-preact

    Homepage

    piral.io

    DownloadsWeekly Downloads

    207

    Version

    0.14.8

    License

    MIT

    Unpacked Size

    32.7 kB

    Total Files

    47

    Last publish

    Collaborators

    • florianrappl