✨ feat(ims-view-pc): update Piano docs

eternallycyf · Sep 7, 2024 · ab000e0 · ab000e0
1 parent da97613
commit ab000e0
Showing 1 changed file with 16 additions and 3 deletions.
diff --git a/packages/ims-view-pc/src/components/Piano/index.md b/packages/ims-view-pc/src/components/Piano/index.md
@@ -1,12 +1,25 @@
 ---
 title: Piano
 description: 钢琴
-order: 0
+group:
+  title: 其他
+  order: 9999
 toc: content
-demo:
-  cols: 2
 ---
 
 ## Piano 钢琴
 
+一个简单的钢琴组件，可以播放音乐。
+
+## 示例
+
 <code src="./demo/index.tsx">钢琴</code>
+
+## API
+
+### PianoHandle
+
+| 参数      | 说明                                                       | 类型                              | 默认值 |
+| --------- | ---------------------------------------------------------- | --------------------------------- | ------ |
+| playMusic | 音乐数组，每个数组代表一首音乐，数组内每个数字代表一个音符 | `playMusic: number[][]) => void;` | -      |
+| songs     | 内置歌曲                                                   | number[]                          | -      |