docs: add checkbox zh doc

oil-oil · Sep 12, 2023 · 5f29422 · 5f29422
1 parent 9ae6ec8
commit 5f29422
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 9 deletions.
diff --git a/packages/docs/docs/.vitepress/docs/documentation/components/checkbox.md b/packages/docs/docs/.vitepress/docs/documentation/components/checkbox.md
@@ -5,13 +5,13 @@ props :
     - name: color
       type: String
       values: Vuesax Colors | RGB | HEX
-      description: Change the color of the component and some of its sub components.
+      description: Change the color of the checkbox and some of its sub components.
       default: primary
       usageUrl: checkbox#color
     - name: v-model
       type: Boolean
       values: true | false
-      description: determine the value of the checkbox and data anchor.
+      description: Determine the value of the checkbox.
       default: "false"
       usageUrl: checkbox#default
     - name: loading
@@ -25,11 +25,11 @@ props :
       values: true | false
       description: Add a line in the center of the label when checked.
       default: "false"
-      usageUrl: checkbox#linethrough
+      usageUrl: checkbox#line-through
     - name: indeterminate
       type: Boolean
       values: true | false
-      description: Add a line in the center of the label when checked.
+      description: Change the default checkbox icon to a line that represents undetermined data.
       default: "false"
       usageUrl: checkbox#indeterminate
     - name: labelBefore
@@ -41,20 +41,20 @@ props :
     - name: checked
       type: Boolean
       values: true | false
-      description: Determine if the component is initially in check (this changes the property computed in v-model to true).
+      description: Determine if the checkbox is initially in check (this changes the property computed in v-model to true).
       default: "false"
       usageUrl: checkbox#boolean-value
 slots : 
     - name: icon
       type: slot
       values:
-      description: Change the component icon.
+      description: Change the checkbox icon.
       default: 
       usageUrl: checkbox#icon
     - name: default
       type: slot
       values:
-      description: Add a label to the component.
+      description: Add a label to the checkbox.
       default: 
       usageUrl: checkbox#default
 ---
@@ -113,7 +113,7 @@ Add a loading status to the component with the property `loading`
 
 <card subtitle="LineThrough">
 
-## LineThrough
+## Line Through
 
 Add a line in the middle of the label when the checkbox is checked with the property `line-through`
 

diff --git a/packages/docs/docs/.vitepress/docs/zh/documentation/components/checkbox.md b/packages/docs/docs/.vitepress/docs/zh/documentation/components/checkbox.md
@@ -1,3 +1,64 @@
+---
+prev: Input
+next: Switch
+props : 
+    - name: color
+      type: String
+      values: Vuesax Colors | RGB | HEX
+      description: 更改复选框及其部分子组件的颜色
+      default: primary
+      usageUrl: checkbox#color
+    - name: v-model
+      type: Boolean
+      values: true | false
+      description: 确定复选框的值
+      default: "false"
+      usageUrl: checkbox#default
+    - name: loading
+      type: Boolean
+      values: true | false
+      description: 添加加载动画并禁用输入
+      default: "false"
+      usageUrl: checkbox#loading
+    - name: lineThrough
+      type: Boolean
+      values: true | false
+      description: 选中时，在标签中添加横线
+      default: "false"
+      usageUrl: checkbox#line-through
+    - name: indeterminate
+      type: Boolean
+      values: true | false
+      description: 选中时，在标签中央添加一行
+      default: "false"
+      usageUrl: checkbox#indeterminate
+    - name: labelBefore
+      type: Boolean
+      values: true | false
+      description: 将默认复选框图标改为表示未确定数据的线条
+      default: "false"
+      usageUrl: checkbox#label
+    - name: checked
+      type: Boolean
+      values: true | false
+      description: 确定组件是否处于初始校验状态（这会将 v-model 中计算的属性更改为 true）
+      default: "false"
+      usageUrl: checkbox#boolean-value
+slots : 
+    - name: icon
+      type: slot
+      values:
+      description: 更改组件图标
+      default: 
+      usageUrl: checkbox#icon
+    - name: default
+      type: slot
+      values:
+      description: 为组件添加标签
+      default: 
+      usageUrl: checkbox#default
+---
+
 # Checkbox 复选框
 
 <card>
@@ -18,7 +79,7 @@
 
 <card subtitle="BooleanValue">
 
-## 布尔值
+## Boolean Value
 
 默认情况下，该组件与一个布尔值一起使用，当被勾选时返回`true`，当未被勾选时返回`false`。