ant-design-mobile README

The project's README from github.com/ant-design/ant-design-mobile. As one markdown file: README.md.

logo

Ant Design Mobile

Essential UI blocks for building mobile web apps.

npm (tag) GitHub Release Date npm npm jsdelivr gzip size Commit Activity Issues help wanted GitHub Workflow Status (branch) codecov GitHub

English Doc · 中文文档 · Discord · 钉钉

$ npm install antd-mobile
# or
$ yarn add antd-mobile
# or
$ pnpm add antd-mobile
# or
$ bun add antd-mobile

You can also play with antd-mobile just in browser with Codesandbox. No need to prepare development environment.

If you found bugs or would like to request some new features, please consider opening an issue.

If you have some questions about how to use ant-mobile, you can start a discussion thread.


🤝 Contributing

Thanks to all the contributors of antd-mobile:

Contribution Leaderboard contributors

ant-design-mobile (ant-design/ant-design-mobile)

responsive
Searching Database…

What is this?Ant Design Mobile is a React component library that provides essential UI blocks for building mobile web apps.
Is this a framework or a component library?It's a component library: a set of ready-made React components (buttons, forms, pickers, etc.) you drop into your own app, not a full framework.
How do I add it to a project?Install it from npm and import the components you need into your React project; it's also based on antd's design conventions so it feels familiar if you've used Ant Design.
Do I need React set up first?Yes, it's built on React and relies on peer libraries like rc-field-form, dayjs, and ahooks under the hood.
Does it work without any configuration?Yes, it's designed to work out of the box with no configuration needed while still keeping bundle size small.
Is this for native mobile apps or mobile web pages?It's for mobile web pages rendered in a browser (a 'mobile web app'), not native iOS/Android apps.
Can I try it without setting up a dev environment?Yes, there's a Codesandbox playground linked in the README so you can experiment with antd-mobile directly in the browser.
How customizable is the theming?Theming is based on CSS variables, so you can adjust component appearance or build custom themes reliably and efficiently.
Does it feel smooth on touch devices?Yes, the library emphasizes smooth gestures and delicate animations aimed at a polished mobile UX.
What does 'Atomic' mean for these components?Each component is scoped to do exactly one job - no more, no less - keeping components focused and predictable.
Creator
ant-design
Size
166.6 MB
Stars
12.1K
Age
10y
Commits · 90 Days