Skip to content

DFE-evernote/axe-ui

Repository files navigation


一套基于Vue3.0 + TS的PC端开源组件库

简介

Axe-ui是一套基于Vue3.0 + TS的PC端开源组件库。使用了最新的vue3TypeScript等主流技术开发,开箱即用。

欢迎大家一起参与共建。一起学习一起成长 ~ !

特性

  • 最新技术栈:使用 Vue3 前端前沿技术开发
  • TypeScript: 应用程序级 JavaScript 的语言

安装

npm install axe-ui -S

快速使用

全局引入

import { createApp } from 'vue'
import App from './App.vue'
import Axe from 'axe-ui'
import 'axe-ui/dist/axe.css'

createApp(App).use(Axe).mount('#app')

本组件支持按需导入。你也可以像下边这样,单独导入需要的组件:

import { createApp } from 'vue'
import App from './App.vue'
import { AxeInput, AxeButton /* ...其他组件 */ } from 'axe-ui'
// 或者:import AxeButton from 'axe-ui/dist/lib/button/index.js';
import 'axe-ui/dist/css/input/style.css'
import 'axe-ui/dist/css/button/style.css'

const app = createApp(App)
app.component(AxeInput.name, AxeInput)
app.component(AxeButton.name, AxeButton)

/* or
 * app.use(AxeInput)
 * app.use(AxeButton)
 */

app.mount('#app')

浏览器支持

本地开发推荐使用Chrome 80+ 浏览器

支持现代浏览器, 不支持 IE

 Edge
IE
 Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

开发文档

常用链接

更新日志

参与贡献

如何贡献:提一个 Issue 或者提交一个 Pull Request。

贡献指南: Axe热烈欢迎你的参与!在编写代码前,烦请请先阅读我们的贡献指南。他记录了所有的贡献须知,可以让你更快上手源码库。

Pull Request:

  • Fork 代码!
  • 创建自己的分支: git checkout -b feat/branchName
  • 提交你的修改: git commit -am 'feat(function): add xxxxx'
  • 推送您的分支: git push origin feat/branchName
  • 提交pull request
  • 代码review
  • merged !!

特别感谢

下面的贡献者让组件库变得更好,感谢所有为Axe做出贡献的人!

以贡献时间为序,感谢:

加入我们

axe-ui 是完全开源免费的项目。为帮助开发者更方便地进行使用和参与贡献,我们创建了微信交流群。有任何使用、开发等问题欢迎在群内提问。

加入有几下几种方式:

  • 看文档《加入axe-ui》

  • 搜索QQ群加入:762096000 【可先扫下方微信二维码,若过期再进此群,由我拉你进微信交流群。】 axe-ui交流群临时中转站

  • 微信交流群:(若过期可通过微信公众号或者QQ群联系我们) axe-ui组件研发群

LICENSE

MIT