# shineout

**Repository Path**: orientMoon/shineout

## Basic Information

- **Project Name**: shineout
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-10
- **Last Updated**: 2025-02-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](./README.md) | 简体中文

<p align="center">
  <img alt="react-router" src="https://user-images.githubusercontent.com/101764/44770646-44f53000-ab9b-11e8-834e-2b1394cea318.png" width="300">
</p>

<p align="center">
一个更加『轻量』和『快速』的基于<a href="https://facebook.github.io/react">React</a>的桌面端组件库
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/v/shineout.svg?style=flat-square"></a>
  <a href="https://www.npmjs.com/package/shineout"><img src="https://img.shields.io/npm/dm/shineout.svg?style=flat-square"></a>
  <a href="https://david-dm.org/sheinsight/shineout"><img src="https://img.shields.io/david/sheinsight/shineout.svg?style=flat-square"></a>
  <img src="https://img.shields.io/badge/React-%3E%3D16.0.0-green.svg?style=flat-square">
</p>

## ✨ 特性

 - 精巧且友好的 API
 - 开箱即用的高性能 React 组件
 - 接口永远向下兼容
 - 灵活的主题配置

<!-- [View docs here](https://sheinsight.github.io/shineout/) -->

## 🛠️ 依赖

```
react >= 16.0.0
react-dom >= 16.0.0
```

## 🖥 浏览器支持

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Electron |
| --------- | --------- | --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions |

## 🔍 示例

  - [精简且智能的表单](https://shine.wiki/1.4.x/cn/components/Form#heading-01-base)
  
   [<img src="./site/images/form.gif" />](https://shine.wiki/1.4.x/cn/components/Form#heading-01-base)

  - [ 10000 条数据的高性能表格](https://shine.wiki/1.4.x/cn/components/Table#heading-08-bigdata)
  
   [<img src="./site/images/table.gif" />](https://shine.wiki/1.4.x/cn/components/Table#heading-08-bigdata)

## 📦 安装

```bash
npm install shineout
```

```bash
yarn add shineout
```

```bash
pnpm add shineout
```

## ⚡ CDN

```html
<link rel="stylesheet" href="https://unpkg.com/shineout/dist/theme.default.css" />
<script crossorigin src="https://unpkg.com/shineout/dist/shineout.min.js"></script>
```

## 🔧 使用

```tsx
import { Button } from 'shineout'

<Button>Click me</Button>
```

引入 css

```javascript
import 'shineout/dist/theme.default.css' // or 'shineout/dist/theme.antd.css'
```

## 🌐 国际化

文档地址 [i18n](https://shine.wiki/1.4.x/cn/components/GetStart#heading-2-I18N)

## 🔗 链接

- [首页](http://shine.wiki/)
- [组件](https://shine.wiki/1.4.x/cn/components/GetStart)
- [更新日志](https://shine.wiki/1.4.x/cn/documentation/1.x.x)
- [易用表单](https://shine.wiki/1.4.x/cn/components/Form#heading-01-base)
- [性能表格](https://shine.wiki/1.4.x/cn/components/Table#heading-08-bigdata)
- [CodeSandbox 模板](https://codesandbox.io/s/delicate-http-y3duk)

## 🚀 开发

本地克隆:

```bash
$ git clone git@github.com:sheinsight/shineout.git
$ cd shineout
$ yarn
$ yarn start
```

访问 http://localhost:3000

## 📄 开源许可
[MIT](./LICENSE)