Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/palerdot/svelte-speedometer
Svelte component for showing speedometer like gauge using d3
https://github.com/palerdot/svelte-speedometer
Last synced: about 2 months ago
JSON representation
Svelte component for showing speedometer like gauge using d3
- Host: GitHub
- URL: https://github.com/palerdot/svelte-speedometer
- Owner: palerdot
- Created: 2020-03-29T17:24:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T08:06:02.000Z (5 months ago)
- Last Synced: 2024-10-13T23:30:57.814Z (2 months ago)
- Language: JavaScript
- Homepage: https://palerdot.in/svelte-speedometer/
- Size: 2.89 MB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-svelte - svelte-speedometer - Svelte component for showing speedometer like gauge using d3. (UI Components / Miscellaneous)
- trackawesomelist - svelte-speedometer (⭐16) - Svelte component for showing speedometer like gauge using d3. (Recently Updated / [Oct 27, 2024](/content/2024/10/27/README.md))
README
# svelte-speedometer
**svelte-speedometer** is a svelte component library for showing speedometer like gauge using d3.
[](https://github.com/prettier/prettier)
[](https://github.com/palerdot/svelte-speedometer/actions/workflows/test.yml/badge.svg)
[](https://badge.fury.io/js/svelte-speedometer)
**IMPORTANT:** If you are using `Svelte v5`, please use `v3.0`.`v2.0` is compatible with `Svelte v3 or v4`.
## Usage:
**pnpm**
`pnpm add svelte-speedometer`
**Yarn:**
`yarn add svelte-speedometer`
**NPM:**
`npm install --save svelte-speedometer`
```javascript
// import the component
import Speedometer from "svelte-speedometer"
// and just use it
```
Stackblitz: https://stackblitz.com/edit/svelte-speedometer-svelte-v5
Storybook: https://palerdot.in/svelte-speedometer/?path=/docs/svelte-speedometer--docs
## Ports:
- React: [react-d3-speedometer](https://github.com/palerdot/react-d3-speedometer)
- Vue: [vue-speedometer](https://github.com/palerdot/vue-speedometer)
## Examples:
[Live Examples](https://palerdot.in/svelte-speedometer/)
## Configuration Options:
| prop | type | default | comments |
| ------------|:--------------:| --------:| ---------|
| value | Number | 0 | Make sure your value is between your `minValue` and `maxValue` |
| minValue | Number | 0 | |
| maxValue | Number | 1000 | |
| segments | Number | 5 | Number of segments in the speedometer. Please note, `segments` is calculated with [d3-ticks]() which is an approximate count that is uniformly spaced between min and max. Please refer to [d3-ticks](https://github.com/d3/d3-scale/blob/master/README.md#continuous_ticks) and [d3-array ticks](https://github.com/d3/d3-array#ticks) for more detailed info. |
| maxSegmentLabels | Number | value from 'segments' prop | Limit the number of segment labels to displayed. This is useful for acheiving a gradient effect by giving arbitrary large number of `segments` and limiting the labels with this prop. [See Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--gradient-effect-with-large-number-of-segments-and-maxsegmentlabels-config). Please note, `maxSegmentLabels` is calculated with [d3-ticks]() which is an approximate count that is uniformly spaced between min and max. Please refer to [d3-ticks](https://github.com/d3/d3-scale/blob/master/README.md#continuous_ticks) and [d3-array ticks](https://github.com/d3/d3-array#ticks) for more detailed info. |
| forceRender | Boolean | false | After initial rendering/mounting, when props change, only the `value` is changed and animated to maintain smooth visualization. But, if you want to force rerender the whole component like change in segments, colors, dimensions etc, you can use this option to force rerender of the whole component on props change. |
| width | Number | 300 | **diameter** of the speedometer and the **width** of the svg element |
| height | Number | 300 | height of the svg element. Height of the speedometer is always half the width since it is a **semi-circle**. For fluid width, please refere to `fluidWidth` config |
| dimensionUnit | String | px | Default to `px` for `width/height`. Possible values - `"em" , "ex" , "px" , "in" , "cm" , "mm" , "pt" , ,"pc"` ... Please refer to [specification](https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#Length) for more details |
| fluidWidth | Boolean | false | If `true` takes the width of the parent component. See [Live Example](https://palerdot.in/svelte-speedometer/?selectedKind=React%20d3%20Speedometer&selectedStory=Fluid%20Width%20view&full=0&down=0&left=1&panelRight=0&downPanel=kadirahq%2Fstorybook-addon-actions%2Factions-panel) for more details |
| needleColor | String | steelblue | Should be a valid color code - colorname, hexadecimal name or rgb value. Should be a valid input for [d3.interpolateHsl](https://github.com/d3/d3-interpolate#interpolateHsl) |
| startColor | String | #FF471A | Should be a valid color code - colorname, hexadecimal name or rgb value. Should be a valid input for [d3.interpolateHsl](https://github.com/d3/d3-interpolate#interpolateHsl) |
| endColor | String | #33CC33 | Should be a valid color code - colorname, hexadecimal name or rgb value. Should be a valid input for [d3.interpolateHsl](https://github.com/d3/d3-interpolate#interpolateHsl) |
| segmentColors | Array (of colors) | [] | Custom segment colors can be given with this option. Should be an array of valid color codes. If this option is given **startColor** and **endColor** options will be ignored. |
| needleTransition | String (JS) / Transition (TS) | easeQuadInOut | [d3-easing-identifiers](https://github.com/d3/d3-ease) - easeLinear, easeQuadIn, easeQuadOut, easeQuadInOut, easeCubicIn, easeCubicOut, easeCubicInOut, easePolyIn, easePolyOut, easePolyInOut, easeSinIn, easeSinOut, easeSinInOut, easeExpIn, easeExpOut, easeExpInOut, easeCircleIn, easeCircleOut, easeCircleInOut, easeBounceIn, easeBounceOut, easeBounceInOut, easeBackIn, easeBackOut, easeBackInOut, easeElasticIn, easeElasticOut, easeElasticInOut, easeElastic. There is a helper Object/Type 'Transtion', which you can import like `import { Transition } from 'react-d3-speedometer'` and use it like `Transition.easeElastic`. This works for both JS and Typescript. For `type(script)` definitions, please refer [here](./src/index.d.ts). |
| needleTransitionDuration | Number | 500 | Time in milliseconds. |
| needleHeightRatio | Float (between 0 and 1) | 0.9 | Control the height of the needle by giving a number/float between `0` and `1`. Default height ratio is `0.9`. |
| ringWidth | Number | 60 | Width of the speedometer ring. |
| textColor | String | #666 | Should be a valid color code - colorname, hexadecimal name or rgb value. Used for both showing the current value and the segment values |
| valueFormat | String | | should be a valid format for [d3-format](https://github.com/d3/d3-format#locale_format). By default, no formatter is used. You can use a valid d3 format identifier (for eg: `d` to convert float to integers), to format the values. **Note:** This formatter affects all the values (current value, segment values) displayed in the speedometer |
| segmentValueFormatter | Function | value => value | Custom segment values formatter function. This function is applied after 'valueFormat' prop if present. |
| currentValueText | String | ${value} | Should be provided a string which should have **${value}** placeholder which will be replaced with current value. By default, current value is shown (formatted with `valueFormat`). For example, if current Value is 333 if you would like to show `Current Value: 333`, you should provide a string **`Current Value: ${value}`**. See [Live Example](https://palerdot.in/svelte-speedometer/?selectedKind=svelte-speedometer&selectedStory=Custom%20Current%20Value%20Text&full=0&down=1&left=1&panelRight=0) |
| currentValuePlaceholderStyle | String | ${value} | Should be provided a placeholder string which will be replaced with current value in `currentValueTextProp`. For example: you can use ruby like interpolation by giving following props - ``. This is also helpful if you face `no-template-curly-in-string` eslint warnings and would like to use different placeholder for current value |
| customSegmentStops | Array | [] | Array of values **starting** at `min` value, and **ending** at `max` value. This configuration is useful if you would like to split the segments at custom points or have unequal segments at preferred values. If the values does not begin and end with `min` and `max` value respectively, an error will be thrown. This configuration will override `segments` prop, since total number of segments will be `length - 1` of `customSegmentProps`. For example, `[0, 50, 75, 100]` value will have three segments - `0-50`, `50-75`, `75-100`. See [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--custom-segment-stops) |
| customSegmentLabels | Array`` | [] | Takes an array of `CustomSegmentLabel` objects. Each object has following keys for custom rendering of labels - `text`, `fontSize`, `color`, `position: OUTSIDE/INSIDE`. For `position`, there is a helper `CustomSegmentLabelPosition` Object/Type which you can import like `import { CustomSegmentLabelPosition } from 'react-d3-speedometer'`, and use it like `CustomSegmentLabelPosition.Inside / CustomSegmentLabelPosition.Outside`. This works for both JS and Typescript. For `type(script)` definitions, please refer [here](./src/index.d.ts). |
| labelFontSize | String | 14px | Font size for segment labels/legends |
| valueTextFontSize | String | 16px | Font size for current value text |
| valueTextFontWeight | String | bold | Font weight for current value text. Any valid font weight identifier (500, bold etc) can be used. |
| paddingHorizontal | Number | 0 | Provides right/left space for the label text. Takes a number (without explicit unit, unit will be taken from dimensionUnit config which defaults to px). Helpful when using a bigger font size for label texts. |
| paddingVertical | Number | 0 | Provides top/bottom space for the current value label text below the needle. Takes a number (without explicit unit, unit will be taken from dimensionUnit config which defaults to px). Helpful when using a bigger font size for label texts. |
## Examples
You can view [Live Examples here](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--default-with-no-config)
#### Default with no config - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--default-with-no-config)
```javascript
```
#### With configurations - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--configuring-values)
```javascript
```
#### Custom Segment Colors - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--custom-segment-colors)
```javascript
```
#### Custom Segment Labels - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/Speedometer--custom-segment-labels)
```javascript
// 'customSegmentLabels' prop takes an array of 'CustomSegmentLabel' Object
/*
type CustomSegmentLabel = {
text?: string
position?: OUTSIDE/INSIDE
fontSize?: string
color?: string
}
*/
```
#### Custom Segment Stops - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--custom-segment-stops)
```javascript
// `segments` prop will be ignored since it will be calculated from `customSegmentStops`
// In this case there will be `4` segments (0-500, 500-750, 750-900, 900-1000)
/>
```
#### Fluid Width Example - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--fluid-width-view)
```javascript
// Speedometer will take the width of the parent div (500)
// any width passed will be ignored
```
#### Needle Transition Example - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--needle-transition-duration)
```javascript
```
#### Force Render component on props change - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--force-render-the-component)
```javascript
// By default, when props change, only the value prop is updated and animated.
// This is to maintain smooth visualization and to ignore breaking appearance changes like segments, colors etc.
// You can override this behaviour by giving forceRender: true
// render a component initially
// Now, if given forceRender: true, and change the appearance all together, the component will rerender completely on props change
```
#### Needle Height Configuration Example - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--configure-needle-length)
```javascript
```
You can give a value between `0` and `1` to control the needle height.
#### Gradient Like Effect - [Live Example](https://palerdot.in/svelte-speedometer/?path=/story/svelte-speedometer--gradient-effect-with-large-number-of-segments-and-maxsegmentlabels-config)
```javascript
```
---
### Todos:
- [x] Test coverage (with `@testing-library/svelte`)
- [x] Typescript support (Note: type definitions for props are available [here](/src/index.d.ts). As of this writing, I cannot find the official svelte component official types. It will be updated as it is made available)
---
### Tests:
`svelte-speedometer` comes with a test suite using `@testing-library/svelte`.
```javascript
// navigate to root folder and run
npm test
// or 'yarn test' if you are using yarn
```
---
#### Feature Updates:
- [`v1.1.0`] `valueTextFontWeight` prop. ref: https://svelte.dev/repl/c7e2f081bce34508b07265d6d12cca65?version=3.29.4
- [`v1.0.0`] `svelte-speedometer` initial launch
#### Changelog:
[View Changelog](CHANGELOG.md)
---
#### Contributing:
PRs are welcome. Please create a issue/bugfix/feature branch and create an issue with your branch details. Probably I will create a similar branch in the upstream repo so that PRs can be raised against that branch instead of `master`.
#### Notes
- `1.x` versions are compatible with Svelte `v3`
For every subsequent major svelte upgrade, `svelte-speedometer` will be bumped to next major versions. For example `2.x` will be compatible with `Svelte v4.x` so on and so forth ...
For similar library for React, please check out [react-d3-speedometer](https://github.com/palerdot/react-d3-speedometer)
For similar library for VueJS, please check out [vue-speedometer](https://github.com/palerdot/vue-speedometer)
#### License:
[MIT](LICENSE)