詳解基于vue-cli3快速發(fā)布一個(gè)fullpage組件
前言
想必大家都看過(guò)fullpage.js——這是一款非常好用的翻頁(yè)插件。
現(xiàn)在vue非常流行,大家想不想發(fā)布一個(gè)組件給別人使用呢?
這里我們基于vue-cli3快速搭建一個(gè)簡(jiǎn)單的fullpage組件給別人使用,當(dāng)然你也可以做你感興趣的組件發(fā)布給別人用~
GITHUB
開始
準(zhǔn)備
$ npm i -g @vue/cli #全局vue-cli3
通過(guò)查看vue-cli3官網(wǎng)了解,創(chuàng)建一個(gè)新的普通項(xiàng)目。
思考
一開始要想別人如何調(diào)用我們寫的組件,通過(guò)掛載vue實(shí)例方法(this.$alert)還是注冊(cè)組件。答案自然是后者。我們希望別人可以這么使用~
#一個(gè)section塊就是一個(gè)可以滾動(dòng)的塊 <v-fullpage> <div slot="section"></div> <div slot="section"></div> </v-fullpage>
設(shè)計(jì)組件接口,prop。可以有滾動(dòng)方向(垂直還是橫向)
Property | Description | Type | Default |
---|---|---|---|
direction | 滾動(dòng)方向('vertical'或'horizontal') | String | 'vertical' |
設(shè)計(jì)組件的回調(diào)(內(nèi)部需要暴露什么方法給外部)
Name | Description |
---|---|
leaveSlide | 滑動(dòng)之后,參數(shù)是當(dāng)前 index |
希望可以主動(dòng)調(diào)用內(nèi)部方法,禁止/開放滾動(dòng)事件
通過(guò) ref 調(diào)用組件內(nèi)部 api
Name | Description |
---|---|
setAllowScrolling | 傳入 true/false,禁止?jié)L動(dòng)/開放滾動(dòng)事件 |
目錄結(jié)構(gòu)
├─ dist //打包 ├─ public ├─ src │ ├─ assets │ ├─ components //存放所有 custom elements │ ├─ fullpage.vue //實(shí)際干活的 │ ├─ App.vue //內(nèi)部demo,可以引進(jìn)來(lái)我們寫的fullpage組件調(diào)試 │ └─ main.js //入口文件
編寫
我們?cè)趂ullpage.vue寫邏輯,模板里需要有一個(gè)slot(放置別人的div),這個(gè)div需要有個(gè)滾動(dòng)盒子包裹(可以通過(guò)translate移動(dòng))
<div class="v-fullpage-container" ref='v-fullpage' @mousewheel='mouseWheelHandle'> //監(jiān)聽(tīng)鼠標(biāo)滾輪事件 <div class="v-slide-container" :class="direction" ref='v-slide-container' v-show='isShow'> <slot name='section'></slot> </div> </div>
先初始化容器寬度
//所有data data(){ return{ fullpage:{ //當(dāng)前處于第幾個(gè)div current:1, isScrolling: false, // 返回鼠標(biāo)滾輪的垂直滾動(dòng)量 deltaY:0, }, //顯示滾動(dòng)盒子 isShow:false, //是否允許滾動(dòng) isAllowScroll:true, api:{ setAllowScrolling:this.setAllowScrolling } } }, mounted() { this.initFullPage() //窗口resize時(shí)候重新設(shè)計(jì)大小 window.addEventListener('resize',this.resizeEventHandler) }, beforeDestroy() { //組件銷毀的時(shí)候remove事件監(jiān)聽(tīng) window.removeEventListener("resize", this.resizeEventHandler, false); }, methods:{ resizeEventHandler(){ //節(jié)流,考慮效率 throttle(this.initFullPage(),300) }, initFullPage(){ //初始化容器寬高度 this.isShow=false let height = this.$refs['v-fullpage'].clientHeight; let width=this.$refs['v-fullpage'].clientWidth; //手動(dòng)寫容器的寬度 this.direction=='horizontal'?this.$refs['v-slide-container'].style.width=`${width*this.$slots.section.length}px`:null; //手動(dòng)設(shè)置slots里面為section的樣式 this.$slots.section.forEach((item)=>{ item.elm.style.height=`${height}px` item.elm.style.width=`${width}px` }) //顯示滾動(dòng)盒子 this.isShow=true }, }
滾輪事件
methods:{ next() { let len = this.$slots.section.length; if((this.fullpage.current + 1) <= len) { this.fullpage.current += 1; this.move(this.fullpage.current); } }, pre() { if(this.fullpage.current -1 > 0) { this.fullpage.current -= 1; this.move(this.fullpage.current); } }, move(index) { // 為了防止?jié)L動(dòng)多次滾動(dòng),需要通過(guò)一個(gè)變量來(lái)控制是否滾動(dòng) this.fullpage.isScrolling = true; this.directToMove(index) this.$emit('leaveSlide',{currentIndex:this.fullpage.current}) //這里的動(dòng)畫是1s執(zhí)行完,使用setTimeout延遲1s后解鎖 setTimeout(()=>{ this.fullpage.isScrolling = false; }, 1010); }, directToMove(index){ let height = this.$refs['v-fullpage'].clientHeight; let width=this.$refs['v-fullpage'].clientWidth; let $scroll = this.$refs['v-slide-container']; //位移多少 let displacement //判斷是垂直滾動(dòng)還是橫向滾動(dòng) if(this.direction=='vertical'){ displacement = -(index-1)*height + 'px'; $scroll.style.transform=`translateY(${displacement})` }else{ displacement = -(index-1)*width + 'px'; $scroll.style.transform=`translateX(${displacement})` } this.fullpage.current = index }, mouseWheelHandle (event) { if(!this.isAllowScroll){//是否可以滾動(dòng) return } if (this.fullpage.isScrolling) {// 加鎖部分 return false; } let e = event.originalEvent || event; this.fullpage.deltaY = e.deltaY; if (this.fullpage.deltaY > 0) { this.next(); } else if (this.fullpage.deltaY < 0) { this.pre(); } }, setAllowScrolling(isAllow){ this.isAllowScroll=isAllow }, }
寫到這里基本就完成了,我們需要打包成別人可以用的。感謝vue-cli3,都封裝的非常好了。
打包
在package.json的scripts增加一個(gè)命令,然后執(zhí)行npm run build:lib
"scripts": { "build:lib": "vue-cli-service build --target lib --name v-fullpage ./src/components/index.js", },
這樣我們就會(huì)打包到dist幾個(gè)文件,主要打包成了umd(瀏覽器可以引用)和commonjs模塊規(guī)范的包。
參考Vue Cli3 構(gòu)建目標(biāo):庫(kù)
發(fā)布
pacakage.json發(fā)布到npm的字段
配置 package.json 文件中發(fā)布到 npm 的字段
name: 包名,該名字是唯一的。npm官網(wǎng)搜索一下有沒(méi)有,這里我們?nèi)-fullpage
version: 版本號(hào),每次發(fā)布至 npm 需要修改版本號(hào)
description: 描述。
main: 入口文件,import/require的
keyword:關(guān)鍵字,以空格分離希望用戶最終搜索的詞。
author:作者
private:是否私有,需要修改為 false 才能發(fā)布到 npm
npm官網(wǎng)注冊(cè)npm賬號(hào),有就不需要
回到我們的目錄下,npm login
發(fā)布,npm publish
需要等一下,npm官網(wǎng)搜索
使用
import Vue from "vue"; import fullpage from "v-fullpage"; Vue.use(fullpage);
or
<script src="vue.min.js"></script> <!-- must place this line after vue.js --> <script src="v-fullpage.umd.min.js"></script>
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Vue-cli 使用json server在本地模擬請(qǐng)求數(shù)據(jù)的示例代碼
本篇文章主要介紹了Vue-cli 使用json server在本地模擬請(qǐng)求數(shù)據(jù)的示例代碼,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2017-11-11vue-router路由懶加載及實(shí)現(xiàn)的3種方式
這篇文章主要給大家介紹了關(guān)于vue-router路由懶加載及實(shí)現(xiàn)的3種方式,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-02-02web開發(fā)中如何優(yōu)雅的解決"重復(fù)請(qǐng)求"問(wèn)題
在我們的日常開發(fā)當(dāng)中,很多時(shí)候會(huì)出現(xiàn)短時(shí)間內(nèi)重復(fù)請(qǐng)求的情況,如果沒(méi)有妥當(dāng)?shù)靥幚砗蠊車?yán)重,這篇文章主要給大家介紹了關(guān)于web開發(fā)中如何優(yōu)雅的解決重復(fù)請(qǐng)求問(wèn)題的相關(guān)資料,需要的朋友可以參考下2022-05-05vue3深入學(xué)習(xí)?nextTick和historyApiFallback
這篇文章主要介紹了vue3深入學(xué)習(xí)?nextTick和historyApiFallback,文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的朋友可以參考一下2022-08-08簡(jiǎn)單實(shí)現(xiàn)一個(gè)vue公式編輯器組件demo
這篇文章主要介紹了輕松實(shí)現(xiàn)一個(gè)簡(jiǎn)單的vue公式編輯器組件示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01element-ui中el-cascader動(dòng)態(tài)加載和默認(rèn)值詳解
vue+elementUI項(xiàng)目中el-cascader級(jí)聯(lián)選擇器使用頻率非常高,下面這篇文章主要給大家介紹了關(guān)于element-ui中el-cascader動(dòng)態(tài)加載和默認(rèn)值的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-05-05vue2中provide/inject的使用與響應(yīng)式傳值詳解
Vue中 Provide/Inject實(shí)現(xiàn)了跨組件的通信,下面這篇文章主要給大家介紹了關(guān)于vue2中provide/inject的使用與響應(yīng)式傳值的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-09-09vue實(shí)現(xiàn)3D切換滾動(dòng)效果
這篇文章主要為大家詳細(xì)介紹了vue實(shí)現(xiàn)偽3D切換滾動(dòng)效果,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-04-04在vant 中使用cell組件 定義圖標(biāo)該圖片和位置操作
這篇文章主要介紹了在vant 中使用cell組件 定義圖標(biāo)該圖片和位置操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-11-11