From 7775a88a74b1db7c11d7164ef3155497a65e46bf Mon Sep 17 00:00:00 2001 From: 刘嘉威 <daidaibg@163.com> Date: 星期三, 26 十月 2022 16:58:14 +0800 Subject: [PATCH] docs: update README --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++--------------- 1 files changed, 43 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 08bc674..60e4ece 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ ## 寮�鍙戜腑...鍙互鎻恜r瀹屽杽 锛屾鏋跺凡缁忔惌寤哄ソ - - ## 椤圭洰鎻忚堪 @@ -42,19 +40,17 @@ ### 椤圭洰棰勮鍦板潃 -[https://www.daidaibg.com/bigscreen-vue3 - -[](https://www.daidaibg.com/bigscreen) +[https://www.daidaibg.com/bigscreen](https://www.daidaibg.com/bigscreen) ### 椤圭洰浠撳簱鍦板潃 **github鍦板潃** -[https://github.com/daidaibg/IofTV-Screen-Vue3](https://github.com/daidaibg/IofTV-Screen) +[https://github.com/daidaibg/IofTV-Screen-Vue3](https://github.com/daidaibg/IofTV-Screen-Vue3) **Gitee鍦板潃** -[https://gitee.com/daidaibg/IofTV-Screen-Vue3](https://gitee.com/daidaibg/IofTV-Screen) +[https://gitee.com/daidaibg/IofTV-Screen-Vue3](https://gitee.com/daidaibg/IofTV-Screen-Vue3) ### 閲囩敤鑷�傚簲缁勪欢鏂瑰紡锛� @@ -114,13 +110,19 @@ mockXHR() ``` -## 鑷�傚簲缂╂斁缁勪欢 +## -### 娉ㄦ剰 +## 鍏敤缁勪欢 + +灏佽浜嗛櫎闈㈡潯澶栦釜鍒敤鍒扮殑缁勪欢 + +### 鑷�傚簲缂╂斁缁勪欢 + +#### 娉ㄦ剰 閲囩敤Scale鏂瑰紡锛屼細鑷姩缁欑粍浠剁埗鍏冪礌娣诲姞overflow:hidden -### 浣跨敤 +#### 浣跨敤 ```vue <template> @@ -142,7 +144,9 @@ } </script> ``` -### API + +#### API + | 灞炴�� | 璇存槑 | 绫诲瀷 | 榛樿鍊� | | ------------ | ------------------------------------------------------------ | -------------------------------- | ------ | | selfAdaption | 鏄惁杩涜鑷�傚簲 | Boolean | true | @@ -153,10 +157,6 @@ | fullScreen | 鍏ㄥ睆鑷�傚簲锛屽惎鐢ㄦ閰嶇疆椤规椂浼氬瓨鍦ㄦ媺浼告晥鏋滐紝鍚屾椂autoScale澶辨晥锛岄潪蹇呰鎯呭喌涓嬩笉寤鸿寮�鍚� | Boolean | false | | boxStyle | 淇敼瀹瑰櫒鏍峰紡锛屽灞呬腑灞曠ず鏃朵晶杈硅儗鏅壊锛岀鍚圴ue鍙屽悜缁戝畾style鏍囧噯鏍煎紡 | Object | null | | wrapperStyle | 淇敼鑷�傚簲鍖哄煙鏍峰紡锛岀鍚圴ue鍙屽悜缁戝畾style鏍囧噯鏍煎紡 | Object | null | - -## 鍏敤缁勪欢 - -灏佽浜嗛櫎闈㈡潯澶栦釜鍒敤鍒扮殑缁勪欢 ### 澶栬竟妗� @@ -235,7 +235,35 @@ } ``` +### 鑳跺泭鏌卞浘 +#### Props + +| 灞炴�� | 璇存槑 | 绫诲瀷 | 鍙�夊�� | 榛樿鍊� | +| :----: | :------: | :-------------: | :-----------------------: | :-----: | +| data | 鏌辨暟鎹� | `Array<Object>` | [data灞炴�(#data灞炴��) | `[]` | +| config | 鍩虹閰嶇疆 | Object | [config灞炴�(#config灞炴��) | `false` | + +#### config灞炴�� + +| 灞炴�� | 璇存槑 | 绫诲瀷 | 鍙�夊�� | 榛樿鍊� | +| :-------: | :------: | :-------------: | :----: | :-----: | +| unit | 鍗曚綅 | `String` | --- | `''` | +| colors | 鐜鑹� | `Array<String>` | [1] | [2] | +| showValue | 鏄剧ず鏁板�� | `Boolean` | --- | `false` | + +#### 娉ㄩ噴config娉ㄩ噴 + +[1] 棰滆壊鏀寔`hex|rgb|rgba|棰滆壊鍏抽敭瀛梎绛夊洓绉嶇被鍨嬨�� + +[2] 榛樿閰嶈壊涓篳['#37a2da', '#32c5e9', '#67e0e3', '#9fe6b8', '#ffdb5c', '#ff9f7f', '#fb7293']`銆� + +#### data灞炴�� + +| 灞炴�� | 璇存槑 | 绫诲瀷 | 鍙�夊�� | 榛樿鍊� | +| :---: | :------: | :------: | :----: | :----: | +| name | 鏌卞悕绉� | `String` | --- | --- | +| value | 鏌卞搴斿�� | `Number` | --- | --- | ## 涓棿鍦板浘 -- Gitblit v1.8.0