types(CheckboxGroup): add CheckboxGroupInstance type (#9142)

This commit is contained in:
neverland
2021-07-28 17:56:25 +08:00
committed by GitHub
parent 4dd03edf76
commit 82bed7711c
4 changed files with 33 additions and 8 deletions
+4 -2
View File
@@ -329,15 +329,17 @@ Use [ref](https://v3.vuejs.org/guide/component-template-refs.html) to get Checkb
### Types
Get the type definition of the Checkbox instance through `CheckboxInstance`.
Get the type definition of the Checkbox instance through `CheckboxInstance` and `CheckboxGroupInstance`.
```ts
import { ref } from 'vue';
import type { CheckboxInstance } from 'vant';
import type { CheckboxInstance, CheckboxGroupInstance } from 'vant';
const checkboxRef = ref<CheckboxInstance>();
const checkboxGroupRef = ref<CheckboxGroupInstance>();
checkboxRef.value?.toggle();
checkboxGroupRef.value?.toggleAll();
```
### CSS Variables
+5 -3
View File
@@ -345,17 +345,19 @@ checkboxGroup.toggleAll({
| --- | --- | --- | --- |
| toggle | 切换选中状态,传 `true` 为选中,`false` 为取消选中,不传参为取反 | _checked?: boolean_ | - |
### Checkbox 类型定义
### 类型定义
通过 `CheckboxInstance` 获取 Checkbox 实例的类型定义。
通过 `CheckboxInstance``CheckboxGroupInstance` 获取 Checkbox 实例的类型定义。
```ts
import { ref } from 'vue';
import type { CheckboxInstance } from 'vant';
import type { CheckboxInstance, CheckboxGroupInstance } from 'vant';
const checkboxRef = ref<CheckboxInstance>();
const checkboxGroupRef = ref<CheckboxGroupInstance>();
checkboxRef.value?.toggle();
checkboxGroupRef.value?.toggleAll();
```
### 样式变量