Vue 3 API
本栏目为 Vue 3 官方 API 参考(API Reference)的中文镜像,按官网目录完整收录,覆盖应用实例、选项式 API、组合式 API、响应式 API、内置指令/组件、单文件组件与类型工具等全部 API 页面。
内容源:https://cn.vuejs.org/api/(原样收录,含全部类型签名与示例代码)。
应用实例(Application API)
- 应用实例 API —
createApp()、app.mount()与应用配置(app.config.*)
全局 API:常规(General)
- 全局 API:常规 —
version、nextTick()、defineComponent()、defineAsyncComponent()
组合式 API(Composition API)
- setup() — 组件入口函数:参数、Setup 上下文与渲染函数配合
- 生命周期钩子 —
onMounted()、onUpdated()、onBeforeUnmount()等 - 依赖注入 —
provide()、inject()、hasInjectionContext() - 辅助 —
useAttrs()、useSlots()、useModel()、useTemplateRef()、useId()
响应式 API(Reactivity API)
- 核心 —
ref()、computed()、reactive()、readonly()、watch()等 - 工具函数 —
isRef()、unref()、toRef()、toRefs()、toValue()等 - 进阶 —
shallowRef()、customRef()、effectScope()、toRaw()等
选项式 API(Options API)
- 状态选项 —
data、props、computed、methods、watch、emits、expose - 渲染选项 —
template、render、compilerOptions、slots - 生命周期选项 —
beforeCreate、created、mounted、unmounted等 - 组合选项 —
provide/inject、mixins、extends - 其他杂项选项 —
name、inheritAttrs、customDirectives、delimiters
组件实例(Component Instance)
- 组件实例 —
$data、$props、$attrs、$refs、$emit等实例属性与方法
内置内容(Built-ins)
- 内置指令 —
v-text、v-html、v-show、v-model、v-if、v-for等 - 内置组件 —
<Transition>、<KeepAlive>、<Teleport>、<Suspense> - 内置特殊元素 —
<component>、<slot> - 内置的特殊 Attributes —
key、ref、is
单文件组件(SFC)
- 语法定义 — 语言块、命名约定与结构规则
- <script setup> — 编译时语法糖与全部编译宏
- CSS 功能 — scoped 样式、
:slotted()、CSSv-bind()、CSS Modules
进阶与类型(Advanced)
- 自定义元素 API — 应用级自定义元素配置
- 渲染函数 API —
h()、mergeProps()、cloneVNode()等 - 服务端渲染 API — SSR 专用的
useSSRContext()等 - TypeScript 工具类型 —
MaybeRef、PropType、ExtractPropTypes等 - 自定义渲染器 API —
createRenderer()与渲染器选项 - 编译时标志 —
__VUE_OPTIONS_API__、__VUE_PROD_DEVTOOLS__等
参考
- 上一级栏目:Vue 3 官方指南镜像(用法与概念详解)
- 官网在线版(含交互式演练场与 API 过滤):https://cn.vuejs.org/api/
- 本栏目源文件同步自官方文档仓库,构建于 VitePress。