uniapp 之创建和发布unimodules插件

目录

• 背景
• 前提条件
• 步骤
  • 新建步骤uni-modules插件
  • 编写插件内容
  • 编写插件文档
  • 发布到插件市场
• 参考网址

背景

最近在用uni-app做项目，根据项目的需要，用上了很多插件。真不错，可以站在巨人肩膀上摘苹果。

不过，在实际应用的时候，会有一些不尽人意。比如，在用到uni-search-bar插件时，发现取消按钮不能改变颜色。有的时候，页面上显得不那么符合期待。

 

我的期待自然是将“取消”按钮的文字改为白色。

题外话：本来本人对美也没有什么的追求（比如，我就告诉我的女朋友，我喜欢上她，绝对与她的颜值无关，然后，她就生气了，为什么？）。如果是自己用的系统，绝对略过这个问题。然后，本人一个小团队，没有美工、没有前端。做项目时，领导告诉我可以不管UI。然后，在阶段性汇报的时候，我就被批评的体无完肤，从能力到个人的远见，到为人处世……后来、后来，才听出画外音：你做的东西太丑了，看得我心情不好，所以，看你也不顺眼。

也许UI不重要，但是不重要的事情都做不好，怎么做重要的事？(⊙o⊙)…，似乎有道理。

所以，虽然本人审美不行。为了领导和自己的身体，不动怒，不委屈，还是尽量做好吧。

所以，根据我的实际情况。我找了半天，很多真没有找到合适的。于是，我想着自己开发，初次看官方文档，我似乎理解错了（https://nativesupport.dcloud.net.cn/NativePlugin/README）╮(╯▽╰)╭

以为要额外安装Android或IOS的开发环境，还要会……这简直是一个系列啊，哪有时间？

好在，时间总会有的。（这里是本人发布的搜索栏插件：https://ext.dcloud.net.cn/plugin?id=5617）。

前提条件

• 已安装HBuider X
• 用于测试的uni-app 项目
• 运行或测试的环境（这里使用了微信开发者工具和手机）

步骤

新建uni-modules插件

1. 右击项目的uni_modules文件夹，点击uni-modules插件。

2. 弹出对话框，填写插件id和地址和分类，点击【创建】。

3. 这里创建了本地uni_modules插件文件夹。

 

uni-modules的目录结构请参考https://uniapp.dcloud.io/uni_modules?id=%e7%9b%ae%e5%bd%95%e7%bb%93%e6%9e%84。

编写插件内容

现在，可以在插件的components目录下编辑插件内容了。这里luyj-search-bar.vue直接复制了插件https://ext.dcloud.net.cn/plugin?id=866的uni-search-bar文件夹的内容，然后做了修改。具体代码如下：

<template>
    <view class="uni-searchbar">
        <view :style="{borderRadius:radius+'px',backgroundColor: bgColor}" class="uni-searchbar__box" @click="searchClick">
            <view class="uni-searchbar__box-icon-search">
                <slot name="searchIcon">
                    <uni-icons color="#999999" size="18" type="search" />
                </slot>
            </view>
            <input v-if="show || searchVal" :focus="showSync" :placeholder="placeholder" :maxlength="maxlength" class="uni-searchbar__box-search-input"
             confirm-type="search" type="text" v-model="searchVal" @confirm="confirm" @blur="blur" @focus="emitFocus" />
            <text v-else class="uni-searchbar__text-placeholder">{{ placeholder }}</text>
            <view v-if="show && (clearButton==='always'||clearButton==='auto'&&searchVal!=='')" class="uni-searchbar__box-icon-clear"
             @click="clear">
                <slot name="clearIcon">
                    <uni-icons color="#c0c4cc" size="15" type="clear" />
                </slot>
            </view>
        </view>
        <text @click="cancel" class="uni-searchbar__cancel" v-if="cancelButton ==='always' || show && cancelButton ==='auto'"
         :style="{color: cancelColor}">{{cancelText}}</text>
    </view>
</template>

