This is a plugin that only has a peer dependency to piral-core
. What piral-menu
brings to the table is a set of Pilet API extensions that can be used with piral
or piral-core
to bring a simplified menu integration from your pilets to your Piral instance.
Documentation
The following functions are brought to the Pilet API.
Adds the definition of a menu item to the app shell. Optionally specifies the type of menu where the item should be shown.
If the first argument is a string a named menu item is registered. A named menu item can also be removed.
Removes a menu item from the app shell. This requires a named menu item.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createMenuApi
from the piral-menu
package.
import { createMenuApi } from 'piral-menu';
The integration looks like:
const instance = createInstance({
extendApi: [createMenuApi()],
});
Via the options the defaultSettings
and the global / initially available menu items
can be defined.
For example:
const instance = createInstance({
extendApi: [createMenuApi({
defaultSettings: {
type: 'admin',
},
items: [
{
component: HomeMenuItem,
},
],
})],
});
License
Piral is released using the MIT license. For more information see the license file.