打造一个内部的组件库,在我们进行代码的重构,以及开发新的功能的时候,抽离公共的组件,减少代码的复用,注重业务与组件的分离,简化耦合度,便于开发与维护。
https://majunchang.github.io/mi.vant/#/quickStart
https://majunchang.github.io/mi.vant.storybook/?path=/story/mivantbutton--with-text
最初的时候 考虑过使用vue-cli3.0 vue-loader15+webpack4的配置 后来考虑到稳定性 暂时放弃
全局配置 babel.config.js 里的配置默认对整个项目生效,包括node_modules。除非通过 exclude 配置进行剔除。换句话来说babel7拥有全局配置能力。是前端走向未来语法的一大步,改造为babel7 的时候,遇到了很多难以解决的问题。但是最终还是坚持下来了。
以vue-cli 2.9.6版 的版本举?,默认是.babelrc。
.babelrc中的配置和相关的依赖
{
"presets": [
["env", {
"modules": false,
"targets": {
"browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
}
}],
"stage-2",
],
"plugins": [
"transform-vue-jsx",
"transform-runtime"
],
}
"babel-helper-vue-jsx-merge-props": "^2.0.3",
"babel-loader": "^7.1.1",
"babel-plugin-syntax-jsx": "^6.18.0",
"babel-plugin-transform-object-rest-spread": "^6.26.0",
"babel-plugin-transform-runtime": "^6.22.0",
"babel-plugin-transform-vue-jsx": "^3.5.0",
"babel-preset-env": "^1.3.2",
"babel-preset-es2015": "^6.24.1",
"babel-preset-stage-2": "^6.22.0",
"@babel/core": "^7.5.5",
mivant中最终版的babel.config.js中的配置和相关依赖
module.exports = function (api) {
api.cache(true);
const presets = [
"@babel/preset-env",
"@vue/babel-preset-app",
[
'@vue/babel-preset-jsx',
{
functional: false
}
]];
const plugins = [
"@babel/plugin-transform-runtime",
'@babel/plugin-transform-object-assign',
['import', {
libraryName: 'vant',
libraryDirectory: 'es',
style: true
}, 'vant']];
return {
presets,
plugins
};
}
Object.keys(components).forEach((key)=>{
Vue.component(components[key].name,components[key])
})
附index.js中的代码
import MiButton from './Button/index'
import Modal from './Modal/index'
const components = [
MiButton,
Modal
]
const version = '1.0.0'
const install = function (Vue) {
if (install.installed) return
components.forEach(item => {
Vue.component(item.name, item)
})
}
if (typeof window !== 'undefined' && window.Vue) {
console.log('运行环境为window');
install(window.Vue)
}
export {
MiButton,
Modal,
install
}
export default {
install,
version
}
// 组件中内置了单个组件所需的样式 无需配置babel-plugin-import
import { MiButton, Modal } from 'miVant'
import Vue from 'vue'
Vue.use(MiButton)
Vue.use(Modal)
import MiButton from 'miVant/lib/Button'
import Modal from 'miVant/lib/Modal'
import Vue from 'vue'
Vue.use(MiButton)
Vue.use(Modal)
按需架加载的基础
附录一段less使用的示例
@hd: 1px; // 基本单位
// 支付宝钱包默认主题
// https://github.com/ant-design/ant-design-mobile/wiki/设计变量表及命名规范
// 色彩
// ---
// 文字色
@color-text-base: #000; // 基本
@color-text-base-inverse: #fff; // 基本 - 反色
@color-text-secondary: #a4a9b0; // 辅助色
@color-text-placeholder: #bbb; // 文本框提示
@color-text-disabled: #bbb; // 失效
@color-text-caption: #888; // 辅助描述
@color-text-paragraph: #333; // 段落
@color-link: @brand-primary; // 链接
@defaultColor: #455a64;
@hoverColor:#1989fa;
@height: 60px;
.navTitle{
font-size:16px;
font-weight:600;
cursor: default;
}
.navItem {
color: @defaultColor;
font: 14px/24px PingFang SC;
padding: 10px 10px 10px 50px;
text-align: left;
cursor: pointer;
}
.doc-nav-title,
.doc-comp-title{
.navItem();
.navTitle();
}
.doc-nav-item{
.navItem()
}
.doc-comp-item{
.navItem()
}
// xx.js文件中 引入vue组件,编写测试案例。通过addDecorator函数引入 插件的相关功能
import { storiesOf } from '@storybook/vue';
import { withKnobs } from '@storybook/addon-knobs';
import miVantButton from '../src/components/Button/Button.vue'
import { withStorySource } from '@storybook/addon-storysource'
import buttonText from '../docs/button.md'
const simpleSourceCode =
'<mi-vant-button>storyBook</mi-vant-button>'
storiesOf('miVantButton', module)
.addDecorator(withKnobs)
.addDecorator(withStorySource(simpleSourceCode))
.addParameters({
readme: {
sidebar: buttonText,
},
})
.add('with text', () => {
return {
components: { miVantButton },
template: `<mi-vant-button>storyBook</mi-vant-button>`,
}},
{
notes: { markdown: buttonText }
})
- addons.js 中 注册相关的插件
config.js中 配置允许环境,安装全局插件。类似于vue项目的main.js
import { configure, addDecorator, addParameters } from '@storybook/vue';
import { withNotes } from '@storybook/addon-notes'
import { addReadme } from 'storybook-readme/vue';
import { setOptions } from '@storybook/addon-options'
import { Button } from 'vant'
import Vue from 'vue'
Vue.use(Button)
const req = require.context('../stories', true, /\.js$/)
function loadStories() {
req.keys().forEach((filename) => req(filename))
}
setOptions({
name: 'mi-Vant',
url: '#',
goFullScreen: false,
showStoriesPanel: true,
showAddonPanel: true,
showSearchBox: true,
addonPanelInRight: true,
sortStoriesByKind: false,
hierarchySeparator: null,
hierarchyRootSeparator: null,
sidebarAnimations: true,
selectedAddonPanel: undefined,
})
addParameters({ viewport: { defaultViewport: 'galaxys5' }, })
addDecorator(addReadme); addDecorator(withNotes) // require configure(loadStories, module);
遇到的问题
- 新版默认支持vue-loader15 而项目中vue-loader是13.3.0。 当时以为vue-loader15 是要搭配webpack4 一起使用的 所以降低了一下storybook的版本
- 低版本的storybook 默认使用babel6 只能解析.babelrc 且需要自定义webpack的配置 所以只能使用storybook中提供的自定义babel和webpack配置
- 基础设置都配置好了,在引入插件的时候 发现插件不能用.......... 不知名的报错 让人很蛋疼………..,会提示一个语法错误。而实际上我们配置的babel中已经解析了 但是 它还是会报错。。。。 猜测与插件版本有关 ReferenceError: regeneratorRuntime is not defined

