vue API文档

vue 应用实例 API

createApp() 创建一个应用程序实例

createSSRApp() 在 SSR Hydration 模式下创建应用程序实例

app.mount() 挂载

app.unmount() 卸载

app.use() 安装插件

app.component() 全局组件

app.provide() 提供

app.directive() 自定义指令

app.version 版本

app.config 应用程序配置

vue 全局统用 API

nextTick() 等待 DOM 更新后执行

defineComponent() 类型推断

defineAsyncComponent() 定义在渲染时延迟加载的异步组件

defineCustomElement() 自定义元素

vue 响应式 API

setup()

ref() 返回响应式 ref 对象

reactive() 响应式代理

computed() 计算属性

readonly() 只读属性

watch() 侦听器

watchEffect() 效应侦听器

isRef() 检查 ref 对象

unref() 返回值

toRef() 同步响应式

toRefs() 转换为普通对象

isProxy() 检查代理

isReactive() 检测代理

isReadonly() 检测只读

shallowRef() 浅层响应式 ref()

shallowReactive() 浅版本的reactive()

shallowReadonly() 浅层 readonly

triggerRef() 强制触发与 ref 关联的 effect 效应

customRef() 自定义 ref

toRaw() 返回原始代理对象

markRaw() 标记原始对象

effectScope() effect 作用域

getCurrentScope() 返回当前活跃的 effect 作用域

onScopeDispose() 当前 effect 上，注册回调

vue 生命周期钩子 API

onBeforeMount() 挂载组件之前调用

onMounted() 组件挂载后调用

onBeforeUpdate() 组件更新之前调用

onUpdated() 更新 DOM 后调用

onBeforeUnmount() 卸载之前调用

onUnmounted() 卸载组件后调用

onErrorCaptured() 捕获后代组件错误时调用

onRenderTracked() 渲染跟踪到响应性依赖时调用

onRenderTriggered() 响应式依赖触发渲染时调用

onActivated() 启动 KeepAlive 时调用

onDeactivated() 删除 KeepAlive 后调用

onServerPrefetch() 服务器上呈现组件实例之前调用

vue 内置指令 API

v-text 更新元素的文本内容

v-html 更新元素的innerHTML

v-pre 显示原始 Mustache 标签

v-cloak 设置样式

v-slot 插槽

v-show 切换元素的隐现

v-on 绑定事件监听器

v-bind 动态绑定

v-model 双向绑定

v-for 渲染元素或模板块

v-once 只渲染元素和组件一次

v-is 检测动态组件

v-if 条件渲染

v-else 动态条件渲染 else块

v-else-if 表示 v-if 的else if 块

vue 特殊属性 API

is 使用动态组件

key key属性

ref ref 被用来给元素或子组件注册引用信息

vue 内置组件 API

<component> 渲染动态组件

<transition> 渲染过度效果

<transition-group> 多列表过渡

<keep-alive> 会缓存不活动的组件实例

<slot> 内容分发插槽

<teleport> 封装组件

<Suspense> 编排组件树中的嵌套异步依赖项

vue 依赖注入 API

provide() 提供

inject() 注入

vue 渲染函数 API

h() 创建虚拟节点

mergeProps() 合并 props 对象

cloneVNode() 克隆虚拟节点

isVNode() 检测虚拟节点

resolveComponent() 解析组件

resolveDirective() 解析指令

withDirectives() 向虚拟节点添加自定指令

withModifiers() 给事件处理函数添加修饰符

createRenderer() 自定义渲染器

vue 服务器渲染函数 API

renderToString() 服务器渲染

renderToNodeStream() 渲染节点流

pipeToNodeWritable() 将输入渲染为 Node.js 可读流。

renderToWebStream() 将输入呈现为Web可读流

pipeToWebWritable() 通过管道输出 web 实例

SimpleStream() 输出简单的数据流

useSSRContext() 检测上下文对象

vue TypeScript 工具类 API

PropType<T> 注解 props 类型

ComponentCustomProperties 自定义组件属性

ComponentCustomOptions 自定义组件选项

ComponentCustomProps 自定义组件 props

CSSProperties 用于增加样式属性绑定中的允许值