docs: fix docs

varletjs · Jul 5, 2024 · a941278 · a941278
1 parent 4539b1b
commit a941278
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 29 deletions.
diff --git a/packages/varlet-ui/src/checkbox-group/docs/en-US.md b/packages/varlet-ui/src/checkbox-group/docs/en-US.md
@@ -149,7 +149,7 @@ const value = ref([])
 </template>
 ```
 
-### CheckboxGroup Options
+### Options API
 
 Setting child elements via the `options` prop.
 

diff --git a/packages/varlet-ui/src/checkbox-group/docs/zh-CN.md b/packages/varlet-ui/src/checkbox-group/docs/zh-CN.md
@@ -148,7 +148,7 @@ const value = ref([])
   <div>当前的值: {{ value }}</div>
 </template>
 ```
-### 复选框组选项
+### 选项式 API
 
 通过 `options` 属性设置子元素。
 

diff --git a/packages/varlet-ui/src/checkbox-group/example/locale/en-US.ts b/packages/varlet-ui/src/checkbox-group/example/locale/en-US.ts
@@ -11,7 +11,7 @@ export default {
   checkAll: 'Check All',
   inverseAll: 'Inverse All',
   checkboxGroup: 'CheckboxGroup',
-  checkboxGroupOptions: 'CheckboxGroup Options',
+  checkboxGroupOptions: 'Options API',
   customFields: 'Custom Fields',
   vertical: 'Vertical Direction',
   checkboxValidate: 'Checkbox Validation',

diff --git a/packages/varlet-ui/src/checkbox-group/example/locale/zh-CN.ts b/packages/varlet-ui/src/checkbox-group/example/locale/zh-CN.ts
@@ -11,7 +11,7 @@ export default {
   checkAll: '全选',
   inverseAll: '反选',
   checkboxGroup: '复选框组',
-  checkboxGroupOptions: '复选框组选项',
+  checkboxGroupOptions: '选项式 API',
   customFields: '自定义字段',
   vertical: '垂直布局',
   checkboxValidate: '复选框字段校验',

diff --git a/packages/varlet-ui/src/radio-group/docs/en-US.md b/packages/varlet-ui/src/radio-group/docs/en-US.md
@@ -114,7 +114,7 @@ const value = ref(0)
 </template>
 ```
 
-### RadioGroup Options
+### Options API
 
 Setting child elements via the `options` prop.
 

diff --git a/packages/varlet-ui/src/radio-group/docs/zh-CN.md b/packages/varlet-ui/src/radio-group/docs/zh-CN.md
@@ -114,7 +114,7 @@ const value = ref(0)
 </template>
 ```
 
-### 单选框组选项
+### 选项式 API
 
 通过 `options` 属性设置子元素。
 

diff --git a/packages/varlet-ui/src/radio-group/example/locale/en-US.ts b/packages/varlet-ui/src/radio-group/example/locale/en-US.ts
@@ -11,7 +11,7 @@ export default {
   checkAll: 'Check All',
   inverseAll: 'Inverse All',
   radioGroup: 'RadioGroup',
-  radioGroupOptions: 'RadioGroup Options',
+  radioGroupOptions: 'Options API',
   vertical: 'Vertical Direction',
   radioValidate: 'Radio Validation',
   radioGroupValidate: 'RadioGroup Validate',

diff --git a/packages/varlet-ui/src/radio-group/example/locale/zh-CN.ts b/packages/varlet-ui/src/radio-group/example/locale/zh-CN.ts
@@ -11,7 +11,7 @@ export default {
   checkAll: '全选',
   inverseAll: '反选',
   radioGroup: '单选框组',
-  radioGroupOptions: '单选框组选项',
+  radioGroupOptions: '选项式 API',
   vertical: '垂直布局',
   radioValidate: '单选框字段校验',
   radioGroupValidate: '单选框组字段校验',

diff --git a/packages/varlet-ui/src/select/docs/en-US.md b/packages/varlet-ui/src/select/docs/en-US.md
@@ -176,12 +176,9 @@ const value16 = ref()
       <var-option label="Eat" />
       <var-option label="Sleep" />
     </var-select>
-    <var-select placeholder="Select Options" v-model="value14" :options="options">
-    </var-select>
-    <var-select placeholder="Multiple Select Options" v-model="value15" :options="options" multiple>
-    </var-select>
-    <var-select placeholder="Custom Fields" v-model="value16" :options="keyOptions" label-key="name" value-key="id">
-    </var-select>
+    <var-select placeholder="Options API" v-model="value14" :options="options" />
+    <var-select placeholder="Options API" v-model="value15" :options="options" multiple />
+    <var-select placeholder="Custom Fields" v-model="value16" :options="keyOptions" label-key="name" value-key="id" />
   </var-space>
 </template>
 
@@ -223,6 +220,9 @@ const value10 = ref([])
 const value11 = ref()
 const value12 = ref([])
 const value13 = ref()
+const value14 = ref()
+const value15 = ref([])
+const value16 = ref()
 </script>
 
 <template>
@@ -345,6 +345,9 @@ const value13 = ref()
       <var-option label="Eat" />
       <var-option label="Sleep" />
     </var-select>
+    <var-select variant="outlined" placeholder="Options API" v-model="value14" :options="options" />
+    <var-select variant="outlined" placeholder="Options API" v-model="value15" :options="options" multiple />
+    <var-select variant="outlined" placeholder="Custom Fields" v-model="value16" :options="keyOptions" label-key="name" value-key="id" />
   </var-space>
 </template>
 

diff --git a/packages/varlet-ui/src/select/docs/zh-CN.md b/packages/varlet-ui/src/select/docs/zh-CN.md
@@ -178,12 +178,9 @@ const value16 = ref()
       <var-option label="吃饭" />
       <var-option label="睡觉" />
     </var-select>
-    <var-select placeholder="下拉框选项" v-model="value14" :options="options">
-    </var-select>
-    <var-select placeholder="下拉框选项（多选）" v-model="value15" :options="options" multiple>
-    </var-select>
-    <var-select placeholder="自定义字段" v-model="value16" :options="keyOptions" label-key="name" value-key="id">
-    </var-select>
+    <var-select placeholder="选项式 API" v-model="value14" :options="options" />
+    <var-select placeholder="选项式 API（多选）" v-model="value15" :options="options" multiple />
+    <var-select placeholder="自定义字段" v-model="value16" :options="keyOptions" label-key="name" value-key="id" />
   </var-space>
 </template>
 
@@ -225,6 +222,9 @@ const value10 = ref([])
 const value11 = ref()
 const value12 = ref([])
 const value13 = ref()
+const value14 = ref()
+const value15 = ref([])
+const value16 = ref()
 </script>
 
 <template>
@@ -347,6 +347,9 @@ const value13 = ref()
       <var-option label="吃饭" />
       <var-option label="睡觉" />
     </var-select>
+    <var-select variant="outlined" placeholder="选项式 API" v-model="value14" :options="options" />
+    <var-select variant="outlined" placeholder="选项式 API（多选）" v-model="value15" :options="options" multiple />
+    <var-select variant="outlined" placeholder="自定义字段" v-model="value16" :options="keyOptions" label-key="name" value-key="id" />
   </var-space>
 </template>
 

diff --git a/packages/varlet-ui/src/select/example/index.vue b/packages/varlet-ui/src/select/example/index.vue
@@ -33,6 +33,9 @@ const outlinedValue10 = ref([])
 const outlinedValue11 = ref()
 const outlinedValue12 = ref([])
 const outlinedValue13 = ref()
+const outlinedValue14 = ref()
+const outlinedValue15 = ref([])
+const outlinedValue16 = ref()
 const options = computed(() => [
   {
     label: t('eat'),
@@ -96,6 +99,9 @@ watchLang((lang) => {
   outlinedValue11.value = undefined
   outlinedValue12.value = []
   outlinedValue13.value = undefined
+  outlinedValue14.value = undefined
+  outlinedValue15.value = []
+  outlinedValue16.value = undefined
 
   use(lang)
 })
@@ -222,17 +228,15 @@ watchLang((lang) => {
       <var-option :label="t('eat')" />
       <var-option :label="t('sleep')" />
     </var-select>
-    <var-select :placeholder="t('selectOptions')" v-model="standardValue14" :options="options"></var-select>
-    <var-select :placeholder="t('selectOptionsMultiple')" v-model="standardValue15" :options="options" multiple>
-    </var-select>
+    <var-select :placeholder="t('selectOptions')" v-model="standardValue14" :options="options" />
+    <var-select :placeholder="t('selectOptionsMultiple')" v-model="standardValue15" :options="options" multiple />
     <var-select
       :placeholder="t('customFields')"
       v-model="standardValue16"
       :options="keyOptions"
       label-key="name"
       value-key="id"
-    >
-    </var-select>
+    />
   </var-space>
 
   <app-type style="margin-top: 10vmin">{{ t('outlined') }}</app-type>
@@ -357,6 +361,22 @@ watchLang((lang) => {
       <var-option :label="t('eat')" />
       <var-option :label="t('sleep')" />
     </var-select>
+    <var-select variant="outlined" :placeholder="t('selectOptions')" v-model="outlinedValue14" :options="options" />
+    <var-select
+      variant="outlined"
+      :placeholder="t('selectOptionsMultiple')"
+      v-model="outlinedValue15"
+      :options="options"
+      multiple
+    />
+    <var-select
+      variant="outlined"
+      :placeholder="t('customFields')"
+      v-model="outlinedValue16"
+      :options="keyOptions"
+      label-key="name"
+      value-key="id"
+    />
   </var-space>
 
   <div class="space"></div>

diff --git a/packages/varlet-ui/src/select/example/locale/en-US.ts b/packages/varlet-ui/src/select/example/locale/en-US.ts
@@ -16,8 +16,8 @@ export default {
   relation: 'Label relation value',
   multiple: 'Multiple Selection',
   chipMultiple: 'Multiple choice of paper style',
-  selectOptions: 'Select Options',
-  selectOptionsMultiple: 'Multiple Select Options',
+  selectOptions: 'Options API',
+  selectOptionsMultiple: 'Options API',
   customFields: 'Custom Fields',
   eat: 'Eat',
   sleep: 'Sleep',

diff --git a/packages/varlet-ui/src/select/example/locale/zh-CN.ts b/packages/varlet-ui/src/select/example/locale/zh-CN.ts
@@ -16,8 +16,8 @@ export default {
   relation: '文本关联值',
   multiple: '多选',
   chipMultiple: '纸片风格的多选',
-  selectOptions: '下拉框选项',
-  selectOptionsMultiple: '下拉框选项（多选）',
+  selectOptions: '选项式 API',
+  selectOptionsMultiple: '选项式 API（多选）',
   customFields: '自定义字段',
   eat: '吃饭',
   sleep: '睡觉',