Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChaiMayor/hview-ui
Hview UI - A Vue.js 3 UI library 👻
https://github.com/ChaiMayor/hview-ui
hview-ui less markdown typescript vue vue3
Last synced: about 2 months ago
JSON representation
Hview UI - A Vue.js 3 UI library 👻
- Host: GitHub
- URL: https://github.com/ChaiMayor/hview-ui
- Owner: ChaiMayor
- License: mit
- Created: 2023-01-13T02:57:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-24T03:16:36.000Z (about 1 year ago)
- Last Synced: 2024-06-02T22:53:27.005Z (4 months ago)
- Topics: hview-ui, less, markdown, typescript, vue, vue3
- Language: Vue
- Homepage: https://chai-mayor.gitee.io/hview-ui
- Size: 22.1 MB
- Stars: 89
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## 🎃 介绍
Hview 是一个基于 `Vue3` 开发的 Minimalism 风格电脑端组件库，全面拥抱 `Vue3` 生态，由 `芜湖起飞` 团队进行维护。
## ✨ 特性
- 🚀 提供 30+ 个高质量通用组件
- 💪 由国人开发，完善的中英文文档和后勤保障
- 🛠️ 支持按需引入，减少打包体积
- 🛠️ 支持主题定制
- 🌍 支持国际化
- 🎯 使用 TypeScript 构建，提供完整的类型定义文件
- 🛠️ 支持暗黑模式
- 🤺 演练场，大有用武之地
- 🔐 确保 80% 以上单元测试覆盖率，提供稳定性保证，安全可靠
## 📦 安装
```bash
npm i hview-plus
```
## 🤹♀️ 使用
```js
// main.ts
import { createApp } from "vue";
import HviewPlus from "hview-plus";
import "hview-plus/theme-chalk/style.css";
import App from "./App.vue";
const app = createApp(App);
app.use(HviewPlus);
app.mount("#app");
```
项目文档：[chai-mayor.gitee.io/hview-ui](https://chai-mayor.gitee.io/hview-ui)
## 🤺 演练场
在 [Hview UI Playground](https://playground.zhishiyu.online/) 对组件进行在线编辑。
> 有时可能会出现组件注册失败情况，刷新页面即可恢复正常
## 🥇 技术栈
核心：vue3 + typescript + less + vite
代码提交：husky、commitlint、lint-staged
代码风格：eslint、prettier、stylelint、postcss-less
目录规范：ls-lint
文档库：vitepress
国际化：vue-i18n
测试：vitest、@vue/test-utils、jsdom、c8
CI/CD：gulp、github actions、release-it
## 🎪 项目情况
项目名称：Hview-ui
名称寓意：往往学习编程的第一句代码都是 Hello World，而我们开发组件库也是第一次开发，我们的组件库也是参照已有的组件库进行开发和学习，而 view 有观察的意思并且和 vue 同音，所以我们将 h 和 view 融合在了一起，给组件库命名为 hview-ui 寓意我们这个新生的组件库能够通过学习融合现有组件库的优点，希望能为大家呈现出一个不错的组件库项目
logo 设计：view 还有透视、视图的意思，这里就用了三个不同视图方向的图案组成这个立体的 H
logo 寓意：我们的组件库还存在很多不完善的地方，非常希望广大开发人员能够使用我们组件库和给我们进行反馈和提问，我们会虚心接受，然后接纳大家的意见，不断迭代出让开发者满意的项目
## 👋 开发成员
感谢参与开发的每一位成员 🐝！
## 🎑 加入我们
通过使用飞书扫码加入开发群聊，后面会在群里分享此次组件库开发的知识点，遇到的问题如何解决，以及开发流程介绍等等...
有能力和想法的小伙伴，按照介绍完成三个组件的开发提交并通过后，即可参与我们这个开源项目
有想法但目前没能力的小伙伴，我们会在群里提供一些组件库文章资料，希望你早日通过学习结合实践学有所成后，来参与我们这个项目的开发
最后希望各位小伙伴可以动动发财的小手，给我们点个免费的 star 再次感谢大家 😘
> 参考文章：如何给开源项目贡献代码？ - 知乎 (zhihu.com)
## 🌸 感谢
该项目主要借鉴于以下这些项目。
- [Element Plus](https://element-plus.gitee.io/zh-CN/component/button.html)
- [kitty-ui](https://gitee.com/geeksdidi/kittyui)
- [brain-ui](https://github.com/longyanjiang/brain-ui)
## 📄 License
[MIT License](https://opensource.org/licenses/MIT) © 2023-PRESENT [ChaiMayor](https://github.com/NelsonYong)
