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

Form Components

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

Action Components

• [ ] ActionSheet
• [ ] Dialog
• [ ] DropdownMenu
• [ ] Loading
• [ ] Notify
• [ ] Overlay
• [ ] PullRefresh
• [ ] ShareSheet
• [ ] SwipeCell

Display Components

• [ ] Badge
• [ ] Circle
• [ ] Collapse
• [ ] CountDown
• [ ] 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)!

Please make sure to read the Contributing Guide 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 License.