https://github.com/recordevolution/widget-form
Widget for data entry in IronFlock dashboards
https://github.com/recordevolution/widget-form
Last synced: 7 months ago
JSON representation
Widget for data entry in IronFlock dashboards
- Host: GitHub
- URL: https://github.com/recordevolution/widget-form
- Owner: RecordEvolution
- Created: 2025-06-23T14:59:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-07-10T14:33:48.000Z (7 months ago)
- Last Synced: 2025-07-10T19:59:27.891Z (7 months ago)
- Language: TypeScript
- Size: 401 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# \
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i widget-form
```
## Usage
```html
import 'widget-form/widget-form.js'
```
## Expected data format
The following format represents the available data :
```js
data: {
settings: {
title: string,
subTitle: string,
minGauge: number,
maxGauge: number,
style: {
needleColor: string,
sections: number,
backgroundColor: string[]
}
}
gaugeValue: Number
}
```
## Interfaces
```ts
interface InputData {
settings: Settings
gaugeValue: number
}
```
```ts
interface Settings {
title: string
subTitle: string
minGauge: number
maxGauge: number
style: Style
}
```
```ts
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
```bash
npm run lint
```
To automatically fix linting and formatting errors, run
```bash
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`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`