Piral Menu ·

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.
registerMenu()
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.
unregisterMenu()
Removes a menu item from the app shell. This requires a named menu item.
Usage
::: summary: For pilet authors
You can use the registerMenu
function from the Pilet API to add a new menu item in the app shell.
Note: When the first argument is a string we call it a named menu item.
Example use:
;;
You can use the unregisterMenu
function from the Pilet API to remove a previously added menu item from the app shell.
Note: You'll need to have added a named menu item in order to be able to remove it.
Example use:
;;
:::
::: summary: For Piral instance developers
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.
;
The integration looks like:
;
Via the options the defaultSettings
and the global / initially available menu items
can be defined.
For example:
;
Customizing
You can customize the available dialogs and their options.
; declare // now registerMenu(() => null, { category: 'general' }) is strongly typed in pilets
You can also add new types to the type
selection.
; declare // now registerMenu(() => null, { type: 'left-footer' }) is strongly typed in pilets
:::
License
Piral is released using the MIT license. For more information see the license file.