146 lines
7.4 KiB
Markdown
146 lines
7.4 KiB
Markdown
---
|
||
name: "wechat-miniprogram"
|
||
displayName: "微信小程序官方文档"
|
||
description: "微信小程序开发官方文档查询工具，覆盖框架、组件、API、服务端、自定义组件等全部开发知识。当需要查阅小程序开发细节时，按需加载对应领域的 steering 文件获取权威参考。"
|
||
keywords: ["微信小程序", "miniprogram", "wxml", "wxss", "wx.request", "小程序组件", "小程序API", "Page", "Component", "getApp", "小程序生命周期", "小程序登录", "小程序支付", "weixin", "wechat", "tdesign", "t-button", "t-cell", "t-dialog", "t-toast", "t-navbar", "t-tabs", "t-popup", "t-input", "t-picker", "t-tag", "t-search", "t-empty", "t-loading", "t-skeleton", "t-tab-bar", "t-avatar", "t-badge", "t-image"]
|
||
author: "NeoZQYY"
|
||
---
|
||
|
||
# 微信小程序官方文档
|
||
|
||
## Overview
|
||
|
||
本 Power 是微信小程序官方开发文档的结构化知识库，覆盖框架核心概念、视图层、逻辑层、自定义组件、内置组件、前端 API、服务端 API 等全部开发领域。
|
||
|
||
当 AI 需要回答小程序相关问题时，应根据问题领域加载对应的 steering 文件，获取官方文档的权威内容，而非依赖可能过时的训练数据。
|
||
|
||
官方文档入口：https://developers.weixin.qq.com/miniprogram/dev/framework/
|
||
|
||
## 文档结构与 Steering 文件索引
|
||
|
||
以下 steering 文件按领域组织，按需加载：
|
||
|
||
### framework-core.md — 框架核心
|
||
- 小程序框架概述（MINA 架构：逻辑层 + 视图层）
|
||
- 小程序配置（app.json / page.json / sitemap.json）
|
||
- 目录结构与文件类型（.wxml / .wxss / .js / .json）
|
||
- 场景值、兼容性、基础库版本
|
||
|
||
### app-service.md — 逻辑层（App Service）
|
||
- App() 注册程序、生命周期
|
||
- Page() 注册页面、页面生命周期（onLoad/onShow/onReady/onHide/onUnload）
|
||
- 页面路由（navigateTo/redirectTo/switchTab/reLaunch/navigateBack）
|
||
- 模块化（require/module.exports）、文件作用域
|
||
- API 调用方式（回调/Promise）
|
||
- 页面间通信、EventChannel
|
||
|
||
### view-layer.md — 视图层（WXML / WXSS / WXS）
|
||
- WXML 语法：数据绑定、列表渲染(wx:for)、条件渲染(wx:if)、模板(template)、引用(import/include)
|
||
- WXSS 样式：rpx 单位、样式导入(@import)、选择器支持范围、内联样式
|
||
- WXS（WeiXin Script）：语法、模块、与 WXML 配合使用
|
||
- 事件系统：冒泡/非冒泡事件、bind/catch/mut-bind、事件对象、dataset
|
||
|
||
### custom-component.md — 自定义组件
|
||
- 创建自定义组件（json/wxml/wxss/js 四文件）
|
||
- Component() 构造器：properties / data / methods / lifetimes / pageLifetimes / observers
|
||
- 组件模板和样式（slot、样式隔离 styleIsolation）
|
||
- 组件间通信（properties 传值、triggerEvent 事件、selectComponent）
|
||
- behaviors（代码复用，类似 mixins）
|
||
- 数据监听器（observers）
|
||
- 纯数据字段（pureDataPattern）
|
||
- 组件间关系（relations）
|
||
- 抽象节点（componentGenerics）
|
||
- 用 Component 构造器构造页面
|
||
|
||
### builtin-components.md — 内置组件
|
||
- 视图容器：view / scroll-view / swiper / movable-view / cover-view
|
||
- 基础内容：text / rich-text / progress / icon
|
||
- 表单组件：button / input / textarea / picker / slider / switch / checkbox / radio / form
|
||
- 导航：navigator
|
||
- 媒体：image / video / camera / live-player / live-pusher
|
||
- 地图：map
|
||
- 画布：canvas
|
||
- 开放能力：open-data / web-view / ad
|
||
- 无障碍访问
|
||
|
||
### frontend-api.md — 前端 API
|
||
- 基础：wx.canIUse / wx.env / 系统信息
|
||
- 路由：wx.navigateTo / wx.redirectTo / wx.switchTab / wx.reLaunch / wx.navigateBack
|
||
- 界面：wx.showToast / wx.showModal / wx.showLoading / wx.showActionSheet / 导航栏 / TabBar / 下拉刷新
|
||
- 网络：wx.request / wx.uploadFile / wx.downloadFile / WebSocket / TCP/UDP
|
||
- 数据缓存：wx.setStorage / wx.getStorage / wx.removeStorage
|
||
- 媒体：图片(wx.chooseImage/wx.previewImage) / 录音 / 音频 / 视频 / 相机
|
||
- 位置：wx.getLocation / wx.openLocation / wx.chooseLocation
|
||
- 文件：wx.saveFile / FileSystemManager
|
||
- 开放接口：登录(wx.login) / 用户信息 / 支付(wx.requestPayment) / 授权 / 设置 / 收货地址 / 发票 / 生物认证 / 微信运动 / 订阅消息
|
||
- 设备：蓝牙 / NFC / Wi-Fi / 电话 / 加速计 / 罗盘 / 陀螺仪 / 剪贴板 / 屏幕亮度 / 振动
|
||
- Worker / 第三方平台 / WXML 节点查询(SelectorQuery / IntersectionObserver)
|
||
- 画布 Canvas API
|
||
|
||
### server-api.md — 服务端 API
|
||
- 登录：code2Session（code 换 session_key + openid）
|
||
- access_token 获取与管理
|
||
- 用户信息解密（手机号、用户信息）
|
||
- 消息推送（订阅消息、客服消息、模板消息）
|
||
- 小程序码与二维码生成
|
||
- 内容安全（文本/图片审核）
|
||
- 数据分析
|
||
- 物流助手
|
||
- OCR / 直播 / 安全风控
|
||
|
||
### login-auth.md — 登录与鉴权（重点）
|
||
- wx.login() 获取 code 的完整流程
|
||
- 服务端 code2Session 换取 openid / session_key / unionid
|
||
- 自定义登录态设计（token 方案）
|
||
- wx.checkSession() 检查 session_key 有效性
|
||
- 手机号快速验证（getPhoneNumber）
|
||
- 用户信息获取（getUserProfile 已废弃 → 头像昵称填写能力）
|
||
- 授权流程（wx.authorize / wx.getSetting / wx.openSetting）
|
||
- 常见登录架构与安全注意事项
|
||
|
||
### best-practices.md — 开发最佳实践与常见坑
|
||
- setData 性能优化（减少数据量、避免频繁调用）
|
||
- 分包加载（subpackages / 独立分包 / 分包预下载）
|
||
- 图片优化与懒加载
|
||
- 页面栈管理（最多 10 层）
|
||
- 小程序与 H5 差异（无 DOM/BOM、不支持 window/document）
|
||
- TypeScript 支持
|
||
- npm 支持与构建
|
||
- 自定义 tabBar
|
||
- 骨架屏
|
||
- 常见审核被拒原因与规避
|
||
|
||
### tdesign.md — TDesign 小程序组件库
|
||
- TDesign 安装与配置（npm 构建、TS 配置、基础库要求）
|
||
- 完整组件列表（60+ 组件，按基础/导航/输入/数据展示/反馈分类）
|
||
- 常用组件用法示例（Button / Input / Cell / Dialog / Toast / Popup / Tabs / Navbar / TabBar / Search / Empty / Loading / Skeleton）
|
||
- 样式覆盖 4 种方式（style 属性 / 解除隔离 / 外部样式类 / CSS 变量）
|
||
- 自定义主题（全局 Design Token / CSS Variables）
|
||
- 深色模式适配
|
||
|
||
## 使用方式
|
||
|
||
当遇到小程序相关问题时：
|
||
|
||
1. 根据问题领域，使用 `readSteering` 加载对应的 steering 文件
|
||
2. 如果不确定属于哪个领域，先加载 `framework-core.md` 了解整体架构
|
||
3. 登录/鉴权问题优先加载 `login-auth.md`
|
||
4. 组件用法问题加载 `builtin-components.md` 或 `custom-component.md`
|
||
5. API 调用问题加载 `frontend-api.md` 或 `server-api.md`
|
||
6. TDesign 组件用法/样式定制加载 `tdesign.md`
|
||
|
||
## 在线查询
|
||
|
||
如果 steering 文件中的信息不够详细，可以直接访问官方文档页面获取最新内容：
|
||
|
||
- 框架：https://developers.weixin.qq.com/miniprogram/dev/framework/
|
||
- 组件：https://developers.weixin.qq.com/miniprogram/dev/component/
|
||
- API：https://developers.weixin.qq.com/miniprogram/dev/api/
|
||
- 服务端 API：https://developers.weixin.qq.com/miniprogram/dev/api-backend/
|
||
- 配置参考：https://developers.weixin.qq.com/miniprogram/dev/reference/
|
||
- 开发者工具：https://developers.weixin.qq.com/miniprogram/dev/devtools/devtools.html
|
||
- TDesign 组件总览：https://tdesign.tencent.com/miniprogram/overview
|
||
- TDesign 具体组件：https://tdesign.tencent.com/miniprogram/components/{组件名}
|
||
|
||
使用 `webFetch` 工具抓取对应页面即可获取最新文档内容。
|