Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Yoshino-UI/Yoshino
A themable React component library！Flexible Lightweight PC UI Components built on React! Anyone can generate easily all kinds of themes by it!
https://github.com/Yoshino-UI/Yoshino
a-themable-react-component-library component components material-design react react-component react-components react-ui react-ui-components theme typescript ui webpack
Last synced: 3 months ago
JSON representation
A themable React component library！Flexible Lightweight PC UI Components built on React! Anyone can generate easily all kinds of themes by it!
- Host: GitHub
- URL: https://github.com/Yoshino-UI/Yoshino
- Owner: Yoshino-UI
- License: mit
- Created: 2018-03-25T08:00:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T03:22:26.000Z (7 months ago)
- Last Synced: 2024-05-22T18:29:39.963Z (6 months ago)
- Topics: a-themable-react-component-library, component, components, material-design, react, react-component, react-components, react-ui, react-ui-components, theme, typescript, ui, webpack
- Language: TypeScript
- Homepage: https://yoshino-ui.github.io
- Size: 2.46 MB
- Stars: 221
- Watchers: 8
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README-cn.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Yoshino
[English](./README.md) | 简体中文
## 设计思路
Yoshino本质上类似于Hexo，不同的样式风格组件类似于Hexo的各种theme，hexo官方仅提供了一套工具以及一个基础主题，Yoshino与其同理。
开发者只需要像配置Hexo主题一样使用即可拥有不同风格的组件，你甚至可以在同一个项目中使用cli输出多种不同风格的组件。
而不同主题的Yoshino需要开源社区完成，官方会提供类似的yoshino-theme-site来展示不同的主题，类似于[hexojs/site](https://github.com/hexojs/site)
目前cli工具仅支持组件创建产出，例如创建自定义Alert组件
```
yoshino new Alert
```
以后cli可以通过类似以下的指令配置输出对应规范组件，例如输出material-ui规范的Alert组件
```
yoshino new Alert --theme material-ui
```
以及直接输出整个主题的组件库
```
yoshino new all --theme material-ui
```
## 特性
- 使用`TypeScript`开发，提供`d.ts`文件帮助开发者提高开发速度
- 提倡`OFA（one for all）`与`AFO（all for one）`概念，不同项目开发前通过[yoshino-cli](https://github.com/Yoshino-UI/yoshino-cli)根据项目ui规范进行定制化开发产出。
- 除了简单通用的`ui`组件，`yoshino`抽离出了一些易用性比较高的特效(功能)组件，例如
- Helpers
- Ripple
- Transitions
- `Icon`组件的图标库采用了[archer-svgs](https://github.com/ShanaMaid/archer-svgs)，对图标的导入采用按需加载，你无须担心仅使用了一个字体就引入了所有图标文件。
## 介绍
`yoshino`组件库提供简单样式组件，可以通过[yoshino-cli](https://github.com/Yoshino-UI/yoshino-cli)根据项目进行定制化开发。
将yoshino组件库less抽离出来维护，让开发者自定义维护。
例如需要自定义Alert样式
```js
import {Alert} from 'yoshino'；
import 'myAlert.less'
```
myAlert.less为用户自定义样式
yoshino根据开发者需要自定义的组件自定义生成对应开发模版
```js
yoshino new Alert
```
## 贡献者
## 开发贡献流程
```js
npm run dev // 启动开发环境
npm run new ComponentName // 新建组件
```
## Yoshino is Inspired or Powered By:
- [archer-svgs](https://github.com/ShanaMaid/archer-svgs)
- [ant-design](https://github.com/ant-design/ant-design)
- [muse-ui](https://github.com/museui/muse-ui)
- [iView](https://github.com/iview/iview)
- [ionicons](https://github.com/ionic-team/ionicons)