mirror of
https://github.com/jlengrand/d3-progress-meter.git
synced 2026-03-10 08:11:18 +00:00
Document type of properties
This commit is contained in:
14
README.md
14
README.md
@@ -17,13 +17,13 @@ The component has been inspired by [EK-progress-meter](https://github.com/pinkho
|
||||
|
||||
## Properties
|
||||
|
||||
Property | Description | Example
|
||||
---------------- | ------------------------------------------------------------------------ | -------
|
||||
**radius** | Radius of the meter. The element will have twice the size of the radius. | 100
|
||||
**percentage** | Progress in percent | 0.4
|
||||
**current-text** | Large number showing current progress | $8
|
||||
**goal-text** | Small text indicating when progress will be 100% | Goal: $20
|
||||
**type-text** | Bottom text describing for what progress is measured | Sales
|
||||
Property | Type | Description | Example
|
||||
---------------- | ------ | ------------------------------------------------------------------------ | -------
|
||||
**radius** | Number | Radius of the meter. The element will have twice the size of the radius. | 100
|
||||
**percentage** | Number | Progress in percent | 0.4
|
||||
**current-text** | String | Large number showing current progress | $8
|
||||
**goal-text** | String | Small text indicating when progress will be 100% | Goal: $20
|
||||
**type-text** | String | Bottom text describing for what progress is measured | Sales
|
||||
|
||||
|
||||
## Continuous integration
|
||||
|
||||
Reference in New Issue
Block a user