Skip to content

Commit aa0607b

Browse files
vaebekagol
authored andcommitted
docs(checkbox): checkbox组件文档更新 去除组件 size xs 类型,按钮形态示例优化。
1 parent 18c731a commit aa0607b

File tree

1 file changed

+65
-55
lines changed
  • packages/devui-vue/docs/components/checkbox

1 file changed

+65
-55
lines changed

packages/devui-vue/docs/components/checkbox/index.md

Lines changed: 65 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ export default defineComponent({
9797
.checkbox-basic-demo .devui-checkbox {
9898
margin-bottom: 10px;
9999
}
100+
100101
.checkbox-basic-demo .inline-row .devui-select {
101102
width: 150px;
102103
margin-right: 10px;
@@ -111,6 +112,7 @@ export default defineComponent({
111112
:::demo
112113

113114
```vue
115+
114116
<template>
115117
<div class="checkbox-group-demo">
116118
<h4 class="title">Input Object Array</h4>
@@ -120,7 +122,8 @@ export default defineComponent({
120122
<d-checkbox-group v-model="values2" :options="options2" :isShowTitle="false" direction="row"></d-checkbox-group>
121123
122124
<h4 class="title">Disabled Group</h4>
123-
<d-checkbox-group v-model="values2" :options="options2" :isShowTitle="false" direction="row" :disabled="true"></d-checkbox-group>
125+
<d-checkbox-group v-model="values2" :options="options2" :isShowTitle="false" direction="row" :disabled="true"
126+
></d-checkbox-group>
124127
125128
<h4 class="title">Custom Selected Color</h4>
126129
<d-checkbox-group
@@ -132,10 +135,12 @@ export default defineComponent({
132135
></d-checkbox-group>
133136
134137
<h4 class="title">Set showAnimation false</h4>
135-
<d-checkbox-group v-model="values4" :options="options3" :isShowTitle="false" direction="row" :showAnimation="false"></d-checkbox-group>
138+
<d-checkbox-group v-model="values4" :options="options3" :isShowTitle="false" direction="row" :showAnimation="false"
139+
></d-checkbox-group>
136140
137141
<h4 class="title">Multi-line Checkbox</h4>
138-
<d-checkbox-group v-model="values5" :options="options5" :isShowTitle="false" direction="row" :itemWidth="94"></d-checkbox-group>
142+
<d-checkbox-group v-model="values5" :options="options5" :isShowTitle="false" direction="row" :itemWidth="94"
143+
></d-checkbox-group>
139144
140145
<h4 class="title">可选项目数量的限制</h4>
141146
<d-checkbox-group
@@ -218,39 +223,37 @@ export default defineComponent({
218223
:::demo
219224

220225
```vue
226+
221227
<template>
222-
<div>
223-
<div style="margin-bottom: 10px">
224-
<d-checkbox-group v-model="borderSizeValues1" :options="borderSizeOptions1" direction="row" size="lg" border></d-checkbox-group>
225-
</div>
226-
<div style="margin-bottom: 10px">
227-
<d-checkbox-group v-model="borderSizeValues2" :options="borderSizeOptions1" direction="row" size="md" border></d-checkbox-group>
228-
</div>
229-
<div style="margin-bottom: 10px">
230-
<d-checkbox-group v-model="borderSizeValues3" :options="borderSizeOptions1" direction="row" size="sm" border></d-checkbox-group>
231-
</div>
232-
<div style="margin-bottom: 10px">
233-
<d-checkbox-group v-model="borderSizeValues4" :options="borderSizeOptions1" direction="row" size="xs" border></d-checkbox-group>
234-
</div>
235-
</div>
228+
<h4>Small</h4>
229+
<d-checkbox-group v-model="borderSizeValues1" :options="borderSizeOptions1" direction="row" size="sm" border
230+
></d-checkbox-group>
231+
232+
<h4>Middle</h4>
233+
<d-checkbox-group v-model="borderSizeValues2" :options="borderSizeOptions1" direction="row" size="md" border
234+
></d-checkbox-group>
235+
236+
<h4>Large</h4>
237+
<d-checkbox-group v-model="borderSizeValues3" :options="borderSizeOptions1" direction="row" size="lg" border
238+
></d-checkbox-group>
236239
</template>
237240
<script>
238241
import { defineComponent, ref } from 'vue';
242+
239243
export default defineComponent({
240244
setup() {
241245
const borderSizeOptions1 = ref([
242-
{ name: '选项1', disabled: true, value: '1', id: 1 },
243-
{ name: '选项2', value: '2', id: 2 },
246+
{ name: 'Summer', value: '1', id: 1 },
247+
{ name: 'Spring', disabled: true, value: '2', id: 2 },
244248
]);
245-
const borderSizeValues1 = ref([{ name: '选项2', value: '2', id: 2 }]);
246-
const borderSizeValues2 = ref([{ name: '选项2', value: '2', id: 2 }]);
247-
const borderSizeValues3 = ref([{ name: '选项2', value: '2', id: 2 }]);
248-
const borderSizeValues4 = ref([{ name: '选项2', value: '2', id: 2 }]);
249+
const borderSizeValues1 = ref([{ name: 'Summer', value: '1', id: 1 }]);
250+
const borderSizeValues2 = ref([{ name: 'Summer', value: '1', id: 1 }]);
251+
const borderSizeValues3 = ref([{ name: 'Summer', value: '1', id: 1 }]);
252+
249253
return {
250254
borderSizeValues1,
251255
borderSizeValues2,
252256
borderSizeValues3,
253-
borderSizeValues4,
254257
borderSizeOptions1,
255258
};
256259
},
@@ -262,41 +265,46 @@ export default defineComponent({
262265

263266
### 按钮形态
264267

268+
需要把 `d-checkbox` 替换成 `d-checkbox-button`, 数组源可为普通数组、对象数组等。
269+
265270
:::demo
266271

267272
```vue
273+
268274
<template>
269-
<div>
270-
<div style="margin-bottom: 10px">
271-
<d-checkbox-group v-model="buttonValues1" size="lg" is-show-title color="#FA9841" text-color="#fff">
272-
<d-checkbox-button
273-
v-for="item in buttonOptions1"
274-
:label="item.label"
275-
:value="item.value"
276-
:key="item.value"
277-
:title="item.title"
278-
></d-checkbox-button
279-
></d-checkbox-group>
280-
<d-checkbox-group v-model="buttonValues2" style="margin-top: 10px;">
281-
<d-checkbox-button v-for="item in buttonOptions1" :label="item.label" :value="item.value" :key="item.value"></d-checkbox-button
282-
></d-checkbox-group>
283-
<d-checkbox-group v-model="buttonValues3" size="sm" style="margin-top: 10px;">
284-
<d-checkbox-button
285-
v-for="item in buttonOptions1"
286-
:label="item.label"
287-
:value="item.value"
288-
:key="item.value"
289-
:disabled="item.disabled"
290-
></d-checkbox-button
291-
></d-checkbox-group>
292-
<d-checkbox-group v-model="buttonValues4" size="xs" disabled style="margin-top: 10px;">
293-
<d-checkbox-button v-for="item in buttonOptions1" :label="item.label" :value="item.value" :key="item.value"></d-checkbox-button
294-
></d-checkbox-group>
295-
</div>
296-
</div>
275+
<h4>禁用</h4>
276+
<d-checkbox-group v-model="buttonValues1" size="sm" direction="row">
277+
<d-checkbox-button
278+
v-for="item in buttonOptions1"
279+
:label="item.label"
280+
:value="item.value"
281+
:key="item.value"
282+
:disabled="item.disabled"
283+
>
284+
</d-checkbox-button>
285+
</d-checkbox-group>
286+
287+
<h4>默认</h4>
288+
<d-checkbox-group v-model="buttonValues2" direction="row">
289+
<d-checkbox-button v-for="item in buttonOptions1" :label="item.label" :value="item.value" :key="item.value"
290+
></d-checkbox-button>
291+
</d-checkbox-group>
292+
293+
<h4>自定义填充颜色、文字颜色</h4>
294+
<d-checkbox-group v-model="buttonValues3" size="lg" is-show-title color="#FA9841" text-color="#fff" direction="row">
295+
<d-checkbox-button
296+
v-for="item in buttonOptions1"
297+
:label="item.label"
298+
:value="item.value"
299+
:key="item.value"
300+
:title="item.title"
301+
>
302+
</d-checkbox-button>
303+
</d-checkbox-group>
297304
</template>
298305
<script>
299306
import { defineComponent, ref } from 'vue';
307+
300308
export default defineComponent({
301309
setup() {
302310
const buttonOptions1 = ref([
@@ -307,12 +315,11 @@ export default defineComponent({
307315
const buttonValues1 = ref([2]);
308316
const buttonValues2 = ref([2]);
309317
const buttonValues3 = ref([2]);
310-
const buttonValues4 = ref([2]);
318+
311319
return {
312320
buttonValues1,
313321
buttonValues2,
314322
buttonValues3,
315-
buttonValues4,
316323
buttonOptions1,
317324
};
318325
},
@@ -328,6 +335,7 @@ export default defineComponent({
328335
:::demo
329336

330337
```vue
338+
331339
<template>
332340
<div style="margin-bottom: 10px">
333341
<d-checkbox
@@ -350,6 +358,7 @@ export default defineComponent({
350358
</template>
351359
<script>
352360
import { defineComponent, ref } from 'vue';
361+
353362
export default defineComponent({
354363
setup() {
355364
const checkboxChecked1 = ref(true);
@@ -381,6 +390,7 @@ export default defineComponent({
381390
:::demo
382391

383392
```vue
393+
384394
<template>
385395
<div>
386396
<d-checkbox-group
@@ -487,5 +497,5 @@ export default defineComponent({
487497
#### ICheckboxSize
488498

489499
```ts
490-
type ICheckboxSize = 'lg' | 'md' | 'sm' | 'xs';
500+
type ICheckboxSize = 'lg' | 'md' | 'sm';
491501
```

0 commit comments

Comments
 (0)