This is plugin that only has a peer dependency to piral-core
. What piral-dashboard
brings to the table is a set of Pilet API extensions that can be used with piral
or piral-core
.
Documentation
The following functions are brought to the Pilet API.
registerTile()
Adds the definition of a tile to the app shell. Optionally specifies display characteristics like the initial rows, initial columns, or if the tile can be resized by the user.
If the first argument is a string a named tile is registered. A named tile can also be removed.
unregisterTile()
Removes a tile from the app shell. This requires a named tile.
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 createDashboardApi
from the piral-dashboard
package.
import { createDashboardApi } from 'piral-dashboard';
The integration looks like:
const instance = createInstance({
extendApi: [createDashboardApi()],
});
Via the options the defaultPreferences
and the global / initially available tiles
can be defined.
Consider for example:
const instance = createInstance({
extendApi: [createDashboardApi({
defaultPreferences: {
initialColumns: 2,
initialRows: 2,
resizable: true,
},
tiles: [
{
component: MyTeaserTile,
preferences: {
initialColumns: 2,
initialRows: 4,
},
},
],
})],
});
License
Piral is released using the MIT license. For more information see the license file.