npm.io
2.0.5 • Published 1 year ago

hexin-components

Licence
Version
2.0.5
Deps
16
Size
47.0 MB
Vulns
22
Weekly
0

vue-cli-typescript-storybook

本项目是基于 vue-cli 创建的 vue 项目,并添加了 storybook 及其 storybook-addon-vue-info 插件,以及 vue 的 Typescript 组件写法支持的配置。eslint + prettier 配置支持 vscode save autofix

项目运行编写指南

克隆本项目到本地
此项目分为两个库:hexin-components 和 hexin-utils,其中 hexin-components 中是通用组件

修改完成后,可以发布到 npm 上,供其他项目使用

步骤:

cd ./packages/hexin-components
yarn
yarn run storybook

所有的组件都在 components 文件夹下,story 实例在 stories 文件夹下,具体请参考官方文档

打包发布

yarn run lib
npm publish # 这一步可以找 @李凯旋 完成

如果不想发布到 npm,可以使用 tag 的方式,如果不使用 github workflow,需要把打包产物 lib 文件夹一起提交到 git 仓库

hexin-components 组件库用法

安装依赖

yarn add hexin-components

挂载组件库

  • 在 main.js 中挂载组件库
Vue.component('CommonList', hexinComponents.CommonList);
Vue.component('CommonNode', hexinComponents.CommonNode);
Vue.component('HxTree', hexinComponents.HxTree);
  • 局部注册
import { CommonList, CommonNode, HxTree } from 'hexin-components';
## 使用组件

全局注册,直接使用