Skip to content

Commit 5b74e88

Browse files
committed
docs: update api doc
1 parent c8d676e commit 5b74e88

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/pages/docs/api.mdx

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
## Props
22

3-
| Prop | Default | Description |
4-
| ------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------ |
5-
| audio | | Songs' information. Could be a single object or an array of objects |
6-
| audio.name | `"Audio name"` | Title of the song |
7-
| audio.artist | `"Audio artist"` | Artist name of the song |
8-
| audio.url | | Url of the media source to play |
9-
| audio.cover | | Url of the album cover image |
10-
| audio.lrc | | Lyrics of the song in raw LRC format |
11-
| audio.theme | | Override theme color for this song. See `theme` prop for theme color explanation |
12-
| theme | `"#ebd0c2"` | Theme color of the player that applies to progress bar, volume control bar and playlist marker. |
13-
| autoPlay | | [See `autoplay` attribute of `<audio>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio#attr-autoplay) |
14-
| volume | `0.7` | Initial volume of the player. |
15-
| initialLoop | `"all"` | Initial loop mode of the player |
16-
| initialOrder | `"list"` | Initial playlist order of the player |
3+
| Prop | Default | Description |
4+
| ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------ |
5+
| audio | | Songs' information. Could be a single object or an array of objects |
6+
| audio.name | `"Audio name"` | Title of the song |
7+
| audio.artist | `"Audio artist"` | Artist name of the song |
8+
| audio.url | | Url of the media source to play |
9+
| audio.cover | | Url of the album cover image |
10+
| audio.lrc | | Lyrics of the song in raw LRC format |
11+
| audio.theme | | Override theme color for this song. See `theme` prop for theme color explanation |
12+
| theme | `"#ebd0c2"` | Theme color of the player that applies to progress bar, volume control bar and playlist marker. |
13+
| autoPlay | | [See `autoplay` attribute of `<audio>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio#attr-autoplay) |
14+
| volume | `0.7` | Initial volume of the player. |
15+
| initialLoop | `"all"` | Initial loop mode of the player |
16+
| initialOrder | `"list"` | Initial playlist order of the player |
17+
| listMaxHeight | `250` | Playerlist max height |

0 commit comments

Comments
 (0)