# Introduction

## **Vant React**

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>
* Extensive documentation and demos

## Install

```
# Using npm
npm i vant-react -S

# Using yarn
yarn add vant-react
```

## Quickstart

```
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
* [ ] Image
* [ ] Layout
* [x] Popup
* [x] Built-in style

### Form Components

* [ ] Calendar
* [ ] Checkbox
* [ ] DatetimePicker
* [x] Field
* [ ] Form
* [ ] NumberKeyboard
* [ ] PasswordInput
* [ ] Picker
* [ ] Radio
* [x] Rate
* [x] Search
* [ ] Slider
* [ ] 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

Please make sure to read the[ Contributing Guide](https://github.com/mxdi9i7/vant-react/blob/master/CONTRIBUTION.md) before making a pull request.

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

![](https://2748491343-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M86VWm37qwXlTl7rQ_V%2F-M9K6de8aWifmdrf1cfY%2F-M9K6j0jILM1ADD-oBXb%2Fqr.png?alt=media\&token=0766fcab-62d0-424f-b93d-3fb027d6555d)

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