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

    0.14.7 • Public • Published

    Piral Logo

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

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

    The set includes a Solid converter for any component registration, as well as a fromSolid shortcut and a SolidExtension 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.

    fromSolid()

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

    SolidExtension

    The extension slot component to be used in Solid components.

    Usage

    ::: summary: For pilet authors

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

    Example use:

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

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

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

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

    :::

    ::: summary: For Piral instance developers

    Using Solid with Piral is as simple as installing piral-solid and solid-js.

    import { createSolidApi } from 'piral-solid';

    The integration looks like:

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

    The solid-js and solid-js/dom packages should be shared with the pilets via the package.json:

    {
      "pilets": {
        "externals": [
          "solid-js",
          "solid-js/dom"
        ]
      }
    }

    :::

    License

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

    Install

    npm i piral-solid

    Homepage

    piral.io

    DownloadsWeekly Downloads

    288

    Version

    0.14.7

    License

    MIT

    Unpacked Size

    22.5 kB

    Total Files

    40

    Last publish

    Collaborators

    • florianrappl