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

1.5.3 • Public • Published

Piral Logo

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

The set includes an Aurelia converter for any component registration, as well as a fromAurelia shortcut and a AureliaExtension 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.

fromAurelia()

Transforms a standard Aurelia component (View Model) into a component that can be used in Piral, essentially wrapping it with a reference to the corresponding converter.

AureliaExtension

The extension slot component to be used in Aurelia component. This is not really needed, as it is made available automatically via an Aurelia custom element named extension-component.

Usage

::: summary: For pilet authors

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

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import { AureliaPage } from './AureliaPage';

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

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

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

Alternatively, if piral-aurelia 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 { fromAurelia } from 'piral-aurelia/convert';
import { AureliaPage } from './AureliaPage';

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

:::

::: summary: For Piral instance developers

Using Aurelia with Piral is as simple as installing piral-aurelia and aurelia-framework together with the following Aurelia packages:

  • aurelia-event-aggregator: 1.x
  • aurelia-framework: 1.x
  • aurelia-history-browser: 1.x
  • aurelia-pal-browser: 1.x
  • aurelia-templating-binding: 1.x
  • aurelia-templating-resources: 1.x
import { createAureliaApi } from 'piral-aurelia';

The integration looks like:

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

The aurelia related packages should be shared with the pilets via the package.json:

{
  "importmap": {
    "imports": {
      "aurelia-framework": "",
      "aurelia-templating-binding": "",
      "aurelia-templating-resources": "",
      "aurelia-pal-browser": "",
      "aurelia-event-aggregator": "",
      "aurelia-history-browser": ""
    }
  }
}

:::

License

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

Package Sidebar

Install

npm i piral-aurelia

Homepage

piral.io

Weekly Downloads

477

Version

1.5.3

License

MIT

Unpacked Size

46 kB

Total Files

47

Last publish

Collaborators

  • florianrappl