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

    0.14.9 • Public • Published

    Piral Logo

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

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

    The set includes a Hyperapp converter for any component registration, as well as a fromHyperapp shortcut and a HyperappExtension 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.

    fromHyperapp()

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

    HyperappExtension

    The extension slot component to be used in Hyperapp apps.

    Usage

    ::: summary: For pilet authors

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

    Example use:

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

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

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

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

    :::

    ::: summary: For Piral instance developers

    Using Hyperapp with Piral is as simple as installing piral-hyperapp and hyperapp.

    import 'hyperapp';
    import { createHyperappApi } from 'piral-hyperapp';

    The integration looks like:

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

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

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

    :::

    License

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

    Install

    npm i piral-hyperapp

    Homepage

    piral.io

    DownloadsWeekly Downloads

    498

    Version

    0.14.9

    License

    MIT

    Unpacked Size

    29.1 kB

    Total Files

    47

    Last publish

    Collaborators

    • florianrappl