Skip to content

Commit

Permalink
doc: add loader prop description
Browse files Browse the repository at this point in the history
  • Loading branch information
setaman committed Oct 27, 2020
1 parent 51d53cc commit 96eeeb3
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ After you have initialized the component, use it everywhere you want in your app
dash="60 0.9"
animation="reverse 700 400"
:noData="false"
:loading="false"
:loading="false"
:loader="{ color: 'green' }"
fontColor="white"
:half="false"
:gap="10"
Expand Down Expand Up @@ -115,6 +116,7 @@ This table below provides a quick overview over all available options. To gain m
| **[`legendFormatter`](#legendformatter)** [![npm](https://img.shields.io/badge/v1.3.0-blue?style=flat-square)](#legendformatter) | Function | Function that returns formatted value | |
| **[`animation`](#animation)** | String | "default \| rs \| loop \| reverse \| bounce [duration delay]" | "default 1000 400"|
| **[`loading`](#loading)** | Boolean | |false|
| **[`loader`](#loading)** | Object | { [thickness, color, lineMode, line, opacity ]} | |
| **[`determinate`](#determinate)** | Boolean | |false|
| **[`noData`](#nodata)** | Boolean | |false|
| **[`angle`](#angle)** | Number | any Number |-90|
Expand Down Expand Up @@ -406,6 +408,21 @@ Forces loading state. The component provides an indeterminate loading state for

<br>

- ### `loader`

With this option defined as Object you can customize the loading circle that is shown in the states
[loading](#loading) and [determinate](#determinate). Accepted properties are [`color`](#color), [`thickness`](#thickness), [`line`](#line),
[`lineMode`](#linemode) and `opactity`. `opacity` is specific for loading circle and can be any valid CSS opacity value.

###### Example: :scroll:

```vue
<vue-ellipse-progress :loader="{ color: 'green', lineMode: 'in 10', opacity: '0.5' }" />
```

<br>

- ### `determinate`

Provides a determinate loading state that indicates that your data loading is still in progress but allows to show the **[`progress`](#progress)**.
Expand Down

0 comments on commit 96eeeb3

Please sign in to comment.