组合式 API

介绍

Vant 内置了一系列的组合式 API,对于安装了 vant 的项目,可以直接使用这些 API 进行开发。

示例

下面是一个 Vant 组合式 API 的用法示例,我们从 @vant/use 这个包中引入 useWindowSize 方法,然后进行调用,即可获取到当前 Window 的宽度和高度。

  1. import { useWindowSize } from '@vant/use';
  2. const { width, height } = useWindowSize();
  3. console.log(width.value); // -> 窗口宽度
  4. console.log(height.value); // -> 窗口高度

API 列表

下面是 Vant 对外提供的所有组合式 API,点击名称可以查看详细介绍:

名称描述
useClickAway监听点击元素外部的事件
useCountDown提供倒计时管理能力
useEventListener方便地进行事件绑定
usePageVisibility获取页面的可见状态
useRect获取元素的大小及其相对于视口的位置
useRelation建立父子组件之间的关联关系
useScrollParent获取元素最近的可滚动父元素
useToggle用于在布尔值之间进行切换
useWindowSize获取浏览器窗口的视口宽度和高度

介绍 - 图1