Skip to content

Commit

Permalink
Merge pull request #12 from zangxd/master
Browse files Browse the repository at this point in the history
chore: update README
  • Loading branch information
zangxd authored Aug 7, 2020
2 parents af5fead + df40cd6 commit 4ebb4c7
Showing 1 changed file with 19 additions and 86 deletions.
105 changes: 19 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,27 @@
## About Dir
- builtin: 同内置class name 相关的组件存放于此(```<div className="mul-hairline--top"></div>```
- style: css ui 规范
- other dir: components dir
## **muld**

## Base Todo
- [x] basic ui
- [ ] pages preview
- [x] pages dev
- [x] pages build
- [ ] pages preview style
- [ ] stylelint
- [ ] with triones
- [ ] i18n
- [ ] zh & en docs
- [ ] theme
- [ ] unit test
- [ ] SSR
[![npm version](https://img.shields.io/npm/v/@trillion/muld.svg?style=flat-square)](https://img.shields.io/npm/v/@trillion/muld.svg?style=flat-square)

## Basic Components
- [x] Built-in style 例如:border、transition...
- [x] Col
- [x] Row
- [x] Button
- [ ] Image
- [ ] Popup
- [ ] Cell
Mobile UI Components built on Typescript and React

## Form Components
- [ ] Calendar
- [ ] Checkbox
- [ ] DatetimePicker
- [ ] Field
- [ ] Form
- [ ] NumberKeyBoard
- [ ] PasswordInput
- [ ] Picker
- [ ] Radio
- [ ] Rate
- [ ] Search
- [ ] Slider
- [ ] Stepper
- [ ] Switch
- [ ] Upload

## Action Components
- [ ] ActionSheet
- [ ] Dialog
- [ ] DropdownMenu
- [ ] Loading
- [ ] Notify
- [ ] Overlay
- [ ] PullRefresh
- [ ] ShareSheet
- [ ] SwipeCell
- [ ] Toast
## **Install**

## Display Components
- [ ] Circle
- [ ] Collapse
- [ ] CountDown
- [ ] Divider
- [ ] Empty
- [ ] ImagePreview
- [ ] Lazyload
- [ ] List
- [ ] NoticeBar
- [ ] Progress
- [ ] Skeleton
- [ ] Steps
- [ ] Sticky
- [ ] Swipe
- [ ] Tag
```
yarn add @trillion/muld --save
```

## **Quickstart**

## Navigation Components
- [ ] IndexBar
- [ ] NavBar
- [ ] Pagination
- [ ] Sidebar
- [ ] Tab
- [ ] Tabbar
- [ ] TreeSelect
```
// Using tsx
import { Button } from 'vant-react';
// Using tm
<import component="Button" from="@trillion/muld" />
```

## **Components completion status**

[Component Dev](https://github.com/mulcloud/muld/projects/1)

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

0 comments on commit 4ebb4c7

Please sign in to comment.