@startinblox/component-dashboard
v7.0.4
Published
Dashboard component for startinblox
Downloads
17
Keywords
Readme
Solid Dashboard
<solid-dashboard>
is a Sib component to generate dashboard from LDP datas.
Installation
In your django project, add the djangoldp_dashboard
package:
# packages.yml
## DjangoLDP packages ##
ldppackages:
djangoldp_dashboard: djangoldp_dashboard
Then, run in your shell :
pip install djangoldp_dashboard
If everything work correctly, you should be able to see the package in your Django Admin.
Then you have to load the initialisation data to make it work.
How to use
Once the package is installed, you can use the solid-dashboard
component:
<html>
<head>
<script type="module" src="https://cdn.jsdelivr.net/npm/@startinblox/core/+esm"></script>
<script type="module" src="https://cdn.skypack.dev/@startinblox/component-dashboard/"></script>
</head>
<body>
<!-- use the component -->
<solid-dashboard
data-src="[url]">
</solid-dashboard>
</body>
</html>
Notes that the "[url]" should be replace by your code fragment api link.
Having multiple dashboard
You can use multiple dashboard on your application by using the target
discriminator.
It expect the card to have a matching target
.
Card background
A card can have a background
valued as a boolean.
If background is false
, then the card will show a transparent background with no border box.
Parameters
| Name | Default | Description |
| --------------- | ---------------------- | :----------------------------------------------------------- |
| data-src
| undefined
| URL of the dashboards endpoint. |
| target
| default
| Name of the dashboard to show. |
Developpers
Installation:
npm install
Build with:
npm run build
Watch files & rebuild on change with this command:
npm run watch