English | 简体中文
[!IMPORTANT]
This is the 2.x version of shineout, which is now in maintenance mode.
The latest 3.x version has been released in a new repository: 👉 sheinsight/shineout-next
We recommend using 3.x for new projects.
✨ Features
- A concise and friendly API
- A set of high-performance React components out of the box.
- Always backward compatible
- Flexible theme customization
🛠️ Requirements
react >= 16.0.0
react-dom >= 16.0.0
🖥 Browsers support
| IE / Edge | Firefox | Chrome | Safari | Opera | Electron |
|---|
| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
🔍 Examples
📦 Installation
npm install shineout
yarn add shineout
pnpm add shineout
⚡ CDN
<link rel="stylesheet" href="https://unpkg.com/shineout/dist/theme.default.css" />
<script crossorigin src="https://unpkg.com/shineout/dist/shineout.min.js"></script>
🔧 Usage
import { Button } from 'shineout'
<Button>Click me</Button>
And import style manually:
import 'shineout/dist/theme.default.css' // or 'shineout/dist/theme.antd.css'
🌐 Internationalization
See i18n
🔗 Links
🚀 Development
clone locally:
$ git clone [email protected]:sheinsight/shineout.git
$ cd shineout
$ yarn
$ yarn start
Open your browser and visit http://localhost:3000
📄 LICENSE
MIT
