Skip to content

Commit ce68dd5

Browse files
committed
docs: update README
1 parent b2e89fd commit ce68dd5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Local component
4747
```js
4848
// example.vue
4949
import { IllestWaveform } from "1llest-waveform-vue"
50-
import "1llest-waveform-vue/dist/style.css"
50+
import "1llest-waveform-vue/lib/style.css"
5151
```
5252
### Component
5353
```vue
@@ -70,7 +70,7 @@ import "1llest-waveform-vue/dist/style.css"
7070
import type { Ref } from "vue"
7171
import { IllestWaveform } from "1llest-waveform-vue"
7272
import type { IllestWaveformProps } from "1llest-waveform-vue"
73-
import "1llest-waveform-vue/dist/style.css"
73+
import "1llest-waveform-vue/lib/style.css"
7474
7575
const waveOptions = reactive<IllestWaveformProps>({
7676
url: "example.mp3"
@@ -145,10 +145,11 @@ import "1llest-waveform-vue/dist/style.css"
145145
| 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` |
146146
| cursorWidth | indicates your cursor width | `Number` | `2` |
147147
| cursorColor | the color of your cursor | `String` | `#fff` |
148-
| maskColor | the color of the waveform mask layer | `String` | `fff` |
148+
| maskColor | the color of the waveform mask layer | `String` | `#fff` |
149149
| lazy | whether to enable lazy loading mode, if you want to display multiple waveforms as a list, this property is very useful | `Boolean` | `true` |
150150
| skeleton | whether to enable the skeleton during waveform loading | `Boolean` | `true` |
151151
| skeletonColor | the color of the skeleton | `String` | `#232323` |
152+
| interact | indicates whether you want the user to interact with the waveform | `Boolean` | `true` |
152153

153154
### Events
154155

0 commit comments

Comments
 (0)