Use this skill whenever the user wants to:
-
Use any uni-app-x built-in component
-
Use any uni-app-x API (network, storage, device, UI, navigation, media, etc.)
-
Access per-component or per-API examples with official doc links
-
Check platform compatibility for components and APIs in uni-app-x
-
Build uni-app-x applications with Vue 3 + TypeScript + Vite
How to use this skill
This skill is organized to match the official uni-app-x components and API documentation:
- Choose component or API category:
Components → examples/components/built-in/
-
APIs →
examples/api/(categorized by domain) -
Open the matching example file:
Each component or API has its own example file
-
Each example includes the official documentation URL
-
Examples mirror the official documentation examples
-
Use references when you need full specs:
references/components/built-in/ for built-in components
references/api/for API parameter/return/compatibility details
Examples and References
Components (Built-in)
-
Examples:
examples/components/built-in/*.md -
References:
references/components/built-in/*.md -
Official docs: https://doc.dcloud.net.cn/uni-app-x/component/
APIs
-
Examples:
examples/api/{category}/*.md -
References:
references/api/*.md -
Official docs: https://doc.dcloud.net.cn/uni-app-x/api/
Best Practices
-
One file per component/API: Each component and API has an independent example file with official doc link.
-
Follow platform compatibility: Check the compatibility section in each example/reference.
-
Use conditional compilation: Use
#ifdef/#endiffor platform-specific logic. -
Keep examples aligned: Use the official documentation examples as the source of truth.
-
Prefer references for specs: Use
references/for full parameter tables and compatibility.
Resources
-
Components: https://doc.dcloud.net.cn/uni-app-x/component/
-
uni-app-x: https://doc.dcloud.net.cn/uni-app-x/
Keywords
uniappx, uni-app-x, components, api, built-in components, examples, references, Vue 3, TypeScript, Vite, H5, App, mini program, 跨平台, 组件, API, 官方文档