README.zh-CN.md

English | 简体中文

React Vant

📱 一个参照Vant打造的 React 框架移动端组件库。

🔥 文档网站 (国内站点)   🌈 文档网站（GitHub）

🧑‍💻 项目状态

由于个人原因和精力有限，项目进入维护模式，不再接受新功能，只接受修复错误的 PR。

✨ 特性

• 🚀 组件平均体积小于 1KB（min+gzip）.
• 💎 70+ 个高质量组件，覆盖移动端主流场景.
• 💪 使用 TypeScript 编写，提供完整的类型定义.
• 📝 提供完善的文档和组件示例.
• 🎨 支持主题定制，内置 700+ 个主题变量.
• 😎 支持按需引入和 Tree Shaking.
• ⚡️ 支持 Vite和 Parcel@2.
• 🌵 现代浏览器
• 🌝 支持 SSR(nextjs, remix).

🖥 环境支持

Edge	Firefox	Chrome	Safari

支持现代浏览器和 Chrome >= 51，iOS >= 10.0。

📱 预览

手机扫描上的二维码访问演示：

查看部分截图

📦 安装

推荐 锁定 版本:

# npm
npm i react-vant -S -E

# pnpm
pnpm i react-vant -S -E

🚀 快速开始

以下是 react-vant 的一些代码示例：

代码片段:

import ReactDOM from 'react-dom';
import { Button } from 'react-vant';

function App() {
  return <Button>Default Button</Button>;
}

ReactDOM.render(<App />, mountNode);

代码示例:

• Create React App
• Umi
• Next.js
• Remix
• Astro
• Vite

更多信息请参考快速开始.

🤝 贡献

阅读我们的贡献指南，让我们一起构建更好的 react-vant。

我们欢迎所有贡献。 请先阅读我们的 CONTRIBUTING.md。 您可以将任何想法作为拉取请求或作为 GitHub 问题提交 😃。

👥 贡献者

Thanks goes to these wonderful people (emoji key):

0x219 💻 📖 🚧	TinsFox 💻 📖 🚧	Seth Yuan 💻	union-mall 💻	Tang Zhi 💻	yuegongzi 💻 📖	周神 💻
BiscuitCoder 🎨	WhiteSource Renovate 📖 🛡️ 🔧	allcontributors[bot] 🔧	dependabot[bot] 📖 🛡️	Cedong.Lee 🐛 🤔	xiaomao Feng 🐛	xiaojingyuaner 🐛
keep_wan 🐛	zhangYin 🐛 🤔	Yann 🐛	feifaneric 🐛	FJHou 🐛	Nate Wang 🐛	rook1e 🐛
chinieer 📖	GangYHu 🐛	Jungzl 💻	Tim Zhao 📖	野漫横江 🐛	NoDocCat 🐛	zhong yiqun 🐛
KooFrank 🐛	Songhn 🐛	晚枫 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

🙏 鸣谢

Vant - Thanks to the Vant team for years of continuous maintenance, allowing me to stand on the shoulders of giants.

Zan Design - Thanks for the careful production of YouZan Design Experience Center.

📜 许可证

MIT ⓒ 3lang3