<widget-form>

This webcomponent follows the open-wc recommendation.

Installation

npm i widget-form

Usage

<script type="module">
    import 'widget-form/widget-form.js'
</script>

<widget-form></widget-form>

Expected data format

The following format represents the available data :

data: {
  settings: {
    title: string,
    subTitle: string,
    minGauge: number,
    maxGauge: number,
    style: {
      needleColor: string,
      sections: number,
      backgroundColor: string[]
    }
  }
  gaugeValue: Number
}

Interfaces

interface InputData {
    settings: Settings
    gaugeValue: number
}

interface Settings {
    title: string
    subTitle: string
    minGauge: number
    maxGauge: number
    style: Style
}

interface Style {
    needleColor: string
    sections: number
    backgroundColor: string[]
}

Style options

The following options are available for styling the value graph. The sections option splits the value area into by default three same sized sections. Therefore three different colors can be provided to the backgroundColor by default.

  interface Style {
    needleColor: string,
    sections: number,
    backgroundColor: string[]
  }

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html