<script>
    /**
     * SearchBar 搜索栏
     * @description 搜索栏组件，通常用于搜索商品、文章等
     * @tutorial https://ext.dcloud.net.cn/plugin?id=5617
     * @property {Number} radius 搜索栏圆角
     * @property {Number} maxlength 输入最大长度
     * @property {String} placeholder 搜索栏Placeholder
     * @property {String} clearButton = [always|auto|none] 是否显示清除按钮
     *     @value always 一直显示
     *     @value auto 输入框不为空时显示
     *     @value none 一直不显示
     * @property {String} cancelButton = [always|auto|none] 是否显示取消按钮
     *     @value always 一直显示
     *     @value auto 输入框不为空时显示
     *     @value none 一直不显示
     * @property {String} cancelText 取消按钮的文字
     * @property {String} cancelColor 取消按钮的颜色
     * @property {String} bgColor 输入框背景颜色
     * @property {Boolean} focus 是否自动聚焦
     * @event {Function} confirm uniSearchBar 的输入框 confirm 事件，返回参数为uniSearchBar的value，e={value:Number}
     * @event {Function} input uniSearchBar 的 value 改变时触发事件，返回参数为uniSearchBar的value，e=value
     * @event {Function} cancel 点击取消按钮时触发事件，返回参数为uniSearchBar的value，e={value:Number}
     * @event {Function} clear 点击清除按钮时触发事件，返回参数为uniSearchBar的value，e={value:Number}
     * @event {Function} blur input失去焦点时触发事件，返回参数为uniSearchBar的value，e={value:Number}
     */

    export default {
        name: "LuyjSearchBar",
        props: {
            placeholder: {
                type: String,
                default: "请输入搜索内容"
            },
            radius: {
                type: [Number, String],
                default: 5
            },
            clearButton: {
                type: String,
                default: "auto"
            },
            cancelButton: {
                type: String,
                default: "auto"
            },
            cancelText: {
                type: String,
                default: '取消'
            },
            // 取消按钮的颜色
            cancelColor: {
                type: String,
                default: "#333333"
            },
            bgColor: {
                type: String,
                default: "#F8F8F8"
            },
            maxlength: {
                type: [Number, String],
                default: 100
            },
            value: {
                type: [Number, String],
                default: ""
            },
            focus: {
                type: Boolean,
                default: false
            }
        },
        data() {
            return {
                show: false,
                showSync: false,
                searchVal: ''
            }
        },
        watch: {
            value: {
                immediate: true,
                handler(newVal) {
                    this.searchVal = newVal
                    if (newVal) {
                        this.show = true
                    }
                }
            },
            focus: {
                immediate: true,
                handler(newVal) {
                    if (newVal) {
                        this.show = true;
                        this.$nextTick(() => {
                            this.showSync = true
                        })
                    }
                }
            },
            searchVal(newVal, oldVal) {
                this.$emit("input", newVal)
            }
        },
        methods: {
            searchClick() {
                if (this.show) {
                    return
                }
                this.show = true;
                this.$nextTick(() => {
                    this.showSync = true
                })
            },
            clear() {
                this.$emit("clear", {
                    value: this.searchVal
                })
                this.searchVal = ""
            },
            cancel() {
                this.$emit("cancel", {
                    value: this.searchVal
                });
                this.searchVal = ""
                this.show = false
                this.showSync = false
                // #ifndef APP-PLUS
                uni.hideKeyboard()
                // #endif
                // #ifdef APP-PLUS
                plus.key.hideSoftKeybord()
                // #endif
            },
            confirm() {
                // #ifndef APP-PLUS
                uni.hideKeyboard();
                // #endif
                // #ifdef APP-PLUS
                plus.key.hideSoftKeybord()
                // #endif
                this.$emit("confirm", {
                    value: this.searchVal
                })
            },
            blur() {
                // #ifndef APP-PLUS
                uni.hideKeyboard();
                // #endif
                // #ifdef APP-PLUS
                plus.key.hideSoftKeybord()
                // #endif
                this.$emit("blur", {
                    value: this.searchVal
                })
            },
            emitFocus(e) {
                this.$emit("focus", e.detail)
            }
        }
    };
</script>

<style lang="scss" scoped>
    $uni-searchbar-height: 36px;

    .uni-searchbar {
        /* #ifndef APP-NVUE */
        display: flex;
        /* #endif */
        flex-direction: row;
        position: relative;
        padding: $uni-spacing-col-base;
        // background-color: $uni-bg-color;
    }

    .uni-searchbar__box {
        /* #ifndef APP-NVUE */
        display: flex;
        box-sizing: border-box;
        /* #endif */
        overflow: hidden;
        position: relative;
        flex: 1;
        justify-content: center;
        flex-direction: row;
        align-items: center;
        height: $uni-searchbar-height;
        padding: 5px 8px 5px 0px;
        border- 0.5px;
        border-style: solid;
        border-color: $uni-border-color;
    }

    .uni-searchbar__box-icon-search {
        /* #ifndef APP-NVUE */
        display: flex;
        /* #endif */
        flex-direction: row;
        //  32px;
        padding: 0 8px;
        justify-content: center;
        align-items: center;
        color: $uni-text-color-placeholder;
    }

    .uni-searchbar__box-search-input {
        flex: 1;
        font-size: $uni-font-size-base;
        color: $uni-text-color;
    }

    .uni-searchbar__box-icon-clear {
        align-items: center;
        line-height: 24px;
        padding-left: 8px;
        /* #ifdef H5 */
        cursor: pointer;
        /* #endif */
    }

    .uni-searchbar__text-placeholder {
        font-size: $uni-font-size-base;
        color: $uni-text-color-placeholder;
        margin-left: 5px;
    }

    .uni-searchbar__cancel {
        padding-left: 10px;
        line-height: $uni-searchbar-height;
        font-size: 14px;
        color: $uni-text-color;
        /* #ifdef H5 */
        cursor: pointer;
        /* #endif */
    }
</style>

编写插件文档

1. 打开文件readme.md 编写插件文档。
2. 右击编写的插件，点击“发布到插件市场”。

发布到插件市场

1. 弹出发布到市场对话框。填写发布信息，包括分类、插件显示名称等。

 

2. 弹出发布到市场对话框。填写发布信息，包括分类、插件显示名称等。

 

注：插件发布的内容对应pack.json配置文件，可以编写插件配置。配置的详细说明请参考：https://uniapp.dcloud.io/uni_modules?id=%e9%85%8d%e7%bd%ae

3.更新日志为必填项。添加的更新日志，会与文件changelog.md同步。

 

参考网址

• https://uniapp.dcloud.io/uni_modules?id=%e7%9b%ae%e5%bd%95%e7%bb%93%e6%9e%84
• https://uniapp.dcloud.io/uni_modules?id=%e9%85%8d%e7%bd%ae