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

    0.14.9 • Public • Published

    Piral Logo

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

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

    The set includes an Angular.js converter for any component registration, as well as a fromNgjs shortcut and a NgjsExtension 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.

    fromNgjs()

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

    NgjsExtension

    The extension slot module to be referenced in Angular.js module definitions. Allows using an Angular.js custom element named extension-component.

    Usage

    ::: summary: For pilet authors

    You can use the fromNgjs function from the Pilet API to convert your Angular.js modules to components usable by your Piral instance.

    Example use:

    import { PiletApi } from '<name-of-piral-instance>';
    import { createAngularJsPage } from './AngularJsPage';
    
    export function setup(piral: PiletApi) {
      const AngularJsPage = createAngularJsPage(piral.NgjsExtension.name);
      piral.registerPage('/sample', piral.fromNgjs(AngularJsPage));
    }

    Within Angular.js components the Piral Angular.js extension component can be used by referring to NgjsExtension, e.g.,

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

    Alternatively, if piral-ngjs 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 { fromNgjs, createNgjsExtension } from 'piral-ngjs/convert';
    import { createAngularJsPage } from './AngularJsPage';
    
    export function setup(piral: PiletApi) {
      const Extension = createNgjsExtension();
      const AngularJsPage = createAngularJsPage(Extension.name);
      piral.registerPage('/sample', fromNgjs(AngularJsPage));
    }

    :::

    ::: summary: For Piral instance developers

    The provided library only brings API extensions for pilets to a Piral instance. The Piral instance still needs to be configured properly to support Angular.js 1.x.

    For the setup itself you'll need to import createNgjsApi from the piral-ngjs package.

    import { createNgjsApi } from 'piral-ngjs';

    The integration looks like:

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

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

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

    :::

    License

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

    Install

    npm i piral-ngjs

    Homepage

    piral.io

    DownloadsWeekly Downloads

    463

    Version

    0.14.9

    License

    MIT

    Unpacked Size

    26.3 kB

    Total Files

    40

    Last publish

    Collaborators

    • florianrappl