About uniappx-project
uniappx-project is a reference skill for uni-app-x developers, organizing built-in component and API examples alongside documentation links and platform compatibility details.
Key features
- 01Examples grouped by component and API
- 02Official documentation links in examples
- 03Parameter and return-value references
- 04Platform compatibility details
- 05Vue 3, TypeScript, and Vite development
Use cases
- 01Find a built-in component example
- 02Check API parameters and return values
- 03Verify compatibility with a target platform
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ partme-ai/ full-stack-skills --skill uniappx-projectAfter installing, type/uniappx-projectin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
LICENSE.txtexamples/api/device/get-battery-info.mdget-network-type.mdget-screen-brightness.mdget-system-info.mdset-screen-brightness.mdexamples/api/file/get-file-info.mdget-saved-file-list.mdsave-file.mdexamples/api/location/choose-location.mdget-location.mdopen-location.mdexamples/api/media/choose-image.mdchoose-media.mdchoose-video.mdget-image-info.mdpreview-image.mdsave-image-to-photos-album.mdexamples/api/navigation/navigate-back.mdnavigate-to.mdre-launch.mdredirect-to.mdswitch-tab.mdexamples/api/network/download-file.mdrequest.mdupload-file.mdexamples/api/storage/clear-storage.mdget-storage-info.mdget-storage-sync.mdget-storage.mdDetails
From the project READMEWhen to use this skill
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)
- Components →
-
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 componentsreferences/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/
- APIs: https://doc.dcloud.net.cn/uni-app-x/api/
- 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, 官方文档
Comments
Markdown supported