基於vue-cli3快速發佈一個fullpage組件

前言

想必你們都看過fullpage.js——這是一款很是好用的翻頁插件。

如今vue很是流行，你們想不想發佈一個組件給別人使用呢？

這裏咱們基於vue-cli3快速搭建一個簡單的fullpage組件給別人使用，固然你也能夠作你感興趣的組件發佈給別人用~

GITHUB

連接

開始

準備

$ npm i -g @vue/cli #全局vue-cli3
複製代碼

經過查看vue-cli3官網瞭解，建立一個新的普通項目。

思考

• 一開始要想別人如何調用咱們寫的組件，經過掛載vue實例方法（this.$alert）仍是註冊組件。答案天然是後者。咱們但願別人能夠這麼使用~

#一個section塊就是一個能夠滾動的塊
<v-fullpage>
 <div slot="section"></div>
 <div slot="section"></div>
</v-fullpage>
複製代碼

• 設計組件接口，prop。能夠有滾動方向（垂直仍是橫向）

Property	Description	Type	Default
direction	滾動方向('vertical'或'horizontal')	String	'vertical'

• 設計組件的回調（內部須要暴露什麼方法給外部）

Name	Description
leaveSlide	滑動以後，參數是當前 index

• 但願能夠主動調用內部方法，禁止/開放滾動事件

經過 ref 調用組件內部 api

Name	Description
setAllowScrolling	傳入 true/false，禁止滾動/開放滾動事件

目錄結構

├─ dist         //打包
├─ public
├─ src
│  ├─ assets
│  ├─ components    //存放全部 custom elements
│     ├─ fullpage.vue  //實際幹活的
│  ├─ App.vue    //內部demo，能夠引進來咱們寫的fullpage組件調試
│  └─ main.js    //入口文件
複製代碼

編寫

咱們在fullpage.vue寫邏輯，模板裏須要有一個slot（放置別人的div），這個div須要有個滾動盒子包裹（能夠經過translate移動）

<div class="v-fullpage-container" ref='v-fullpage' @mousewheel='mouseWheelHandle'>
//監聽鼠標滾輪事件
   <div class="v-slide-container" :class="direction" ref='v-slide-container' v-show='isShow'>
       <slot name='section'></slot>  
   </div>
</div>
複製代碼

先初始化容器寬度

//全部data
data(){
   return{
       fullpage:{
           //當前處於第幾個div
           current:1,
           isScrolling: false,
           // 返回鼠標滾輪的垂直滾動量
           deltaY:0,
       },
       //顯示滾動盒子
       isShow:false,
       //是否容許滾動
       isAllowScroll:true,
       api:{
         setAllowScrolling:this.setAllowScrolling
       }
   }
},
mounted() {
   this.initFullPage()
   //窗口resize時候從新設計大小
   window.addEventListener('resize',this.resizeEventHandler)
},
beforeDestroy() {
   //組件銷燬的時候remove事件監聽
   window.removeEventListener("resize", this.resizeEventHandler, false);
},
methods:{
   resizeEventHandler(){
       //節流,考慮效率
       throttle(this.initFullPage(),300)
   },
   initFullPage(){
       //初始化容器寬高度
       this.isShow=false
       let height = this.$refs['v-fullpage'].clientHeight;
       let width=this.$refs['v-fullpage'].clientWidth;
       //手動寫容器的寬度
       this.direction=='horizontal'?this.$refs['v-slide-container'].style.width=`${width*this.$slots.section.length}px`:null;
       //手動設置slots裏面爲section的樣式
       this.$slots.section.forEach((item)=>{
           item.elm.style.height=`${height}px`
           item.elm.style.width=`${width}px`
       })
       //顯示滾動盒子
       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) {
           // 爲了防止滾動屢次滾動，須要經過一個變量來控制是否滾動
           this.fullpage.isScrolling = true;
           this.directToMove(index)
           this.$emit('leaveSlide',{currentIndex:this.fullpage.current})
           //這裏的動畫是1s執行完，使用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 
         //判斷是垂直滾動仍是橫向滾動
         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){//是否能夠滾動
             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增長一個命令,而後執行npm run build:lib

"scripts": {
   "build:lib": "vue-cli-service build --target lib --name v-fullpage ./src/components/index.js",
 },
複製代碼

這樣咱們就會打包到dist幾個文件，主要打包成了umd（瀏覽器能夠引用）和commonjs模塊規範的包。 參考Vue Cli3 構建目標：庫

發佈

• pacakage.json發佈到npm的字段

配置 package.json 文件中發佈到 npm 的字段

name: 包名，該名字是惟一的。npm官網搜索一下有沒有,這裏咱們取v-fullpage
version: 版本號，每次發佈至 npm 須要修改版本號
description: 描述。
main: 入口文件，import/require的
keyword：關鍵字，以空格分離但願用戶最終搜索的詞。
author：做者
private：是否私有，須要修改成 false 才能發佈到 npm
複製代碼

• npm官網註冊npm帳號，有就不須要
• 回到咱們的目錄下，npm login
• 發佈，npm publish
• 須要等一下，npm官網搜索

使用

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>

複製代碼