Vant4 介绍
介绍
Vant 底层依赖了 @vant/use
包,其中内置了一系列的组合式 API。对于使用了 Vant 的项目,可以复用这些 API 进行开发。
安装
虽然 Vant 的依赖中已经包含了 @vant/use
,但我们仍然推荐显式地安装它:
# with npm
npm i @vant/use
# with yarn
yarn add @vant/use
# with pnpm
pnpm add @vant/use
示例
下面是一个 Vant 组合式 API 的用法示例,我们从 @vant/use
这个包中引入 useWindowSize
方法,然后进行调用,即可获取到当前 Window 的宽度和高度。
import { useWindowSize } from '@vant/use';
const { width, height } = useWindowSize();
console.log(width.value); // -> 窗口宽度
console.log(height.value); // -> 窗口高度
API 列表
下面是 Vant 对外提供的所有组合式 API,点击名称可以查看详细介绍:
名称 | 描述 |
---|---|
useClickAway | 监听点击元素外部的事件 |
useCountDown | 提供倒计时管理能力 |
useCustomFieldValue | 自定义表单组件中的表单项 |
useEventListener | 方便地进行事件绑定 |
usePageVisibility | 获取页面的可见状态 |
useRect | 获取元素的大小及其相对于视口的位置 |
useRelation | 建立父子组件之间的关联关系 |
useScrollParent | 获取元素最近的可滚动父元素 |
useToggle | 用于在布尔值之间进行切换 |
useWindowSize | 获取浏览器窗口的视口宽度和高度 |