Skip to content

Commit a2b9928

Browse files
committed
docs: more corrections [ci skip]
1 parent 9457d28 commit a2b9928

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,13 @@ After you have initialized the component, you are ready to create your circles:
9898
reverse
9999
font-size="5rem">
100100

101-
<span slot="legend-value">/200</span>
101+
<span slot="legend">/200</span>
102102
<p slot="legend-caption">GOOD JOB</p>
103103

104104
</ve-progress>
105105
```
106106
## Options
107-
The **[`progress`](#progress)** is the only required property and you are ready to go with just following line:
107+
The **[`progress`](#progress)** is the only required property, and you are ready to go with just following line:
108108
```html
109109
<ve-progress :progress="progress"/>
110110
```
@@ -125,7 +125,7 @@ The **[`progress`](#progress)** is the only required property and you are ready
125125
| **[`emptyColor`](#emptycolor)** | String \| Object | same as `color` | "#e6e9f0" |
126126
| **[`emptyColorFill`](#emptycolorfill)** | String \| Object | same as `color` | "transparent" |
127127
| **[`hideLegend`](#hideLegend)** | Boolean | | true |
128-
| **[`legend`](#legend)** | Number \| String | any number, accepts a `.` or `","` as decimals delimiter | |
128+
| **[`legend`](#legend)** | Number \| String | any number, accepts a `.` or `","` as decimals delimiter and simple formatting | |
129129
| **[`legendFormatter`](#legendformatter)** | Function | Function that returns formatted value | |
130130
| **[`animation`](#animation)** | String | "default \| rs \| loop \| reverse \| bounce [duration delay]" | "default 1000 400"|
131131
| **[`loading`](#loading)** | Boolean | |false|
@@ -139,7 +139,7 @@ The **[`progress`](#progress)** is the only required property and you are ready
139139
| **[`dash`](#dash)** | String | "[strict] count spacing" | |
140140
| **[`half`](#half)** | Boolean | | false |
141141
| **[`gap`](#gap)** | Number | any Number that defines the gap between multiple circles in pixel | 0 |
142-
| **[`dot`](#dot)** | String \| Number \| Object | Accepts size, color and other styles as Number, descriptive string `"10% red"` or object `{size : 10, backgroundColor: "red", widht: "2px", borderRadius: "5px" ...}` | 0 |
142+
| **[`dot`](#dot)** | String \| Number \| Object | Accepts size, color and other styles as Number, descriptive string `"size [color]"` or object `{size [, backgroundColor, widht, borderRadius ...]}` | 0 |
143143
| **[`reverse`](#reverse)** | Boolean | | false |
144144
| **[`data`](#data)** | Array | defines multiple circles, takes as values Objects with almost all props defined above | |
145145

@@ -229,7 +229,7 @@ The first value ist the `mode` and the optional second is the `offset`. You can
229229
help you to align lines as you want to.
230230

231231
- `mode`:
232-
- `center`: this is the default value and both lines are aligned at the base line (centered).
232+
- `center`: this is the default value and both lines are aligned at the baseline (centered).
233233
<img width="100" height="50" src="https://github.com/setaman/Bilder/blob/master/ellipse-normal.png">
234234

235235
- `in`: the progress line is inside the empty line
@@ -260,7 +260,7 @@ Let's take a look at few examples:
260260
|----------|--------|---------|---------|
261261
| <img width="100" height="100" src="https://github.com/setaman/Bilder/blob/master/ellipse-exmp1.png">|<img width="100" height="100" src="https://github.com/setaman/Bilder/blob/master/ellipse-exmp2.png">|<img width="100" height="100" src="https://github.com/setaman/Bilder/blob/master/ellipse-exmp3.png">|<img width="100" height="100" src="https://github.com/setaman/Bilder/blob/master/ellipse-exmp4.png"> |
262262

263-
In general, any positioning can already be achieved with values `in` and `out` in a combination with certain `offset`. The modes, however, act like presets, which reduce the effort for the manuall calculations.
263+
In general, any positioning can already be achieved with values `in` and `out` in a combination with certain `offset`. The modes, however, act like presets, which reduce the effort for the manual calculations.
264264

265265
<br>
266266

@@ -269,7 +269,7 @@ In general, any positioning can already be achieved with values `in` and `out` i
269269

270270
###### Animated: ✔️
271271

272-
Descriptive string in form `"mode [offset]"` that defines how the progress line is aligned in relation to the cirlce fill area.
272+
Descriptive string in form `"mode [offset]"` that defines how the progress line is aligned in relation to the circle fill area.
273273
Available modes are `center`, `in` and `out`. Additionally, with the `out` mode you can provide an `offset` value as any Number.
274274
In general, this prop makes it possible to mimic the SVG2 `stroke-aligment`, which is currently not supported in any browser.
275275

@@ -411,7 +411,7 @@ const myFormatter = ({ currentValue, ...otherProps }) => {
411411
return new Intl.NumberFormat("de-DE", { style: "currency", currency: "EUR" }).format(currentValue);
412412
}
413413
```
414-
The funtion can also return HTML:
414+
The function can also return HTML:
415415
```js
416416
const myFormatter = ({ currentValue }) => {
417417
return `
@@ -561,7 +561,7 @@ The dot property lets you define a point indicator at the end of the progress li
561561

562562
**Number**: `:dot="10"` - specifies a round dot with 10px width and height and default `#713dfd` color
563563

564-
**Descriptive string**: `dot="size [color]"` - `size` can be just a Number or a percent value like `5%`, the calculation for percent values is similar to **[`thickness`](#thickness)** and depends on the **[`size`](#size)**. `color` is optional and lets you quickly define the color of the dot. The order of properties is important for parsing the String and you can set the `color` only if the `size` is defined.
564+
**Descriptive string**: `dot="size [color]"` - `size` can be just a Number or a percent value like `5%`, the calculation for percent values is similar to **[`thickness`](#thickness)** and depends on the **[`size`](#size)**. `color` is optional and lets you quickly define the color of the dot. The order of properties is important for parsing the String, and you can set the `color` only if the `size` is defined.
565565

566566
**Object**: `:dot="{ size: Number | String [, any CSS inline style with Vue syntax] }"` - to customize the point, you can define the prop as an Object. `size` is required and can be just a Number or a String to define a percent value. Only defining the prop as an Object you have the possibility to add any styles to the dot you want to, using Vue syntax for defining inline styles, you can even completely break the positioning of the dot, if you need. You cannot override the `height` of the dot since it is important for internal calculation and must be controllable.
567567

@@ -599,7 +599,7 @@ a negative value for [`progress`](#progress).
599599

600600
- ### `data`
601601

602-
You can specify 2 or more circles as Objects in an array as `data`. For each circle you can use almost every available property. It is not necessary to specify all properties, they will be merged with global props and the specified props will overwrite the global. The circles are rendered inside each other.
602+
You can specify 2 or more circles as Objects in an array as `data`. For each circle you can use almost every available property. It is not necessary to specify all properties, they will be merged with global props, the specified props will overwrite the global. The circles are rendered inside each other.
603603

604604
>❗ Excluded props: **[`lineMode`](#lineMode)**, **[`emptyThickness`](#emptyThickness)**, **[`legend`](#legend)**. These properties will be ignored, if `data` is specified. The legend of this circle is also not shown.
605605

commitlint.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
extends: ["@commitlint/config-conventional"],
3+
"type-enum": [
4+
2,
5+
"always",
6+
["build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "release"],
7+
],
8+
};

0 commit comments

Comments
 (0)