Sixphere Polaris - Numeric Display Web Component

Injectable custom element to display a number. It's based on Sixphere LitElement. You can use Sixphere DIWrapper library to inject a service.

Install

npm install '@sixphere-polaris/numeric-display-wc' --save

HTML API

Attributes

| Attribute | Values | Description | |-----------|--------------------------------------------------------|-------------------------------------------------------------------------------------------| | title | [Optional] String | Title displayed below the indicator. | | value | [Optional] Number | Data shown in the indicator. You must inject a service if this attribute is not provided. | | min | [Optional] Number - default: -Infinity | Low boundary. | | max | [Optional] Number - default: +Infinity | High boundary. | | status | [Optional] String (success | warning | danger) | Display color based on bootstrap colors. |

How to use?

Register as a custom element

import {PolarisNumericDisplay} from '@sixphere-polaris/numeric-display-wc'

customElements.define(PolarisNumericDisplay.is, PolarisNumericDisplay)

Inject a service using DIWrapper

PolarisNumericDisplay implements the API proposed by DIWrapper library. You can use DIWrapper to inject a service which implements an asynchronous getData method. getData method must returns an object with the following structure:

{
    data: <Number>
}

Injection example:

customElements.define(
    `${PolarisNumericDisplay.is}-injected`, 
    DIWrapper.for(PolarisNumericDisplay).bind([
        {
            constructor: MyService,
            args: []
        }
    ])
)

HTML element

Display a title

<polaris-numeric-display title="MyDisplay"></polaris-numeric-display>

Set a range

<polaris-numeric-display min="2" max="8" value="4"></polaris-numeric-display>

Color it

<polaris-numeric-display value="5" status="danger"></polaris-numeric-display>

Author

Sixphere is not only a group of experienced professionals, that keep a huge amount of knowledge, take care about what and how they do their job. They solve their partner problems in an agile way and are aware of their customer needs through emotional intelligence connections.

Sixphere is a simpler way of understanding IT services, based on a strong and well balanced mix-ture of principles.

License

MIT License © 2019 Sixphere