piral-dashboard
Version:
Plugin for creating a centralized dashboard in Piral.
27 lines (26 loc) • 774 B
TypeScript
import { PiralPlugin } from 'piral-core';
import { InitialTile, PiletDashboardApi, TilePreferences } from './types';
/**
* Available configuration options for the dashboard plugin.
*/
export interface DashboardConfig {
/**
* Sets the routes where a dashboard should be displayed.
* @default ['/']
*/
routes?: Array<string>;
/**
* Sets the tiles to be given by the app shell.
* @default []
*/
tiles?: Array<InitialTile>;
/**
* Sets the default preferences to be used.
* @default {}
*/
defaultPreferences?: TilePreferences;
}
/**
* Creates the Pilet API extension for activating dashboard support.
*/
export declare function createDashboardApi(config?: DashboardConfig): PiralPlugin<PiletDashboardApi>;