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

![](/files/-M9K6j0jILM1ADD-oBXb)

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bctc.gitbook.io/vant-react-official-docs/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.