config.module.rules.push({
test: /\.(css|less)$/,
use: [
{ loader: 'style-loader', },// creates style nodes from JS strings
{ loader: 'css-loader', }, // translates CSS into CommonJS
{ loader: 'postcss-loader' },
{ loader: 'less-loader',
options: {
javascriptEnabled: true
} // compiles Less to CSS
}],
exclude: /node_modules/
})
插件名称 | 功能 | 备注 |
---|---|---|
@storybook/addon-notes | 组件中添加notes,装饰story | 注释文本信息 |
@storybook/addon-actions | 展示event数据 | |
@storybook/addon-backgrounds | 改变页面的背景色 | |
@storybook/addon-storysource | 展示组件源码 | |
@storybook/addon-knobs | 动态展示props | |
storybook-readme | 将markdown导入为story | |
@storybook/addon-viewport/register | 增加移动端预览模式 | |
@storybook/addon-options | 配置面板选型 | |
相关文档
Storybook 5.0 正式发布:有史以来变化最大的版本
Rollup 是一个 JavaScript 模块打包器,可以将小块代码编译成大块复杂的代码,例如 library 或应用程序。采用 es6 原生的模块机制进行模块的打包构建, 编译之后包 体积会更小。
sudo npm install --global cross-env
建议想尝试的同学 使用babel6 + babelrc这样的配置
https://chenshenhai.github.io/rollupjs-note/note/chapter00/01.html
附rollup.config.prod.js
import resolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs';
import buble from 'rollup-plugin-buble'
import replace from 'rollup-plugin-replace';
import { uglify } from 'rollup-plugin-uglify';
import vue from 'rollup-plugin-vue'
import postcss from 'rollup-plugin-postcss';
const path = require('path');
const ENV = process.env.NODE_ENV;
const resolveFile = function (filePath) {
return path.join(__dirname, './', filePath)
}
export default {
input: resolveFile('src/components/index.js'),
output: {
dir: 'es',
format: 'umd',
name: 'miVant',
exports: 'named',
},
plugins: [
resolve({ extensions: ['.js', '.vue'] }),
postcss({
extensions: ['.less', '.css'],
use: [
['less', {
javascriptEnabled: true
}]
],
extract: true,
minimize: true,
}),
vue({
template: {
isProduction: true
},
css: false
}),
commonjs(),
buble({
objectAssign: 'Object.assign'
}),
replace({
exclude: 'node_modules/**',
ENV: JSON.stringify(process.env.NODE_ENV),
}),
(ENV === 'production' && uglify()),
],
};
I want
由于之前没有接触过类似的功能,于是漫漫的调研之路开始了。。。。
附webpack中关于markdown的解析规则
{
test: /\.md$/,
use: [
{
loader: 'vue-loader'
},
{
loader: 'vue-markdown-loader/lib/markdown-compiler',
options: {
raw: true,
preventExtract: true,
use: [
[
require('markdown-it-container'),
'demo',
{
validate: function (params) {
return params.trim().match(/^demo\s+(.*)$/)
},
render: function (tokens, idx) {
if (tokens[idx].nesting === 1) {
// 1.获取第一行的内容使用markdown渲染html作为组件的描述
let demoInfo = tokens[idx].info.trim().match(/^demo\s+(.*)$/)
let description = demoInfo && demoInfo.length > 1 ? demoInfo[1] : ''
let descriptionHTML = description ? markdownRender.render(description) : ''
// 2.获取代码块内的html和js代码
let content = tokens[idx + 1].content
// 3.使用自定义开发组件【DemoBlock】来包裹内容并且渲染成案例和代码示例
return `<demo-block>
<div class="source" slot="source">${content}</div>
${descriptionHTML}
<div class="highlight" slot="highlight">`
} else {
return '</div></demo-block>\n'
}
}
}
]
]
}
}
]
},
demo-block中手动补充copy功能
<template>
<div class="demo-block">
<div class="demo-block-source">
<slot name="source"></slot>
<span class="demo-block-code-icon" v-if="!$slots.default" @click="showCode=!showCode">
<img
alt="expand code"
src="https://gw.alipayobjects.com/zos/rmsportal/wSAkBuJFbdxsosKKpqyq.svg"
class="code-expand-icon-show"
/>
</span>
</div>
<div class="demo-block-meta" v-if="$slots.default">
<slot></slot>
<span v-if="$slots.default" class="demo-block-code-icon" @click="showCode=!showCode">
<img
alt="expand code"
src="https://gw.alipayobjects.com/zos/rmsportal/wSAkBuJFbdxsosKKpqyq.svg"
class="code-expand-icon-show"
/>
</span>
</div>
<div class="demo-block-code" v-show="showCode">
<p class="copy" @click="copy">复制</p>
<slot name="highlight"></slot>
</div>
</div>
</template>
<script type="text/babel">
export default {
data() {
return {
showCode: false
};
},
methods: {
copy(e) {
const hightext = e.target.nextElementSibling;
const input = document.createElement("input");
document.body.appendChild(input);
let value = hightext.innerText;
input.value = value;
input.select();
if (document.execCommand("copy")) {
document.execCommand("copy");
console.log("复制成功");
}
document.body.removeChild(input);
}
}
};
</script>
<style lang='less'>
@import "./less/demo-block.less";
.copy {
cursor: pointer;
position: absolute;
right: 10px;
top: 0;
}
</style>
VuePress 手摸手教你搭建一个类Vue文档风格的技术文档/博客
从 Vue-cli 开始构建 UI 库到 Markdown 生成文档和演示案例
vue-markdown-loader error with vue Loader 15
rem的适配功能
定制主题
miVant 使用了 Less 对样式进行预处理,并内置了一些样式变量,通过替换样式变量即可定制你自己需要的主题。
配置文件: ~/src/components/less/var.less
@primary-btn-color :#fbb212;
定制方法
exports.cssLoaders = function (options) {
options = options || {}
const lessLoader = {
loader: 'less-loader',
options: {
sourceMap: options.sourceMap,
modifyVars: {
color: 'red'
}
}
}
const lessConfig = {
modifyVars: {
primary-btn-color: 'red'
}
};
const cssLoader = {
loader: 'css-loader',
options: {
sourceMap: options.sourceMap
}
}
const postcssLoader = {
loader: 'postcss-loader',
options: {
sourceMap: options.sourceMap
}
}
// generate loader string to be used with extract text plugin
function generateLoaders(loader, loaderOptions) {
const loaders = options.usePostCSS ? [cssLoader, postcssLoader, lessLoader] : [cssLoader, lessLoader]
if (loader) {
loaders.push({
loader: loader + '-loader',
options: Object.assign({}, loaderOptions, {
sourceMap: options.sourceMap
})
})
}
// Extract CSS when that option is specified
// (which is the case during production build)
if (options.extract) {
return ExtractTextPlugin.extract({
use: loaders,
fallback: 'vue-style-loader'
})
} else {
return ['vue-style-loader'].concat(loaders)
}
}
// https://vue-loader.vuejs.org/en/configurations/extract-css.html
return {
css: generateLoaders(),
postcss: generateLoaders(),
less: generateLoaders('less', lessConfig),
sass: generateLoaders('sass', { indentedSyntax: true }),
scss: generateLoaders('sass'),
stylus: generateLoaders('stylus'),
styl: generateLoaders('stylus')
}
}
// 克隆项目到本地
git clone https://github.com/majunchang/mi-vant.git
// 切换到master分支
// 安装相关依赖
npm i
// npm 脚本
// storybook 预览模式
"start": "npm run storybook",
"storybook": "start-storybook -p 9001 -c .storybook",
// 打包storybook静态文件
"build-storybook": "build-storybook -c .storybook",
// 文档预览 端口是8081
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
// 打包之后的依赖包分析
"bundle-report": "webpack-bundle-analyzer --port 8123 dist/stats.json",
// webpack build
"build": "node build/build.js",
// rollup 编译
"clean": "rimraf rollupDist",
"rollup": "cross-env NODE_ENV=production rollup --config=rollup.config.prod.js"