https://github.com/mxdi9i7/vant-react
Lightweight 2kb Mobile UI Components built on React and TS, inspired by Vant@https://github.com/youzan/vant
https://github.com/mxdi9i7/vant-react
components-library react ui-components ui-library vant vant-ui web-components
Last synced: 2 months ago
JSON representation
Lightweight 2kb Mobile UI Components built on React and TS, inspired by Vant@https://github.com/youzan/vant
- Host: GitHub
- URL: https://github.com/mxdi9i7/vant-react
- Owner: mxdi9i7
- License: mit
- Created: 2020-05-22T20:04:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-12T13:29:28.000Z (almost 4 years ago)
- Last Synced: 2025-03-30T02:04:29.122Z (3 months ago)
- Topics: components-library, react, ui-components, ui-library, vant, vant-ui, web-components
- Language: SCSS
- Homepage: https://bctc.gitbook.io/vant-react-official-docs/
- Size: 40.5 MB
- Stars: 261
- Watchers: 14
- Forks: 55
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# **Vant React**
[](https://badge.fury.io/js/vant-react)
[](LICENSE)
[](https://vant.bctc.io)
[](https://vant.bctc.io)
Lightweight Mobile UI Components built on Typescript and React in under 2kb!
## **Features**
- Support Typescript
- 60+ Reusable components
- 100% Storybook coverage: [https://vant.bctc.io](https://vant.bctc.io)
- Extensive documentation and demos
## Install
```text
# Using npm
npm i vant-react -S
# Using yarn
yarn add vant-react
```
## Quickstart
```text
import React from 'react';
import { Button } from 'vant-react';
import 'vant-react/dist/index.css';
const App = () => {
return (
);
};
```
## Components completion status
### Basic Components
- [x] Button
- [x] Cell
- [x] Icon
- [x] Image
- [ ] Layout
- [x] Popup
- [x] Built-in style
- [x] Toast
### Form Components
- [ ] Calendar
- [ ] Cascader
- [x] Checkbox
- [ ] DatetimePicker
- [x] Field
- [ ] Form
- [ ] NumberKeyboard
- [ ] PasswordInput
- [ ] Picker
- [x] Radio
- [x] Rate
- [x] Search
- [x] Slider
- [x] Stepper
- [x] Switch
- [ ] Uploader
### Action Components
- [ ] ActionSheet
- [ ] Dialog
- [ ] DropdownMenu
- [x] Loading
- [ ] Notify
- [ ] Overlay
- [ ] PullRefresh
- [ ] ShareSheet
- [ ] SwipeCell
### Display Components
- [ ] Badge
- [ ] Circle
- [ ] Collapse
- [ ] CountDown
- [x] Divider
- [ ] Empty
- [ ] ImagePreview
- [ ] Lazyload
- [ ] List
- [ ] NoticeBar
- [ ] Popover
- [ ] Progress
- [ ] Skeleton
- [ ] Steps
- [ ] Sticky
- [ ] Swipe
- [x] Tag
### Navigation Components
- [ ] Grid
- [ ] IndexBar
- [x] NavBar
- [ ] Pagination
- [ ] Sidebar
- [ ] Tab
- [ ] Tabbar
- [ ] TreeSelect
### Business Components
- [ ] AddressEdit
- [ ] AddressList
- [ ] Area
- [ ] Card
- [ ] ContactCard
- [ ] ContactEdit
- [ ] ContactList
- [ ] Coupon
- [ ] GoodsAction
- [ ] SubmitBar
- [ ] Sku
### Deprecated
- [ ] SwitchCell
- [ ] Panel
## Contribution
If you like what we do, please consider buy us a bubble-tea(donate)!
[](https://donorbox.org/vant-react-dev-team?default_interval=o&amount=5)
Please make sure to read the[ Contributing Guide](./CONTRIBUTION.md) before making a pull request.
Or, join our discussion group on Wechat by adding me!
## Browser Support
Modern browsers and Android 4.0+, iOS 8.0+.
## Open Source License
This is an Open Source Software operating under the [MIT](https://github.com/mxdi9i7/vant-react/blob/master/LICENSE) License.