piral-dashboard
Advanced tools
Comparing version 0.9.0-pre.763 to 0.9.0-pre.765
@@ -15,3 +15,3 @@ import { ComponentType } from 'react'; | ||
/** | ||
* Available configuration options for the dashboard extension. | ||
* Available configuration options for the dashboard plugin. | ||
*/ | ||
@@ -31,4 +31,4 @@ export interface DashboardConfig { | ||
/** | ||
* Creates a new Piral API extension for activating dashboard support. | ||
* Creates the Pilet API extension for activating dashboard support. | ||
*/ | ||
export declare function createDashboardApi(config?: DashboardConfig): Extend<PiletDashboardApi>; |
@@ -23,3 +23,3 @@ "use strict"; | ||
/** | ||
* Creates a new Piral API extension for activating dashboard support. | ||
* Creates the Pilet API extension for activating dashboard support. | ||
*/ | ||
@@ -26,0 +26,0 @@ function createDashboardApi(config = {}) { |
{ | ||
"name": "piral-dashboard", | ||
"version": "0.9.0-pre.763", | ||
"description": "Extensions for a centralized dashboard in Piral.", | ||
"version": "0.9.0-pre.765", | ||
"description": "Plugin for creating a centralized dashboard in Piral.", | ||
"keywords": [ | ||
@@ -12,3 +12,3 @@ "piral", | ||
"api", | ||
"extension", | ||
"plugin", | ||
"dashboard", | ||
@@ -40,3 +40,3 @@ "tiles" | ||
"devDependencies": { | ||
"piral-core": "^0.9.0-pre.763" | ||
"piral-core": "^0.9.0-pre.765" | ||
}, | ||
@@ -46,3 +46,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "244d493ecf0c7986e549b0ee2fe48feb20c52cd9" | ||
"gitHead": "81e14b202558d9c3bcf2f8bfdf0b758d0b4b1043" | ||
} |
@@ -5,6 +5,4 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io) | ||
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`. | ||
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`. | ||
By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
## Documentation | ||
@@ -14,4 +12,12 @@ | ||
(tbd) | ||
### `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 | ||
@@ -18,0 +24,0 @@ |
@@ -20,3 +20,3 @@ import * as actions from './actions'; | ||
/** | ||
* Available configuration options for the dashboard extension. | ||
* Available configuration options for the dashboard plugin. | ||
*/ | ||
@@ -59,3 +59,3 @@ export interface DashboardConfig { | ||
/** | ||
* Creates a new Piral API extension for activating dashboard support. | ||
* Creates the Pilet API extension for activating dashboard support. | ||
*/ | ||
@@ -62,0 +62,0 @@ export function createDashboardApi(config: DashboardConfig = {}): Extend<PiletDashboardApi> { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
32936
71