Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
codeacme17 committed Mar 28, 2023
1 parent b2e89fd commit ce68dd5
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Local component
```js
// example.vue
import { IllestWaveform } from "1llest-waveform-vue"
import "1llest-waveform-vue/dist/style.css"
import "1llest-waveform-vue/lib/style.css"
```
### Component
```vue
Expand All @@ -70,7 +70,7 @@ import "1llest-waveform-vue/dist/style.css"
import type { Ref } from "vue"
import { IllestWaveform } from "1llest-waveform-vue"
import type { IllestWaveformProps } from "1llest-waveform-vue"
import "1llest-waveform-vue/dist/style.css"
import "1llest-waveform-vue/lib/style.css"
const waveOptions = reactive<IllestWaveformProps>({
url: "example.mp3"
Expand Down Expand Up @@ -145,10 +145,11 @@ import "1llest-waveform-vue/dist/style.css"
| samplingRate | indicates your audio sampling rate. The larger the value, the more lines the waveform will present and the higher the accuracy. But this value is not recommended to be too large, because too large a value will slow down rendering efficiency, the recommended value is between ` 8000 - 44100 ` | `Number` | `22050` |
| cursorWidth | indicates your cursor width | `Number` | `2` |
| cursorColor | the color of your cursor | `String` | `#fff` |
| maskColor | the color of the waveform mask layer | `String` | `fff` |
| maskColor | the color of the waveform mask layer | `String` | `#fff` |
| lazy | whether to enable lazy loading mode, if you want to display multiple waveforms as a list, this property is very useful | `Boolean` | `true` |
| skeleton | whether to enable the skeleton during waveform loading | `Boolean` | `true` |
| skeletonColor | the color of the skeleton | `String` | `#232323` |
| interact | indicates whether you want the user to interact with the waveform | `Boolean` | `true` |

### Events

Expand Down

0 comments on commit ce68dd5

Please sign in to comment.