mirror of
https://github.com/youzan/vant.git
synced 2026-05-18 01:01:06 +08:00
docs: translate useToggle (#8822)
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
# useToggle
|
||||
|
||||
### Intro
|
||||
|
||||
Used to switch between `true` and `false`.
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```js
|
||||
import { useToggle } from '@vant/use';
|
||||
|
||||
export default {
|
||||
setup() {
|
||||
const [state, toggle] = useToggle();
|
||||
|
||||
toggle(true);
|
||||
console.log(state.value); // -> true
|
||||
|
||||
toggle(false);
|
||||
console.log(state.value); // -> false
|
||||
|
||||
toggle();
|
||||
console.log(state.value); // -> true
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### Default Value
|
||||
|
||||
```js
|
||||
import { useToggle } from '@vant/use';
|
||||
|
||||
export default {
|
||||
setup() {
|
||||
const [state, toggle] = useToggle(true);
|
||||
console.log(state.value); // -> true
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### Type Declarations
|
||||
|
||||
```ts
|
||||
function useToggle(
|
||||
defaultValue: boolean
|
||||
): [Ref<boolean>, (newValue: boolean) => void];
|
||||
```
|
||||
|
||||
### Params
|
||||
|
||||
| Name | Description | Type | Default Value |
|
||||
| ------------ | ------------- | --------- | ------------- |
|
||||
| defaultValue | Default value | _boolean_ | `false` |
|
||||
|
||||
### Return Value
|
||||
|
||||
| Name | Description | Type |
|
||||
| ------ | ------------------------ | ------------------------------ |
|
||||
| state | State | _Ref\<boolean>_ |
|
||||
| toggle | Function to switch state | _(newValue?: boolean) => void_ |
|
||||
@@ -0,0 +1,23 @@
|
||||
# Composables
|
||||
|
||||
### Intro
|
||||
|
||||
Vant provide some built-in composition APIs, you can directly use these APIs for development.
|
||||
|
||||
### Demo
|
||||
|
||||
```js
|
||||
import { useWindowSize } from '@vant/use';
|
||||
|
||||
const { width, height } = useWindowSize();
|
||||
|
||||
console.log(width.value); // -> window width
|
||||
console.log(height.value); // -> window height
|
||||
```
|
||||
|
||||
### API List
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| [useCountDown](#/en-US/use-count-down) | Used to manage the countdown |
|
||||
| [useToggle](#/en-US/use-toggle) | Used to switch between `true` and `false` |
|
||||
Reference in New Issue
Block a user