betanet-mini-ui/README.md

为 Taro 而设计的 UI Library

<div align="center">
  <img src="https://report-picture-mini.oss-cn-huhehaote.aliyuncs.com/abetanet-mini-ui.png" alt="betanet mini ui logo"/>
</div>

# Betanet-Mini-UI

<!-- [![PRs Welcome][image-10]][8][![NPM version][image-1]][1] [![NPM downloads][image-2]][2][![node][image-3]][2][![license][image-4]][2] [![Always ready-to-code.][image-5]][3] [![dumi][image-6]][4][![father-build][image-9]][7] [![][image-7]][5][![Netlify Status][image-8]][6][![lerna][image-11]][9] [![FOSSA Status][image-12]][10] -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)ALL-CONTRIBUTORS-BADGE:END  -->
<!-- [![GitHub commit activity][image-16]][13] [![GitHub closed issues][image-17]][13] [![GitHub commits since latest release (by date)][image-18]][13] [![GitHub Release Date][image-19]][13][![Install size][image-20]][14] [![brotli][image-21]][15][![][image-22]][15][![][image-23]][16][![][image-24]][16] -->

## 简介

为`Taro`而设计的`UI Library`.

## 文档

[vercel](https://betanet-mini-ui.betatech.com/)

<!-- ## 使用案例 -->

<!-- <table>
  <tbody>
    <tr>
      <td align="center">
        <a>
          <img
            width="200"
            src="https://cdn.jsdelivr.net/gh/betatech/DrawingBed/2021-8-16/1629044960619-hooks.jpeg"
          />
          <br>
          <strong>Betanet-Mini-UI weapp</strong>
        </a>
      </td>
      <td align="center">
        <a target="_blank" href="https://betanet-mini-ui-h5-betatech.vercel.app">
          <img
            height="200"
            style="vertical-align: -0.32em; margin-right: 8px;"
            src="https://cdn.jsdelivr.net/gh/betatech/DrawingBed/2021-8-16/1629044960613-hooksite.png"
          />
          <br>
          <strong>Betanet-Mini-UI h5</strong>
        </a>
      </td>
    </tr>
  </tbody>
</table> -->

## 特性

- 多端适配.
- 组件丰富.
- 按需加载.

## taro init

确保当前`node>=12.x`. 可使用`npx taro init projectname`选择`betanet-mini-ui`模板进行初始化项目.

<!-- <video controls autoplay loop preload="auto">
  <source src="https://cdn.jsdelivr.net/gh/betatech/DrawingBed/2021-9-11/1631294499323-betanet-mini-ui-templete.mov"></source>
</video> -->

## 安装

```bash
$ npm i betanet-mini-ui --save
或
$ yarn add betanet-mini-ui
```

## 使用

```jsx | pure
import { Input } from 'betanet-mini-ui';
```

注: `betanet-mini-ui`的`js`代码默认支持基于`ES modules`的`tree shaking`. 但你依然可以显式的使用[`babel-plugin-import`](https://github.com/ant-design/babel-plugin-import)去设置按需加载, 设置方式如下:

```js
// babel.config.js
module.exports = {
  plugins: [
    [
      'import',
      {
        libraryName: 'betanet-mini-ui',
        camel2DashComponentName: false,
      },
      'betanet-mini-ui',
    ],
  ],
};
```

<!-- ## 参与贡献

务必保证预装`lerna`

```bash
$ git clone git@github.com:betatech/betanet-mini-ui.git
$ cd betanet-mini-ui
$ yarn bootstrap
$ yarn start
# 启动小程序预览
$ yarn app:dev
# 启动H5预览
$ yarn app:dev:h5
```

打开浏览器 - [http://localhost:10000](http://localhost:10000)
若开启 h5 预览 - [http://0.0.0.0:10086](http://0.0.0.0:10086)
更多贡献详情见[官网文档](https://betanet-mini-ui-betatech.vercel.app)

<!-- ## 交流讨论

<img src="https://cdn.jsdelivr.net/gh/betatech/DrawingBed/2021-9-11/1631293099153-qrcode.jpg" alt="wechat code" width="300"/> -->

## License

<!-- [MIT@betatech](https://github.com/betatech/betanet-mini-ui/blob/main/LICENSE) -->

[MIT]

<!-- [![FOSSA Status][image-13]][11] -->

<!-- ## Contributors -->

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- <table>
  <tr>
    <td align="center"><a href="https://github.com/betatech"><img src="https://avatars.githubusercontent.com/u/38065966?s=60&v=4?s=50" width="50px;" alt=""/><br /><sub><b>betatech</b></sub></a><br /><a href="#question-betatech" title="Answering Questions">💬</a> <a href="https://github.com/betatech/betanet-mini-ui/commits?author=betatech" title="Documentation">📖</a> <a href="https://github.com/betatech/betanet-mini-ui/pulls?q=is%3Apr+reviewed-by%3Betanettech" title="Reviewed Pull Requests">👀</a> <a href="#talk-betatech" title="Talks">📢</a> <a href="#ideas-betatech" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/betatech/betanet-mini-ui/commits?author=betatech" title="Tests">⚠️</a> <a href="#platform-betatech" title="Packaging/porting to new platform">📦</a> <a href="#eventOrganizing-betatech" title="Event Organizing">📋</a> <a href="#design-betatech" title="Design">🎨</a></td>
  </tr>
</table> -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

<!-- [more contributors](https://github.com/betatech/betanet-mini-ui/blob/main/CONTRIBUTORS.md) -->

<!-- ## Gitee

[![阿酱/betanet-mini-ui][image-15]][12] -->

[1]: https://www.npmjs.com/package/betanet-mini-ui
[2]: https://npmjs.org/package/betanet-mini-ui
[3]: https://gitpod.io/#https://github.com/betatech/betanet-mini-ui
[4]: https://github.com/umijs/dumi
[5]: https://codecov.io/gh/betatech/betanet-mini-ui
[6]: https://app.netlify.com/sites/betanet-mini-ui/deploys
[7]: https://www.npmjs.com/package/father-build
[8]: http://makeapullrequest.com
[9]: https://lerna.js.org/
[10]: https://app.fossa.com/projects/git%2Bgithub.com%2Fbetatech%2Fbetanet-mini-ui?ref=badge_shield
[11]: https://app.fossa.com/projects/git%2Bgithub.com%2Fbetatech%2Fbetanet-mini-ui?ref=badge_large
[12]: https://gitee.com/inocces/betanet-mini-ui
[13]: https://github.com/betatech/betanet-mini-ui
[14]: https://packagephobia.now.sh/result?p=betanet-mini-ui
[15]: https://bundlephobia.com/result?p=betanet-mini-ui
[16]: https://www.jsdelivr.com/package/npm/betanet-mini-ui
[image-1]: https://img.shields.io/npm/v/betanet-mini-ui.svg?style=flat
[image-2]: https://img.shields.io/npm/dm/betanet-mini-ui.svg?style=flat
[image-3]: https://img.shields.io/node/v/betanet-mini-ui.svg?style=flat-square
[image-4]: https://img.shields.io/npm/l/betanet-mini-ui.svg?style=flat-square
[image-5]: https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod
[image-6]: https://img.shields.io/badge/docs%20by-dumi-blue
[image-7]: https://codecov.io/gh/betatech/betanet-mini-ui/branch/main/graph/badge.svg
[image-8]: https://api.netlify.com/api/v1/badges/287ea853-a0e4-4f3a-9733-2ed39ae34d12/deploy-status
[image-9]: https://img.shields.io/badge/build%20by-father-build
[image-10]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[image-11]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
[image-12]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbetatech%2Fbetanet-mini-ui.svg?type=shield
[image-13]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fbetatech%2Fbetanet-mini-ui.svg?type=large
[image-14]: https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square
[image-15]: https://gitee.com/inocces/betanet-mini-ui/widgets/widget_card.svg?colors=4183c4,ffffff,ffffff,e3e9ed,666666,9b9b9b
[image-16]: https://img.shields.io/github/commit-activity/w/betatech/betanet-mini-ui
[image-17]: https://img.shields.io/github/issues-closed/betatech/betanet-mini-ui
[image-18]: https://img.shields.io/github/commits-since/betatech/betanet-mini-ui/latest/main
[image-19]: https://img.shields.io/github/release-date/betatech/betanet-mini-ui
[image-20]: https://badgen.net/packagephobia/install/betanet-mini-ui
[image-21]: https://badgen.net/bundlephobia/minzip/betanet-mini-ui
[image-22]: https://badgen.net/bundlephobia/tree-shaking/betanet-mini-ui
[image-23]: https://data.jsdelivr.com/v1/package/npm/betanet-mini-ui/badge
[image-24]: https://badgen.net/jsdelivr/v/npm/betanet-mini-ui