# Mpx 框架

> 深度性能优化的增强型小程序开发框架

良好的开发体验，极致的应用性能，完整的原生兼容，一份源码跨端输出所有小程序平台及Web。

## Table of Contents

### 基础

- [介绍 {#intro}](/guide/basic/intro.md)
- [快速开始 {#quick-start}](/guide/basic/start.md)
- [IDE 支持 {#ide-support}](/guide/basic/ide.md)
- [项目结构 {#project-structure}](/guide/basic/project-structure.md)
- [创建 App {#create-app}](/guide/basic/app.md)
- [创建页面 {#create-page}](/guide/basic/page.md)
- [创建组件 {#create-component}](/guide/basic/component.md)
- [单文件开发 {#single-file-development}](/guide/basic/single-file.md)
- [数据响应 {#reactivity}](/guide/basic/reactive.md)
- [Mpx 生命周期 {#lifecycle}](/guide/basic/lifecycle.md)
- [模板语法 {#template-syntax}](/guide/basic/template.md)
- [数据绑定 {#data-binding}](/guide/basic/data-binding.md)
- [类名样式绑定 {#class-style-binding}](/guide/basic/class-style-binding.md)
- [条件渲染 {#conditional-render}](/guide/basic/conditional-render.md)
- [列表渲染 {#list-render}](/guide/basic/list-render.md)
- [事件处理 {#event-handling}](/guide/basic/event.md)
- [双向绑定 {#two-way-binding}](/guide/basic/two-way-binding.md)
- [获取组件实例/节点信息 {#get-component-instance-node-info}](/guide/basic/refs.md)
- [样式定义 {#style-definition}](/guide/basic/css.md)

### 进阶

- [状态管理（store） {#store}](/guide/advance/store.md)
- [状态管理（pinia） {#pinia}](/guide/advance/pinia.md)
- [依赖注入（Provide/Inject） {#provide-inject}](/guide/advance/provide-inject.md)
- [使用 mixin {#use-mixin}](/guide/advance/mixin.md)
- [使用npm {#use-npm}](/guide/advance/npm.md)
- [使用分包 {#use-subpackage}](/guide/advance/subpackage.md)
- [分包异步化 {#subpackage-async}](/guide/advance/async-subpackage.md)
- [国际化i18n {#i18n}](/guide/advance/i18n.md)
- [包体积分析 {#bundle-size-analysis}](/guide/advance/size-report.md)
- [RN 运行时按需测速 {#rn-runtime-perf-probe}](/guide/advance/perf.md)
- [图像资源处理 {#image-processing}](/guide/advance/image-process.md)
- [原生渐进迁移 {#native-progressive-migration}](/guide/advance/progressive.md)
- [原生能力兼容 {#native-ability-compatible}](/guide/advance/ability-compatible.md)
- [小程序插件 {#miniprogram-plugin}](/guide/advance/plugin.md)
- [自定义路径 {#custom-path}](/guide/advance/custom-output-path.md)
- [使用原子类 {#use-utility-class}](/guide/advance/utility-first-css.md)
- [SSR](/guide/advance/ssr.md)
- [脚手架工具 {#cli}](/guide/advance/cli.md)

### 跨端基础

- [跨端输出配置 {#cross-platform-output-config}](/guide/cross-platform/basic.md)
- [条件编译机制 {#conditional-compile-mechanism}](/guide/cross-platform/conditional.md)

### 跨端 RN

- [快速开始 {#quick-start}](/guide/rn/start.md)
- [组件使用与开发 {#component-usage-development}](/guide/rn/component.md)
- [模板语法与生命周期 {#template-syntax-lifecycle}](/guide/rn/template.md)
- [跨端样式 {#cross-platform-style}](/guide/rn/style.md)
- [应用能力 {#application-ability}](/guide/rn/application-api.md)
- [混合编写 RN {#hybrid-rn}](/guide/rn/hybrid-with-react-native.md)

### 组合式 API

- [组合式 API {#composition-api}](/guide/composition-api/composition-api.md)
- [响应式 API {#reactive-api}](/guide/composition-api/reactive-api.md)

### 工具

- [单元测试 {#unit-test}](/guide/tool/unit-test.md)
- [E2E自动化测试 {#e2e-test}](/guide/tool/e2e-test.md)

### 拓展

- [网络请求 {#network-request}](/guide/extend/fetch.md)
- [webview-bridge](/guide/extend/webview-bridge.md)

### 理解

- [Mpx运行时增强原理 {#runtime-enhancement-principle}](/guide/understand/runtime.md)
- [Mpx编译构建原理 {#compile-principle}](/guide/understand/compile.md)

### 迁移

- [从 2.8 升级至 2.9 {#upgrade-2.8-to-2.9}](/guide/migrate/2.9.md)
- [从 2.7 升级至 2.8 {#upgrade-2.7-to-2.8}](/guide/migrate/2.8.md)
- [从旧版本迁移至 2.7 {#migrate-to-2.7}](/guide/migrate/2.7.md)
- [mpx-cli v2 迁移到 v3 {#migrate-v2-to-v3}](/guide/migrate/mpx-cli-3.md)

### 框架 API

- [全局配置 {#global-config}](/api/app-config.md)
- [全局 API {#global-api}](/api/global-api.md)
- [实例 API {#instance-api}](/api/instance-api.md)
- [Store API](/api/store-api.md)
- [模板指令 {#template-directives}](/api/directives.md)
- [编译构建 {#compile-build}](/api/compile.md)
- [内建组件 {#built-in-components}](/api/builtIn.md)
- [响应式 API {#reactivity-api}](/api/reactivity-api.md)
- [组合式 API {#composition-api}](/api/composition-api.md)
- [选项式 API {#optional-api}](/api/optional-api.md)
- [周边拓展 {#extensions}](/api/extend.md)

### 环境 API

#### 基础

- [Untitled](/api-proxy/base/base64ToArrayBuffer.md)
- [Untitled](/api-proxy/base/arrayBufferToBase64.md)

##### 系统

- [Untitled](/api-proxy/base/system/getSystemInfo.md)
- [Untitled](/api-proxy/base/system/getSystemInfoSync.md)
- [Untitled](/api-proxy/base/system/getWindowInfo.md)
- [Untitled](/api-proxy/base/system/getDeviceInfo.md)

##### 小程序

###### 生命周期

- [Untitled](/api-proxy/base/app/life-cycle/getEnterOptionsSync.md)
- [Untitled](/api-proxy/base/app/life-cycle/getLaunchOptionsSync.md)

###### 应用级事件

- [Untitled](/api-proxy/base/app/app-event/onAppShow.md)
- [Untitled](/api-proxy/base/app/app-event/onAppHide.md)
- [Untitled](/api-proxy/base/app/app-event/offAppShow.md)
- [Untitled](/api-proxy/base/app/app-event/offAppHide.md)
- [Untitled](/api-proxy/base/app/app-event/onError.md)
- [Untitled](/api-proxy/base/app/app-event/offError.md)
- [Untitled](/api-proxy/base/app/app-event/onUnhandledRejection.md)
- [Untitled](/api-proxy/base/app/app-event/offUnhandledRejection.md)
- [Untitled](/api-proxy/base/app/app-event/onLazyLoadError.md)
- [Untitled](/api-proxy/base/app/app-event/offLazyLoadError.md)

#### 路由

- [Untitled](/api-proxy/route/navigateTo.md)
- [Untitled](/api-proxy/route/redirectTo.md)
- [Untitled](/api-proxy/route/switchTab.md)
- [Untitled](/api-proxy/route/reLaunch.md)
- [Untitled](/api-proxy/route/navigateBack.md)

#### 界面

##### 交互

- [Untitled](/api-proxy/interface/interactive/showActionSheet.md)
- [Untitled](/api-proxy/interface/interactive/showModal.md)
- [Untitled](/api-proxy/interface/interactive/enableAlertBeforeUnload.md)
- [Untitled](/api-proxy/interface/interactive/disableAlertBeforeUnload.md)
- [Untitled](/api-proxy/interface/interactive/showToast.md)
- [Untitled](/api-proxy/interface/interactive/hideToast.md)
- [Untitled](/api-proxy/interface/interactive/showLoading.md)
- [Untitled](/api-proxy/interface/interactive/hideLoading.md)

##### 导航栏

- [Untitled](/api-proxy/interface/navigation-bar/hideHomeButton.md)
- [Untitled](/api-proxy/interface/navigation-bar/setNavigationBarTitle.md)
- [Untitled](/api-proxy/interface/navigation-bar/setNavigationBarColor.md)

##### Tab Bar

- [Untitled](/api-proxy/interface/tab-bar/hideTabBar.md)
- [Untitled](/api-proxy/interface/tab-bar/showTabBar.md)
- [Untitled](/api-proxy/interface/tab-bar/setTabBarStyle.md)
- [Untitled](/api-proxy/interface/tab-bar/setTabBarItem.md)

##### 下拉刷新

- [Untitled](/api-proxy/interface/pull-down-refresh/stopPullDownRefresh.md)
- [Untitled](/api-proxy/interface/pull-down-refresh/startPullDownRefresh.md)

##### 滚动

- [Untitled](/api-proxy/interface/scroll/pageScrollTo.md)

##### 动画

- [Untitled](/api-proxy/interface/animation/createAnimation.md)

##### 自定义组件

- [Untitled](/api-proxy/interface/custom-component/nextTick.md)

##### 菜单

- [Untitled](/api-proxy/interface/menu/getMenuButtonBoundingClientRect.md)

##### 窗口

- [Untitled](/api-proxy/interface/window/onWindowResize.md)
- [Untitled](/api-proxy/interface/window/offWindowResize.md)

#### 网络

##### 发起请求

- [Untitled](/api-proxy/network/request/request.md)

##### 下载

- [Untitled](/api-proxy/network/download/downloadFile.md)

##### 上传

- [Untitled](/api-proxy/network/upload/uploadFile.md)

##### WebSocket

- [Untitled](/api-proxy/network/websocket/connectSocket.md)

#### 支付

- [Untitled](/api-proxy/payment/requestPayment.md)

#### 数据缓存

- [Untitled](/api-proxy/storage/setStorage.md)
- [Untitled](/api-proxy/storage/setStorageSync.md)
- [Untitled](/api-proxy/storage/getStorage.md)
- [Untitled](/api-proxy/storage/getStorageSync.md)
- [Untitled](/api-proxy/storage/removeStorage.md)
- [Untitled](/api-proxy/storage/removeStorageSync.md)
- [Untitled](/api-proxy/storage/clearStorage.md)
- [Untitled](/api-proxy/storage/clearStorageSync.md)
- [Untitled](/api-proxy/storage/getStorageInfo.md)
- [Untitled](/api-proxy/storage/getStorageInfoSync.md)

#### 画布

- [Untitled](/api-proxy/canvas/canvasToTempFilePath.md)
- [Untitled](/api-proxy/canvas/canvasGetImageData.md)

#### 媒体

##### 音频

- [Untitled](/api-proxy/media/audio/createInnerAudioContext.md)

##### 图片

- [Untitled](/api-proxy/media/image/previewImage.md)
- [Untitled](/api-proxy/media/image/compressImage.md)
- [Untitled](/api-proxy/media/image/getImageInfo.md)

##### 视频

- [Untitled](/api-proxy/media/video/chooseMedia.md)

#### 位置

- [Untitled](/api-proxy/location/getLocation.md)
- [Untitled](/api-proxy/location/chooseLocation.md)
- [Untitled](/api-proxy/location/openLocation.md)
- [Untitled](/api-proxy/location/onLocationChange.md)
- [Untitled](/api-proxy/location/offLocationChange.md)
- [Untitled](/api-proxy/location/startLocationUpdate.md)
- [Untitled](/api-proxy/location/stopLocationUpdate.md)

#### 开放接口

##### 登录

- [Untitled](/api-proxy/open-api/login/login.md)
- [Untitled](/api-proxy/open-api/login/checkSession.md)

##### 用户信息

- [Untitled](/api-proxy/open-api/user-info/getUserInfo.md)

##### 设置

- [Untitled](/api-proxy/open-api/setting/getSetting.md)
- [Untitled](/api-proxy/open-api/setting/openSetting.md)

#### 设备

##### 联系人

- [Untitled](/api-proxy/device/contacts/addPhoneContact.md)

##### 蓝牙-低功耗中心设备

- [Untitled](/api-proxy/device/bluetooth-ble/closeBLEConnection.md)
- [Untitled](/api-proxy/device/bluetooth-ble/createBLEConnection.md)
- [Untitled](/api-proxy/device/bluetooth-ble/onBLEConnectionStateChange.md)

##### 剪贴板

- [Untitled](/api-proxy/device/clipboard/setClipboardData.md)
- [Untitled](/api-proxy/device/clipboard/getClipboardData.md)

##### 网络

- [Untitled](/api-proxy/device/network/getNetworkType.md)
- [Untitled](/api-proxy/device/network/onNetworkStatusChange.md)
- [Untitled](/api-proxy/device/network/offNetworkStatusChange.md)

##### 屏幕

- [Untitled](/api-proxy/device/screen/getScreenBrightness.md)
- [Untitled](/api-proxy/device/screen/setScreenBrightness.md)
- [Untitled](/api-proxy/device/screen/setVisualEffectOnCapture.md)
- [Untitled](/api-proxy/device/screen/onUserCaptureScreen.md)
- [Untitled](/api-proxy/device/screen/offUserCaptureScreen.md)

##### 键盘

- [Untitled](/api-proxy/device/keyboard/hideKeyboard.md)
- [Untitled](/api-proxy/device/keyboard/onKeyboardHeightChange.md)
- [Untitled](/api-proxy/device/keyboard/offKeyboardHeightChange.md)

##### 电话

- [Untitled](/api-proxy/device/phone/makePhoneCall.md)

##### 扫码

- [Untitled](/api-proxy/device/scan/scanCode.md)

##### 震动

- [Untitled](/api-proxy/device/vibrate/vibrateShort.md)
- [Untitled](/api-proxy/device/vibrate/vibrateLong.md)

#### WXML

- [Untitled](/api-proxy/wxml/createIntersectionObserver.md)
- [Untitled](/api-proxy/wxml/createSelectorQuery.md)

#### 第三方平台

- [Untitled](/api-proxy/ext/getExtConfig.md)
- [Untitled](/api-proxy/ext/getExtConfigSync.md)

### 文章

- [滴滴开源小程序框架Mpx {#didi-open-source-mpx}](/articles/1.0.md)
- [滴滴小程序框架Mpx发布2.0，支持小程序跨平台开发，可直接转换已有微信小程序](/articles/2.0.md)
- [小程序框架运行时性能大测评 {#runtime-performance-benchmark}](/articles/performance.md)
- [小程序开发者，为什么你应该尝试下MPX](/articles/mpx1.md)
- [Mpx 小程序框架技术揭秘 {#mpx-tech-reveal}](/articles/mpx2.md)
- [滴滴出行小程序体积优化实践 {#size-control-practice}](/articles/size-control.md)
- [使用Typescript新特性Template Literal Types完善链式key的类型推导](/articles/ts-derivation.md)
- [Mpx2.7 版本正式发布，大幅提升编译构建速度 {#mpx-2-7-release}](/articles/2.7-release.md)
- [Mpx2.8 版本正式发布，使用组合式 API 开发小程序](/articles/2.8-release.md)
- [Mpx2.9 版本正式发布，支持原子类、SSR 和包体积优化 {#mpx-2-9-release}](/articles/2.9-release.md)
- [小程序跨端组件库 Mpx-cube-ui 开源啦 {#mpx-cube-ui-open-source}](/articles/mpx-cube-ui.md)
- [@mpxjs/cli 插件化改造 {#mpx-cli-plugin-transformation}](/articles/mpx-cli-next.md)
- [Mpx 小程序单元测试能力建设与实践 {#unit-test-capability-construction}](/articles/unit-test.md)

### Other

- [Mpx2.9 版本正式发布，支持原子类、SSR 和包体积优化 {#mpx-2-9-release}](/articles/2.9-release-alter.md)
- [Mpx框架相关文章 {#mpx-articles}](/articles.md)
- [Untitled](/CLAUDE.md)
- [Untitled](/api-proxy/media/video/createVideoContext.md)
- [使用 DllPlugin {#use-dll-plugin}](/guide/advance/dll-plugin.md)
- [使用TypeScript开发小程序 {#use-ts}](/guide/advance/ts.md)
- [扩展mpx {#extend-mpx}](/guide/extend.md)
- [文档写作指南](/desc.md)
- [文档开发指南](/AGENTS.md)
- [无障碍访问{#accessibility}](/guide/advance/accessibility.md)
- [资源路径获取 {#resource-path-resolve}](/guide/advance/resource-resolve.md)
- [跨平台 {#cross-platform}](/guide/advance/platform.md)
- [通过 Mpx 使用组合式 API 进行小程序开发](/articles/2.8-release-alter.md)