0.5.0-rc1 • Published 6 years ago

@argus-dashboard/components v0.5.0-rc1

Weekly downloads
-
License
ISC
Repository
github
Last release
6 years ago

Argus

Build Status Coverage Status

Argus is a Grid based Dashboard Framework.

Installation

npm install @argus-dashboard/components

You will also need the express app with Socket.io communication features:

npm install @argus-dashboard/server

Configuration

A file with the Dashboard configuration is needed:

const config = [
  {
    title: "My Dashboard",
    rows: 3,
    columns: 3,
    widgets: [
      {
        extension: 'my-extension',
        name: 'MyWidget',
        title: 'Widget Title',
        x: 0,
        y: 0,
        rows: 1,
        columns: 1,
        interval: 0
      }
    ]
  }
];

export default config;

Config File - Dashboard

ParameterDescriptionType
TitleDashboard title shown in the headerString (must be unique)
Rows/ColumnsDashboard sizeInteger
WidgetsShown WidgetsArray

Config File - Widgets

ParameterDescriptionType
ExtensionName of the extension the widget belongs toString (must be unique)
NameWidget nameString
TitleTitle shown in the widget headerString
X/YWidget positionInteger
Rows/ColumnsWidget sizeInteger
IntervalInterval in which the widget will be notified of new dataInteger. Can also be 'once'