From 096f3bc2bd3694334d3e52f5faf7754dff43e486 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?kiner-tang=28=E6=96=87=E8=BE=89=29?= <1127031143@qq.com>
Date: Sun, 27 Nov 2022 19:22:43 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E5=AE=8C=E5=96=84=20switch=20=E7=BB=84?=
 =?UTF-8?q?=E4=BB=B6=E7=9B=B8=E5=85=B3=E6=96=87=E6=A1=A3=20&=20=E7=B1=BB?=
 =?UTF-8?q?=E5=9E=8B=E6=8F=8F=E8=BF=B0=E4=BC=98=E5=8C=96?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .changeset/wicked-balloons-notice.md           |  7 +++++++
 .../src/components/switch/demo/index.tsx       |  6 +++---
 .../docs/\347\273\204\344\273\266/switch.md"   |  6 +++---
 packages/ossa/types/switch.d.ts                | 18 +++++++++++++++++-
 4 files changed, 30 insertions(+), 7 deletions(-)
 create mode 100644 .changeset/wicked-balloons-notice.md

diff --git a/.changeset/wicked-balloons-notice.md b/.changeset/wicked-balloons-notice.md
new file mode 100644
index 00000000..d6133d45
--- /dev/null
+++ b/.changeset/wicked-balloons-notice.md
@@ -0,0 +1,7 @@
+---
+"ossaui": patch
+"ossa-demo": patch
+"ossa-doc": patch
+---
+
+feat: 完善 switch 组件相关文档 & 类型描述优化
diff --git a/packages/ossa-demo/src/components/switch/demo/index.tsx b/packages/ossa-demo/src/components/switch/demo/index.tsx
index 8d5e1877..809905cb 100644
--- a/packages/ossa-demo/src/components/switch/demo/index.tsx
+++ b/packages/ossa-demo/src/components/switch/demo/index.tsx
@@ -27,13 +27,13 @@ const initialListApi = {
       list: ["checked", "是否打开", "boolean", "false"],
     },
     {
-      list: ["onColor", "打开时的背景色，可选", "string", "-"],
+      list: ["onColor", "打开时的背景色，可选", "string", "#44DB5E"],
     },
     {
-      list: ["offColor", "关闭时的背景色，可选", "string", "-"],
+      list: ["offColor", "关闭时的背景色，可选", "string", "#FFFFFF"],
     },
     {
-      list: ["nodeColor", "滑块颜色，可选", "string", "-"],
+      list: ["nodeColor", "滑块颜色，可选", "string", "#FFFFFF"],
     },
     {
       list: ["isDisabled", "禁用，可选，`isDisabled`属性在未来版本中将被删除，请使用`disabled`代替", "boolean", "false"],
diff --git "a/packages/ossa-doc/docs/\347\273\204\344\273\266/switch.md" "b/packages/ossa-doc/docs/\347\273\204\344\273\266/switch.md"
index f44f1db1..f46d6917 100644
--- "a/packages/ossa-doc/docs/\347\273\204\344\273\266/switch.md"
+++ "b/packages/ossa-doc/docs/\347\273\204\344\273\266/switch.md"
@@ -44,9 +44,9 @@ demo_url: 'https://neteaseyanxuan.github.io/OSSA/#/components/switch/demo/index'
 |------|------|------|------|
 |isChecked|是否打开，`isChecked`属性在未来版本中将被删除，请使用`checked`代替|boolean|false|
 |checked|是否打开|boolean|false|
-|onColor|打开时的背景色，可选|string|-|
-|offColor|关闭时的背景色，可选|string|-|
-|nodeColor|滑块颜色，可选|string|-|
+|onColor|打开时的背景色，可选|string|#44DB5E|
+|offColor|关闭时的背景色，可选|string|#FFFFFF|
+|nodeColor|滑块颜色，可选|string|#FFFFFF|
 |isDisabled|禁用，可选，`isDisabled`属性在未来版本中将被删除，请使用`disabled`代替|boolean|false|
 |disabled|禁用，可选|boolean|false|
 
diff --git a/packages/ossa/types/switch.d.ts b/packages/ossa/types/switch.d.ts
index 494ca693..6725e25a 100644
--- a/packages/ossa/types/switch.d.ts
+++ b/packages/ossa/types/switch.d.ts
@@ -11,8 +11,20 @@ interface SwitchProps extends OsComponent {
    * 是否选中
    */
   checked?: boolean;
+  /**
+   * 打开时的背景色
+   * @default '#44DB5E'
+   */
   onColor?: string;
+  /**
+   * 关闭时的背景色
+   * @default '#FFF'
+   */
   offColor?: string;
+  /**
+   * 滑块颜色
+   * @default '#FFF'
+   */
   nodeColor?: string;
   /**
    * 是否禁用
@@ -25,7 +37,11 @@ interface SwitchProps extends OsComponent {
    * @default false
    */
   disabled?: boolean;
-  onChange: (v) => void;
+  /**
+   * 状态改变时触发
+   * @param v 当前开关的开启状态
+   */
+  onChange: (v: boolean) => void;
 }
 
 declare const Switch: ComponentClass<SwitchProps>;