This is an extension library that only has a peer dependency to piral-core
. What piral-dashboard
brings to the table is a set of API extensions that can be used with piral
or piral-core
.
By default, these 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.
(tbd)
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.