API 参考

本章节提供 Vitarx 框架的完整 API 参考，按功能模块分类。

应用实例

创建和管理应用实例。

• createApp() — 创建 Web 应用
• createSSRApp() — 创建 SSR 应用
• app.mount() — 挂载应用
• app.unmount() — 卸载应用
• app.directive() — 注册/获取指令
• app.provide() — 提供依赖
• app.inject() — 注入依赖
• app.use() — 安装插件
• app.config — 应用配置
• app.version — 框架版本

生命周期钩子

组件生命周期管理。

• onInit() — 初始化
• onBeforeMount() — 挂载前
• onMounted() — 挂载后
• onShow() — 显示
• onHide() — 隐藏
• onDispose() — 销毁
• onError() — 错误捕获
• onViewSwitch() — 视图切换

响应式系统

核心

创建响应式数据。

• ref() — 响应式引用
• shallowRef() — 浅层响应式引用
• reactive() — 响应式对象
• shallowReactive() — 浅层响应式对象
• computed() — 计算属性
• readonly() — 只读代理
• shallowReadonly() — 浅层只读代理

工具

响应式数据转换与判断。

• toRef() — 属性转 ref
• toRefs() — 对象转 refs
• toValue() — 获取值
• unref() — toValue 别名
• toRaw() — 获取原始对象
• markRaw() — 标记为原始
• isRef() — 判断 ref
• isReactive() — 判断 reactive
• isReadonly() — 判断 readonly
• isComputed() — 判断 computed
• untrack() — 无依赖执行

监听器

监听响应式数据变化。

• watch() — 监听器
• watchEffect() — 副作用监听
• watchPostEffect() — DOM 更新后监听
• watchSyncEffect() — 同步监听

作用域

副作用作用域管理。

• EffectScope — 作用域类
• onScopeDispose() — 作用域销毁回调
• onScopePause() — 作用域暂停回调
• onScopeResume() — 作用域恢复回调

调度

• nextTick() — 下一次更新周期

组件 API

Hooks

组件内使用的组合式函数。

• useId() — 生成唯一 ID
• useModel() — 双向绑定
• useRef() — DOM/组件引用
• useApp() — 获取应用实例
• useInstance() — 获取组件实例
• useView() — 获取视图对象
• useChildren() — 获取子组件
• useFastChild() — 获取首个子组件
• useSuspense() — 获取 Suspense 上下文

定义

• defineExpose() — 暴露实例属性
• defineValidate() — 定义属性验证

依赖注入

• provide() — 提供依赖
• inject() — 注入依赖

内置组件

• Suspense — 异步加载
• For — 列表渲染
• Freeze — 视图冻结
• Lazy — 懒加载
• Transition — 过渡动画
• Teleport — 传送门
• Head — 头部管理

视图构建

• h() — 创建视图节点
• dynamic() — 动态渲染
• mergeProps() — 合并属性
• Fragment — 片段容器
• Dynamic — 动态组件
• Comment — 注释节点
• PlainText — 纯文本节点

指令系统

• withDirectives() — 应用指令
• defineDirective() — 定义指令

服务端渲染

• createSSRApp() — 创建 SSR 应用
• renderToString() — 渲染为字符串
• renderToStream() — 流式渲染
• hydrate() — 水合
• isSSR() — 判断 SSR 环境
• isHydrating() — 判断水合中
• useSSRContext() — 获取 SSR 上下文