摘要：各個大廠也相繼宣布開源。但是也會存在一些問題，比如每個公司可能需要的業(yè)務組件不盡相同，或者我們想自己開發(fā)一套屬于自己的組件庫，來增強對組件的可控性。
前言：
前端組件化是當今熱議的話題之一，也是我們在開發(fā)單頁應用經(jīng)常會碰到的一個問題，現(xiàn)在我們有了功能非常完善的Element-UI。各個大廠也相繼宣布開源XXX-UI。但是也會存在一些問題，比如每個公司可能需要的業(yè)務組件不盡相同，或者我們想自己開發(fā)一套屬于自己的組件庫，來增強對組件的可控性。那么我們該如何去做呢？
這里記錄一下我從零開始搭建起來的組件庫的過程，目前只有簡單幾個組件，不過我也會慢慢更新維護：VV-UI
1. 環(huán)境準備
我們搭建組件庫，需要準備一系列環(huán)境，首先我們要考慮一下問題：
腳手架如何搭建
如何規(guī)劃目錄結構
如何編寫文檔
首先，對于腳手架環(huán)境的問題，目前已經(jīng)有非常成熟的vue官方的腳手架，我們拿來用就好了
# 全局安裝 vue-cli
$ npm install --global vue-cli
# 創(chuàng)建一個基于 webpack 模板的新項目
$ vue init webpack my-project
# 安裝依賴，走你
$ cd my-project
$ npm install
$ npm run dev
接著我們看第二個問題，如何規(guī)劃好我們組建的目錄結構？首先我們需要有一個目錄存放組件，有一個目錄存放示例。所以我們要對vue-cli 生成的項目結構做一下改造：
.
...
|-- examples // 原 src 目錄，改成 examples 用作示例展示
|-- packages // 新增 packages 用于編寫存放組件
...
.
這樣的話 我們需要再把我們webpack配置文件稍作一下調整，首先是把原先的編譯指向src的目錄改成examples，其次為了 npm run build 能正常編譯 packages 我們也需要為 babel-loader 再增加一個編譯目錄：
{
test: /.js$/,
loader: "babel-loader",
include: [resolve("examples"), resolve("test"), resolve("packages")]
}
這樣我們搭建起來一個簡易的目錄結構。
緊接著我們需要考慮如何編寫文檔。對于文檔的編寫，自然是markdown最合適不過了，那么怎么讓我們在vue下可以去寫 markdown 文檔呢？答案當然是 vue-markdown-loader。然后我們按照文檔配置了相關的插件信息：
rules: [
{
test: /.md$/,
loader: "vue-markdown-loader"
}
]
好了，我們可以開始嘗試寫文檔了，在 example/docs 目錄下新建 test.md。
# test
> Hello World
同時創(chuàng)建一個新的路由，指向我們的md文件：
{
path: "/test",
name: "test",
component: r => require.ensure([], () => r(require("../docs/test.md")))
}
打開我們的瀏覽器http://localhost:8080/#/test 哈哈 真的成功了。別高興的太早.... 問題還在后面：我們期望的文檔不僅能編譯markdown，而且最好能識別demo代碼塊一方面做演示，一方面可以顯示演示代碼最好了，就像這樣：
那我們需要怎么做呢？vue-mark-down 功能肯定不止這些！于是我們繼續(xù)閱讀它的文檔，發(fā)現(xiàn)其實他就是封裝了 markdown-it，支持 options 選項。這樣我們就可以為我們的markdown定義獨特的標識符，這里我用 demo 標識需要顯示代碼塊的地方，所以我需要配置options 選項 ：
const vueMarkdown = {
preprocess: (MarkdownIt, source) => {
MarkdownIt.renderer.rules.table_open = function () {
return ""
}
MarkdownIt.renderer.rules.fence = utils.wrapCustomClass(MarkdownIt.renderer.rules.fence)
return source
},
use: [
[MarkdownItContainer, "demo", {
// 用于校驗包含demo的代碼塊
validate: params => params.trim().match(/^demos*(.*)$/),
render: function(tokens, idx) {
var m = tokens[idx].info.trim().match(/^demos*(.*)$/);
if (tokens[idx].nesting === 1) {
var desc = tokens[idx + 2].content;
// 編譯成html
const html = utils.convertHtml(striptags(tokens[idx + 1].content, "script"))
// 移除描述，防止被添加到代碼塊
tokens[idx + 2].children = [];
return `
${html}
`;
}
return "
";
}
}]
]
}
這里簡單的描述一下這段代碼是干什么的：首先把內容里面vue片段編譯成html，用于顯示，另一方面用highlight來高亮代碼塊。demo-block本身是我們定義好的組件：
{{isExpand ? "隱藏代碼" : "顯示代碼"}}
這樣，我們的 test.md 便可以這么去寫了：
2. 如何編寫組件
環(huán)境準備完畢，緊接著要開始編寫組件，考慮的是組件庫，所以我們竟可能讓我們的組件支持全局引入和按需引入，如果全局引入，那么所有的組件需要要注冊到Vue component 上，并導出：
const install = function(Vue) {
if (install.installed) return;
components.map(component => Vue.component(component.name, component));
};
export default {
install
};
接著要實現(xiàn)按需加載，我們只需要單個導出組件即可：
import Button from "./button/index.js";
import Row from "./row/index"
import Col from "./col/index"
const components = [
Button,
Row,
Col
];
const install = function(Vue) {
if (install.installed) return;
components.map(component => Vue.component(component.name, component));
};
if (typeof window !== "undefined" && window.Vue) {
install(window.Vue);
}
export default {
install,
Button,
Row,
Col
};
其次，我們還需要考慮一個問題：既然是單頁面應用，必然要去解決樣式?jīng)_突問題，如果組件內使用soped，那么樣式就無法從組件內抽離出來，達不到可定制化主題顏色的目的。我們需要一套可以分離處理的樣式，可以自行編譯，可以相互不污染。這時候css 的BEM規(guī)范就顯得尤為重要。如果你還不知道什么是BEM 參考： http://www.w3cplus.com/css/css-architecture-1.html。
說到這里，目前對BEM規(guī)范支持較好的插件就是postcss了，他允許我們配置BEM之間的連接符和縮寫：
{
"browsers": ["ie > 8", "last 2 versions"],
"features": {
"bem": {
"shortcuts": {
"component": "b",
"modifier": "m",
"descendent": "e"
},
"separators": {
"descendent": "__",
"modifier": "--"
}
}
}
}
這樣我們就可以把樣式多帶帶的抽離出來，通過gulp進行打包編譯：
gulp.task("compile", function() {
return gulp.src("./src/*.css")
.pipe(postcss([salad]))
.pipe(cssmin())
.pipe(gulp.dest("./lib"));
});
最后生成我們的樣式代碼。
好了開始我們的測試：
import VVUI from "../packages/index"
import "../packages/theme-default/lib/index.css"
Vue.use(VVUI)
一切顯得那么美好....
優(yōu)化與不足
組件導出代碼暫不支持自動化生成：比如我們的組件index文件，每次添加組件都需要不斷地改寫，我們2*
可以嘗試進行webpack配置，npm run dev 的時候自動進行組件檢測，然后幫我們寫好導出代碼。
目錄結構劃分缺陷：目前所有內容僅支持中文，如果想要做到支持國際化，那么還需要重新調整目錄結構。
發(fā)布tag： 需要編寫腳本支持tag發(fā)布
組件太少：文檔剛寫，組件還不是很多，慢慢去維護，相信會越來越多的組件，做業(yè)務的過程中也可以把常用的組件加進去，這樣更加方便自己以后的維護和學習
結語：
項目github地址：github
項目演示地址： 演示
歡迎 PR 一起維護，歡迎 Star
關于
作者：monkeyWang
本人主頁：monkeyWang
微信公眾號：會不定期推送前端技術文章，歡迎關注
文章版權歸作者所有，未經(jīng)允許請勿轉載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/89715.html
-
摘要：各個大廠也相繼宣布開源。但是也會存在一些問題，比如每個公司可能需要的業(yè)務組件不盡相同，或者我們想自己開發(fā)一套屬于自己的組件庫，來增強對組件的可控性。
前言：
前端組件化是當今熱議的話題之一，也是我們在開發(fā)單頁應用經(jīng)常會碰到的一個問題，現(xiàn)在我們有了功能非常完善的Element-UI。各個大廠也相繼宣布開源XXX-UI。但是也會存在一些問題，比如每個公司可能需要的業(yè)務組件不盡相同，或者我們...
wthee
評論0
收藏0
-
github 地址： VV-UI/VV-UI
演示地址: vv-ui
文檔地址：skeleton
關于骨架屏介紹
骨架屏的作用主要是在網(wǎng)絡請求較慢時，提供基礎占位，當數(shù)據(jù)加載完成，恢復數(shù)據(jù)展示。這樣給用戶一種很自然的過渡，不會造成頁面長時間白屏或者閃爍等情況。 常見的骨架屏實現(xiàn)方案有ssr服務端渲染和prerender兩種解決方案。這里主要通過代碼為大家展示如何一步步做出這樣一個骨架屏：
show...
DevTTL
評論0
收藏0
-
github 地址： VV-UI/VV-UI
演示地址: vv-ui
文檔地址：skeleton
關于骨架屏介紹
骨架屏的作用主要是在網(wǎng)絡請求較慢時，提供基礎占位，當數(shù)據(jù)加載完成，恢復數(shù)據(jù)展示。這樣給用戶一種很自然的過渡，不會造成頁面長時間白屏或者閃爍等情況。 常見的骨架屏實現(xiàn)方案有ssr服務端渲染和prerender兩種解決方案。這里主要通過代碼為大家展示如何一步步做出這樣一個骨架屏：
show...
you_De
評論0
收藏0
-
github 地址： VV-UI/VV-UI
演示地址: vv-ui
文檔地址：skeleton
關于骨架屏介紹
骨架屏的作用主要是在網(wǎng)絡請求較慢時，提供基礎占位，當數(shù)據(jù)加載完成，恢復數(shù)據(jù)展示。這樣給用戶一種很自然的過渡，不會造成頁面長時間白屏或者閃爍等情況。 常見的骨架屏實現(xiàn)方案有ssr服務端渲染和prerender兩種解決方案。這里主要通過代碼為大家展示如何一步步做出這樣一個骨架屏：
show...
233jl
評論0
收藏0
-
摘要：第一集從零開始實現(xiàn)環(huán)境的搭建工程定位本套工程定位在端針對的組件庫名字的由來是我從年養(yǎng)到現(xiàn)在的一直大金毛是我的吉祥物原因本人上一份工作參與了大型的保險公司后臺管理系統(tǒng)的搭建對的端框架有過一定的了解感受到了他們真的很強大同時也存在少許的不足其實
第一集: 從零開始實現(xiàn)(環(huán)境的搭建)
工程定位: 本套工程, 定位在pc端針對vue的ui組件庫
名字的由來 cc是我從2015年養(yǎng)到現(xiàn)在的...
Ashin
評論0
收藏0
男|高級講師
-
閱讀 3831·2021-10-12 10:12
-
閱讀 1461·2021-10-11 10:58
-
閱讀 2297·2021-10-09 10:01
-
閱讀 2609·2021-09-24 09:48
-
閱讀 2706·2021-09-09 11:38
-
閱讀 3531·2019-08-30 15:44
-
閱讀 1728·2019-08-30 14:22
-
閱讀 523·2019-08-29 12:42
