mirror of
https://github.com/zhigang1992/react.git
synced 2026-01-31 09:08:41 +08:00
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
<p align="center" height="370">
|
|
<img align="center" height="370" src="https://user-images.githubusercontent.com/11304944/76085431-fd036480-5fec-11ea-8412-9e581425344a.png">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/zeit-ui/react?style=for-the-badge&labelColor=000000">
|
|
<img alt="CircleCI" src="https://img.shields.io/circleci/build/github/zeit-ui/react?style=for-the-badge&labelColor=000000">
|
|
<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@zeit-ui/react?style=for-the-badge&labelColor=000000">
|
|
</p>
|
|
|
|
> Modern and minimalist React UI library, originating from Vercel's design.
|
|
|
|
|
|
<br/>
|
|
|
|
## Quick Start
|
|
|
|
1. run `yarn add @zeit-ui/react` or `npm i @zeit-ui/react` install it.
|
|
|
|
2. import into project:
|
|
|
|
```jsx
|
|
import { CSSBaseline, ZEITUIProvider } from '@zeit-ui/react'
|
|
|
|
const Application = () => (
|
|
<ZEITUIProvider> // ---> Base provider
|
|
<CSSBaseline /> // ---> normalize styles
|
|
<AppComponent /> // ---> Your App Component
|
|
</ZEITUIProvider>
|
|
)
|
|
```
|
|
|
|
<br/>
|
|
|
|
## Documentation
|
|
|
|
- [Document Site](https://react.zeit-ui.co)
|
|
- [中文文档](https://react.zeit-ui.co/zh-cn)
|
|
|
|
<br/>
|
|
|
|
## Development
|
|
|
|
- [Contributing Guide](https://github.com/zeit-ui/react/blob/master/.github/CONTRIBUTING.md)
|
|
|
|
<br/>
|
|
|
|
## Showcases
|
|
|
|
- [Article view count](https://docs.views.show/)
|
|
- [Tree viewer for CDN](https://cdn.unix.bio/)
|
|
- [Better social image](https://img.unix.bio/)
|
|
- [Implement of ZEIT's Dashboard](https://github.com/ofekashery/zeit-dashboard-template)
|
|
- [Blog of ZEIT's design](https://github.com/unix/unix.bio)
|
|
- [Add here](https://github.com/zeit-ui/react/issues/new)
|
|
|
|
<br/>
|
|
|
|
## LICENSE
|
|
[MIT](./LICENSE)
|