# vant-react

**Repository Path**: wang__qi/vant-react

## Basic Information

- **Project Name**: vant-react
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-23
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# **Vant React**

[![npm version](https://badge.fury.io/js/vant-react.svg)](https://badge.fury.io/js/vant-react)
[![NPM](https://img.shields.io/npm/l/vant-react)](LICENSE)
![Test CI](https://github.com/mxdi9i7/vant-react/workflows/Test%20CI/badge.svg)
[![Netlify Status](https://api.netlify.com/api/v1/badges/30ddabc0-3eb6-4530-ab08-58db247a2b48/deploy-status)](https://vant.bctc.io)
[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](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 (
        <Button text='Hello World' />
    );
};
```

## Components completion status

### Basic Components

* [x] Button
* [x] Cell
* [x] Icon
* [x] Image
* [ ] Layout
* [x] Popup
* [x] Built-in style

### Form Components

* [ ] Calendar
* [x] Checkbox
* [ ] DatetimePicker
* [x] Field
* [ ] Form
* [ ] NumberKeyboard
* [ ] PasswordInput
* [ ] Picker
* [ ] Radio
* [x] Rate
* [x] Search
* [x] Slider
* [x] Stepper
* [ ] Switch
* [ ] SwitchCell
* [ ] Uploader

### Action Components

- [ ] ActionSheet
- [ ] Dialog
- [ ] DropdownMenu
- [ ] Loading
- [ ] Notify
- [ ] Overlay
- [ ] PullRefresh
- [ ] ShareSheet
- [ ] SwipeCell
- [ ] Toast

### Display Components

- [ ] Circle
- [ ] Collapse
- [ ] CountDown
- [ ] Divider
- [ ] Empty
- [ ] ImagePreview
- [ ] Lazyload
- [ ] List
- [ ] NoticeBar
- [ ] Panel
- [ ] Progress
- [ ] Skeleton
- [ ] Steps
- [ ] Sticky
- [ ] Swipe
- [x] Tag

### Navigation Components

- [ ] Grid
- [ ] IndexBar
- [x] NavBar
- [ ] Pagination
- [ ] Sidebar
- [ ] Tab
- [ ] Tabbar
- [ ] TreeSelect

### Business Components

- [ ] AddressEdit
- [ ] AddressList
- [ ] Area
- [ ] Card
- [ ] Contact
- [ ] Coupon
- [ ] GoodsAction
- [ ] SubmitBar
- [ ] Sku

### Deprecated

- [ ] SwitchCell

## Contribution

If you like what we do, please consider buy us a bubble-tea(donate)!

[![DonorBox](https://d1iczxrky3cnb2.cloudfront.net/button-small-blue.png)](https://donorbox.org/vant-react-dev-team?default_interval=o&amount=5)

Please make sure to read the[ Contributing Guide](.github/CONTRIBUTION.md) before making a pull request.

Or, join our discussion group on Wechat by adding me!

![Wechat QR code](https://github.com/mxdi9i7/Vant-react-docs/blob/master/.gitbook/assets/qr.png)

## 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.