piral-mithril
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 mithril. What piral-mithril brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

The set includes a Mithril.js converter for any component registration, as well as a fromMithril shortcut and a MithrilExtension 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.

fromMithril()

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

MithrilExtension

The extension slot component to be used in Mithril.js component.

Usage

::: summary: For pilet authors

You can use the fromMithril function from the Pilet API to convert your Mithril.js components to components usable by your Piral instance.

Example use:

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

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

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

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

Alternatively, if piral-mithril 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 { fromMithril } from 'piral-mithril/convert';
import { MithrilPage } from './MithrilPage';

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

:::

::: summary: For Piral instance developers

Using Mithril.js with Piral is as simple as installing piral-mithril and mithril@^2.

import { createMithrilApi } from 'piral-mithril';

The integration looks like:

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

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

{
  "importmap": {
    "imports": {
      "mithril": ""
    }
  }
}

:::

License

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

Package Sidebar

Install

npm i piral-mithril

Homepage

piral.io

Weekly Downloads

374

Version

1.5.3

License

MIT

Unpacked Size

25.9 kB

Total Files

40

Last publish

Collaborators

  • florianrappl