Piral Million ·

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

The set includes a Million converter for any component registration, as well as a fromMillion shortcut and a MillionExtension 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.

fromMillion()

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

MillionExtension

The extension slot component to be used in Million component.

Usage

::: summary: Modern Use (recommended)

The recommended way is to use piral-million from your pilets. In this case, no registration in the Piral instance is required.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import { fromMillion } from 'piral-million/convert';
import { MillionPage } from './MillionPage';

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

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

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

:::

::: summary: Legacy Use

For backwards compatibility, you can also install piral-million in your Piral instance.

Using Million with Piral is as simple as installing piral-million and million@^1.

import { createMillionApi } from 'piral-million';

The integration looks like:

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

The million package and its million/react module should be shared with the pilets via the package.json:

{
  "importmap": {
    "imports": {
      "million": "",
      "million/react": ""
    }
  }
}

:::

License

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