0.0.1 • Published 2 years ago
ss-ui-vm v0.0.1
SS UI VM 贡献指南
Hi! 首先感谢你使用 SS UI VM。
SS UI VM 是一套为开发者、设计师和产品经理准备的开源组件库,旨在快速搭建页面。它基于 Vue 2.0 开发,并提供了配套的设计资源,充分满足可定制化的需求。
SS UI VM 的成长离不开大家的支持,如果你愿意为 SS UI VM 贡献代码或提供建议,请阅读以下内容。
开发环境搭建
首先你需要 Node.js 4+,yarn 和 npm 3+。注意:我们使用 yarn 进行依赖版本的锁定,所以请不要使用 npm install
安装依赖。
npm run dev
# open http://localhost:8085
提示:可以运行
npm run dev:play
,修改examples/play/index.vue
文件,调用你修改后的组件,仍然访问 http://localhost:8085,查看修改效果,更快更方便。
打包代码:
npm run dist
组件开发规范
- 通过
npm run new
创建组件目录结构,包含测试代码、入口文件、文档 - 如果包含父子组件,需要更改目录结构,参考
Button
- 组件内如果依赖了其他组件,需要在当前组件内引入,参考
Select
Install
npm install ss-ui-vm -S
Quick Start
import Vue from 'vue'
import Ss from 'ss-ui-vm'
Vue.use(Ss)
// or
import {
Select,
Button
// ...
} from 'ss-ui-vm'
Vue.component(Select.name, Select)
Vue.component(Button.name, Button)