1、用法
需要明確的是，如果可以使用 Web 端組件技術實現的話請盡量使用 Web 端技術(如 vue、react 組件)，使用自定義組件請按需使用。這是因為自定義組件外層會被包裹上 kbone 的自定義組件，而當自定義組件的實例數量達到一定量級的話，理論上是會對性能造成一定程度的影響。
要在 kbone 中使用自定義組件，需要將所有自定義組件和其依賴放到一個固定的目錄，這個目錄可以自己擬定，假設這個目錄為 src/custom-components：
1.1 修改 webpack 插件配置
在 mp-webpack-plugin 這個插件的配置中的 generate 字段內補充 wxCustomComponent，其中 root 是組件根目錄，即上面提到的目錄：src/custom-component，usingComponents 則用來配置要用到的自定義組件。
module.exports = {
generate: {
wxCustomComponent: {
root: path.join(__dirname, '../src/custom-components'),
usingComponents: {
'comp-a': 'comp-a/index',
'comp-b': {
path: 'comp-b/index',
props: ['propa', 'propb'],
events: ['someevent'],
},
},
},
},
// ... other options
}
usingComponents 里的聲明和小程序頁面的 usingComponents 字段類似。鍵為組件名，值可以為組件相對 root 字段的路徑，也可以是一個配置對象。這個配置對象的 path 為組件相對路徑，props 表示要這個組件會被用到的 properties，events 表示這個組件會被監聽到的事件。
1.2 將自定義組件放入組件根目錄
下面以 comp-b 組件為例：
comp-b
propa: {{propa}} -- propb: {{propb}}
click me
// comp-b.js
Component({
properties: {
propa: {type: String, value: ''},
propb: {type: String, value: ''},
},
methods: {
onTap() {
this.triggerEvent('someevent')
},
},
})
1.3 使用自定義組件
假設使用 vue 技術，然后下面同樣以 comp-b 組件為例：
comp-b slot
PS：如果使用 react 等其他框架其實和 vue 同理，因為它們的底層都是調用 document.createElement 來創建節點。當在 webpack 插件配置聲明了這個自定義組件的情況下，在調用 document.createElement 創建該節點時會被轉換成創建 wx-custom-component 標簽，類似于內置組件的 wx-component 標簽。
2、案例
在 kbone-advanced 目錄下創建 04-custom-components 目錄。本案例在這個目錄下實現。
2.1 創建 package.json
cd 04-custom-components
npm init -y
編輯 package.json：
{
"scripts": {
"mp": "cross-env NODE_ENV=production webpack --config build/webpack.mp.config.js --progress --hide-modules"
},
"dependencies": {
"vue": "^2.5.11"
},
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
],
"devDependencies": {
"babel-core": "^6.26.0",
"babel-loader": "^7.1.2",
"babel-preset-env": "^1.6.0",
"babel-preset-stage-3": "^6.24.1",
"cross-env": "^5.0.5",
"css-loader": "^0.28.7",
"extract-text-webpack-plugin": "^3.0.2",
"file-loader": "^1.1.4",
"html-webpack-plugin": "^4.0.0-beta.5",
"mini-css-extract-plugin": "^0.5.0",
"mp-webpack-plugin": "latest",
"optimize-css-assets-webpack-plugin": "^5.0.1",
"stylehacks": "^4.0.3",
"vue-loader": "^15.7.0",
"vue-template-compiler": "^2.6.10",
"webpack": "^4.29.6",
"webpack-cli": "^3.2.3"
}
}
安裝依賴包：
npm install
2.2 配置 webpack
在 04-custom-components 目錄下創建 build 文件夾，在文件夾下創建 webpack.mp.config.js 文件，內容如下：
const path = require('path')
const webpack = require('webpack')
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const { VueLoaderPlugin } = require('vue-loader')
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
const TerserPlugin = require('terser-webpack-plugin')
const MpPlugin = require('mp-webpack-plugin') // 用于構建小程序代碼的 webpack 插件
const isOptimize = false // 是否壓縮業務代碼，開發者工具可能無法完美支持業務代碼使用到的 es 特性，建議自己做代碼壓縮
module.exports = {
mode: 'production',
entry: {
index: path.resolve(__dirname, '../src/index/main.mp.js'),
},
output: {
path: path.resolve(__dirname, '../dist/mp/common'), // 放到小程序代碼目錄中的 common 目錄下
filename: '[name].js', // 必需字段，不能修改
library: 'createApp', // 必需字段，不能修改
libraryExport: 'default', // 必需字段，不能修改
libraryTarget: 'window', // 必需字段，不能修改
},
target: 'web', // 必需字段，不能修改
optimization: {
runtimeChunk: false, // 必需字段，不能修改
splitChunks: { // 代碼分隔配置，不建議修改
chunks: 'all',
minSize: 1000,
maxSize: 0,
minChunks: 1,
maxAsyncRequests: 100,
maxInitialRequests: 100,
automaticNameDelimiter: '~',
name: true,
cacheGroups: {
vendors: {
test: /[\\/]node_modules[\\/]/,
priority: -10
},
default: {
minChunks: 2,
priority: -20,
reuseExistingChunk: true
}
}
},
minimizer: isOptimize ? [
// 壓縮CSS
new OptimizeCSSAssetsPlugin({
assetNameRegExp: /\.(css|wxss)$/g,
cssProcessor: require('cssnano'),
cssProcessorPluginOptions: {
preset: ['default', {
discardComments: {
removeAll: true,
},
minifySelectors: false, // 因為 wxss 編譯器不支持 .some>:first-child 這樣格式的代碼，所以暫時禁掉這個
}],
},
canPrint: false
}),
// 壓縮 js
new TerserPlugin({
test: /\.js(\?.*)?$/i,
parallel: true,
})
] : [],
},
module: {
rules: [
{
test: /\.css$/,
use: [
MiniCssExtractPlugin.loader,
'css-loader'
],
},
{
test: /\.vue$/,
loader: 'vue-loader',
},
{
test: /\.js$/,
use: [
'babel-loader'
],
exclude: /node_modules/
},
{
test: /\.(png|jpg|gif|svg)$/,
loader: 'file-loader',
options: {
name: '[name].[ext]?[hash]'
}
}
]
},
resolve: {
extensions: ['*', '.js', '.vue', '.json']
},
plugins: [
new webpack.DefinePlugin({
'process.env.isMiniprogram': process.env.isMiniprogram, // 注入環境變量，用于業務代碼判斷
}),
new MiniCssExtractPlugin({
filename: '[name].wxss',
}),
new VueLoaderPlugin(),
new MpPlugin(require('./miniprogram.config.js')),
],
}
在 04-custom-components/build 文件夾下創建 miniprogram.config.js 文件，內容如下：
const path = require('path')
module.exports = {
origin: 'https://test.miniprogram.com',
entry: '/',
router: {
index: ['/'],
},
redirect: {
notFound: 'index',
accessDenied: 'index',
},
generate: {
wxCustomComponent: {
root: path.join(__dirname, '../src/custom-components'),
usingComponents: {
'comp-a': {
path: 'comp-a',
props: ['prefix', 'suffix'],
events: ['someevent'],
},
'comp-b': {
path: 'comp-b/index',
props: ['prefix'],
},
'comp-c': 'comp-c',
},
},
// 構建完成后是否自動安裝小程序依賴。'npm'：使用 npm 自動安裝依賴
autoBuildNpm: 'npm'
},
app: {
navigationBarTitleText: 'miniprogram-project',
},
projectConfig: {
appid: '',
projectname: 'custom-components',
},
packageConfig: {
author: 'Felixlu',
},
}
2.3 編寫案例有關組件
2.3.1 創建 main.mp.js
在項目根目錄下創建 /src/index，在 index 下創建 main.mp.js 文件，內容如下：
import Vue from 'vue'
import App from './App.vue'
export default function createApp() {
const container = document.createElement('div')
container.id = 'app'
document.body.appendChild(container)
return new Vue({
el: '#app',
render: h => h(App)
})
}
2.3.2 創建 App.vue 組件
在 /src/index 下創建 App.vue 組件，內容為：
kbone
comp-a slot
comp-b slot
comp-c slot
update
2.3.3 創建 comp-a 組件
在根目錄下創建 /src/custom-components 文件夾，在這個文件夾下創建小程序原生組件 comp-a，四個文件內容如下：
/src/custom-components/comp-a.wxml
comp-a
comp-a button
{{prefix}}-{{str}}-{{suffix}}
/src/custom-components/comp-a.js
const _ = require('./common/utils')
Component({
properties: {
prefix: {
type: String,
value: 'defaultPrefix',
},
suffix: {
type: String,
value: 'defaultSuffix',
},
},
data: {
str: _.getWords() + 'comp-a',
},
methods: {
onTap() {
this.triggerEvent('someevent', {
detail: {
from: 'comp-a',
},
})
},
printf() {
console.log('I am comp-a')
},
},
})
/src/custom-components/common/utils.js
module.exports = {
getWords() {
return 'Hello, '
},
}
/src/custom-components/comp-a.json
{
"component": true
}
/src/custom-components/comp-a.wxss
// 內容為空
2.3.4 創建 comp-b 組件
在根目錄下創建 /src/custom-components/comp-b 文件夾，在這個文件夾下創建小程序原生組件 comp-b，四個文件內容如下：
/src/custom-components/comp-b/index.wxml
comp-b
{{prefix}}-{{str}}-{{suffix}}
/src/custom-components/comp-b/index.js
const _ = require('../common/utils')
Component({
properties: {
prefix: {
type: String,
value: 'defaultPrefix',
},
suffix: {
type: String,
value: 'defaultSuffix',
},
},
data: {
str: _.getWords() + 'comp-b',
},
})
/src/custom-components/comp-b/index.json
{
"component": true
}
/src/custom-components/comp-b/index.wxss
.prefix, .suffix {
color: green;
}
2.3.5 創建 comp-c 組件
在 /src/custom-components 文件夾下創建小程序原生組件 comp-c，四個文件內容如下：
/src/custom-components/comp-c.wxml
comp-c
comp-d slot
/src/custom-components/comp-c.js
Component({})
/src/custom-components/comp-c.json
{
"component": true,
"usingComponents": {
"comp-d": "./comp-d"
}
}
/src/custom-components/comp-c.wxss
// 內容為空
2.3.6 創建 comp-d 組件
在 /src/custom-components 文件夾下創建小程序原生組件 comp-d，四個文件內容如下：
/src/custom-components/comp-d.wxml
comp-d
/src/custom-components/comp-d.js
Component({})
/src/custom-components/comp-d.json
{
"component": true
}
/src/custom-components/comp-d.wxss
// 內容為空
2.4 小程序端效果預覽
npm run mp
京公網安備 11010802030320號