手把手教你實(shí)現(xiàn)一個(gè) Vue 進(jìn)度條組件皆的!

image

最近在個(gè)人的項(xiàng)目中覆履,想對(duì)頁面之間跳轉(zhuǎn)的過程進(jìn)行優(yōu)化,想到了很多文檔或 npm 等都用到的頁面跳轉(zhuǎn)進(jìn)度條费薄,于是便想自己去實(shí)現(xiàn)一個(gè)硝全,特此記錄。

來看下 npm 搜索組件時(shí)候的效果:

image

so 下面咱們一起動(dòng)手實(shí)現(xiàn)一下唄楞抡。

定義使用方式

想實(shí)現(xiàn)一個(gè)組件的前提伟众,一定要想好你的需求是什么,還要自己去定義一個(gè)舒服的使用方法拌倍,這其中也是有原則的赂鲤,對(duì)使用者來說,使用方式越簡(jiǎn)單越好柱恤。那么對(duì)應(yīng)的代價(jià)就是寫這個(gè)組件的復(fù)雜度會(huì)變高数初。

我想要的使用方式是這樣的:可以在任意的地方去調(diào)用到這個(gè)方法,可以隨時(shí)控制其狀態(tài)梗顺。

看下對(duì)應(yīng)的代碼:

async someFunction () {

    this.$progress.start()

    try {

          const ret = await axios.get('/xxx')

          // some code ...

      this.$progress.finish()

    } catch (err) {

          // cache err ...

          this.$progress.fail()

    }

}

當(dāng)然泡孩,想在任意地方使用,少不了一個(gè)步驟寺谤,就是在全局注冊(cè)這個(gè)組件:

import progressBar from 'xxx/progress-bar'

Vue.use(progressBar, { // some config ... })

如果不想全局注冊(cè)仑鸥,你也可以在某個(gè)組件內(nèi)單獨(dú)使用,只要你開心就好变屁。

實(shí)現(xiàn)過程

先來建立一個(gè)文件夾和其中兩個(gè)文件:

progress-bar

    - 01 progress-bar.vue

    - 02 index.js

打開progress-bar.vue眼俊,先來寫結(jié)構(gòu)和樣式,這里很簡(jiǎn)單:

<template>

      <div :style='style'></div>

</template>

<style scoped>

      .bar {

        position: fixed;

        z-index: 99999;

        opacity: 1;

      }

</style>

在注冊(cè)組件的時(shí)候粟关,我想可以自定義一些功能疮胖,比如

  • 成功的顏色

  • 失敗的顏色

  • 進(jìn)度條的位置

  • 動(dòng)畫過渡時(shí)間

  • 加載方向

  • 高度

  • 是否可以自動(dòng)完成

當(dāng)然只要你想到的都可以添加,那么這些可以定制的屬性闷板,自然而然就成為了組件的 props:

export default {

  name: 'progressBar',

  props: {

    options: {

      type: Object,

      default () {

        return {

          succColor: 'rgb(76, 164, 214)',

          failColor: 'rgb(218, 26, 101)',

          position: 'top',

          transition: {

            widthSpeed: 200,

            opacitySpeed: 400,

            duration: 300  // 定義消失時(shí)間 ms

          },

          inverse: false,  // 進(jìn)度條的加載方向

          thickness: 2  // 進(jìn)度條的高度

        }

      }

    }

  }

}

</script>

除了要定義的屬性以外澎灸,那么組件本身總要有一些自己的屬性,用來控制自己的狀態(tài)遮晚,比如這個(gè)組件性昭,你要控制進(jìn)度條的長(zhǎng)度、顯示和隱藏等狀態(tài)县遣。

添加 vue 的 data 屬性:

data () {

      return {

      percent: 0,  // 進(jìn)度條長(zhǎng)度

            show: false, // 顯示和隱藏

            canSuccess: true  // 是否是成功的狀態(tài)

      }

}

有了這些屬性糜颠,這個(gè)進(jìn)度條就要根據(jù)這些屬性的變化來“自己動(dòng)”。所以這個(gè)時(shí)候首先想到的當(dāng)然就是 Vue 的計(jì)算屬性:

computed: {

  style () {

// 先拿到亂七八糟的屬性

const { succColor, failColor, location, transition, inverse, thickness } = this.options

const { widthSpeed, opacitySpeed } = transition

const { canSuccess, preset, show } = this

 // 定義 css 樣式

const style = {

  backgroundColor: canSuccess ? succColor : failColor,

  opacity: show ? 1 : 0

}

if (position !== 'top' || position !== 'bottom') {

  throw new Error('The wrong config of position!')

}

style[position] = 0

if (inverse) {

  style.left = 0

} else {

  style.right = 0

}

style.width = preset + '%'  // 設(shè)置進(jìn)度條長(zhǎng)度

style.height = thickness + 'px'  // 設(shè)置顯示高度

style.transition = `width ${widthSpeed}ms, opacity ${opacitySpeed}ms`  // 設(shè)置過度樣式

return style

  }

}

到這里這個(gè) vue 組件其實(shí)就完成了艺玲,接下來就是如何去控制它括蝠。打開index.js,先來寫一個(gè)標(biāo)準(zhǔn)的組件格式:

import progressBar from './progress-bar.vue'

export default {

  install (Vue, options = {}) {

  // 注冊(cè)組件

    Vue.component(progressBar.name, progressBar)

  }

}

之后咱們要用到 Vue 提供的擴(kuò)展方法饭聚,來完成咱們的需求忌警。

第一步,添加 autoFinish 屬性秒梳,用來設(shè)定動(dòng)畫是否可以自動(dòng)完成法绵,默認(rèn)是 true,當(dāng)然如果某個(gè)路由或請(qǐng)求一直處于 pending 狀態(tài)酪碘,你可以可以設(shè)置讓其永遠(yuǎn)不完成動(dòng)畫的動(dòng)作朋譬。

第二步,來寫一個(gè)對(duì)象兴垦,其中包含 start 徙赢、 finish 字柠、 fail 方法以及動(dòng)畫代碼。

第三步狡赐,將這個(gè)對(duì)象掛在到 Vue 的原型

完整的代碼和說明如下:

import progressBar from './progress-bar.vue'

export default {

  install (Vue, options = {}) {

// 注冊(cè)組件

Vue.component(progressBar.name, progressBar)

// 創(chuàng)建一個(gè) Vue 子類

const Component = Vue.extend(progressBar)

// 拿到自定義的屬性

const { autoFinish, ...res } = options

// 創(chuàng)建組件實(shí)例

const vm = new Component({

  data: {

    autoFinish: typeof autoFinish === 'boolean' ? autoFinish : true

  }

})

// 將 progressBar 的默認(rèn) options 與 自定義的 options 合并

options = Object.assign(vm.$props.options, { ...res })

//合并新的 props

vm.$propsData = options

vm.$mount()

// 如果是服務(wù)端渲染那么不繼續(xù)執(zhí)行

if (!vm.$isServer) {

  document.body.appendChild(vm.$el)

}

let timer = null

const progress = {

  start () {

    if (Vue.$isServer) return

    // 每次調(diào)用 start 都重新初始化一次窑业,比如多次點(diǎn)擊某個(gè)按鈕連續(xù)請(qǐng)求,那么每次都從0開始

    vm.percent = 0

    vm.show = true

    vm.canSuccess = true

    // 定一個(gè)增量枕屉,這個(gè)值可以改成參數(shù)常柄,也可以按照使用經(jīng)驗(yàn)來設(shè)定

    const CUT_SCALE = 5

    // 定義每 100 秒來執(zhí)行一次動(dòng)畫

    timer = setInterval(() => {

      // 每次執(zhí)行增量動(dòng)畫

      this.increase((CUT_SCALE - 1) * Math.random() + 1)

      // 如果進(jìn)度大于 95%,并且設(shè)置了自動(dòng)完成搀擂,那么執(zhí)行結(jié)束動(dòng)作

      if (vm.percent > 95 && vm.autoFinish) {

        this.finish()

      }

    }, 100)

  },

  increase (cut) {

    vm.percent = Math.min(99, vm.percent + cut)

  },

  hide () {

    clearInterval(timer)

    // 這里面有2個(gè)定時(shí)器西潘,外層定時(shí)器是讓用戶可以看到這個(gè) 進(jìn)度已經(jīng)完成啦

    // 內(nèi)層定時(shí)器,由于 opacity 消失需要一定的過渡時(shí)間哨颂,所以要等待它消失以后

    // 在將其進(jìn)度設(shè)置為0喷市,等待下次調(diào)用隐绵,如果不延遲患亿,那么會(huì)看到進(jìn)度到100后又回到0的動(dòng)畫

    setTimeout(() => {

      vm.show = false

      setTimeout(() => {

        vm.percent = 0

        timer = null

      }, vm.options.transition.opacitySpeed)

    }, vm.options.transition.duration)

  },

  // 下面這2個(gè)方法就很簡(jiǎn)單了,只需要完成進(jìn)度本缠,然后執(zhí)行隱藏即可

  finish () {

    if (Vue.$isServer) return

    vm.percent = 100

    this.hide()

  },

  fail () {

    if (Vue.$isServer) return

    // 修改未成功的狀態(tài)沃测,實(shí)際效果就是改變最后的顏色

    vm.canSuccess = false

    vm.percent = 100

    this.hide()

  }

}

// 最后掛在到全局

Vue.prototype.$progress = progress

  }

}

到這里缭黔,一個(gè)進(jìn)度條組件就完成了。大家可以自己動(dòng)手實(shí)踐一下蒂破,起一個(gè)項(xiàng)目馏谨,使用 vue-router 的 beforeResolve 聲明周期鉤子,或者寫一個(gè)定時(shí)器模擬異步來測(cè)試一下附迷。

以上是筆者歸納總結(jié)惧互,如有誤之處,歡迎指出喇伯。

往期文章推薦:

覺得本文對(duì)你有幫助艾猜?請(qǐng)分享給更多人

關(guān)注【妙味前端】加星標(biāo),關(guān)注更多內(nèi)容

image
image
image

訂閱號(hào)ID:Miaovclass

關(guān)注妙味訂閱號(hào):“妙味前端”捻悯,為您帶來優(yōu)質(zhì)前端技術(shù)干貨匆赃;

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市今缚,隨后出現(xiàn)的幾起案子算柳,更是在濱河造成了極大的恐慌,老刑警劉巖姓言,帶你破解...
    沈念sama閱讀 218,122評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件瞬项,死亡現(xiàn)場(chǎng)離奇詭異蔗蹋,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)囱淋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門纸颜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人绎橘,你說我怎么就攤上這事∵刖耄” “怎么了称鳞?”我有些...
    開封第一講書人閱讀 164,491評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)稠鼻。 經(jīng)常有香客問我冈止,道長(zhǎng),這世上最難降的妖魔是什么候齿? 我笑而不...
    開封第一講書人閱讀 58,636評(píng)論 1 293
  • 正文 為了忘掉前任熙暴,我火速辦了婚禮,結(jié)果婚禮上慌盯,老公的妹妹穿的比我還像新娘周霉。我一直安慰自己,他們只是感情好亚皂,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評(píng)論 6 392
  • 文/花漫 我一把揭開白布俱箱。 她就那樣靜靜地躺著,像睡著了一般灭必。 火紅的嫁衣襯著肌膚如雪狞谱。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,541評(píng)論 1 305
  • 那天禁漓,我揣著相機(jī)與錄音跟衅,去河邊找鬼。 笑死播歼,一個(gè)胖子當(dāng)著我的面吹牛伶跷,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播秘狞,決...
    沈念sama閱讀 40,292評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼撩穿,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了谒撼?” 一聲冷哼從身側(cè)響起食寡,我...
    開封第一講書人閱讀 39,211評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎廓潜,沒想到半個(gè)月后抵皱,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體善榛,經(jīng)...
    沈念sama閱讀 45,655評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評(píng)論 3 336
  • 正文 我和宋清朗相戀三年呻畸,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了移盆。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,965評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡伤为,死狀恐怖咒循,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情绞愚,我是刑警寧澤叙甸,帶...
    沈念sama閱讀 35,684評(píng)論 5 347
  • 正文 年R本政府宣布,位于F島的核電站位衩,受9級(jí)特大地震影響裆蒸,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜糖驴,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評(píng)論 3 329
  • 文/蒙蒙 一僚祷、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧贮缕,春花似錦辙谜、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至抑诸,卻和暖如春烂琴,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蜕乡。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評(píng)論 1 269
  • 我被黑心中介騙來泰國打工奸绷, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人层玲。 一個(gè)月前我還...
    沈念sama閱讀 48,126評(píng)論 3 370
  • 正文 我出身青樓号醉,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國和親辛块。 傳聞我的和親對(duì)象是個(gè)殘疾皇子畔派,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • 夜深人心靜,
    RongCZ閱讀 265評(píng)論 5 4
  • 一润绵、產(chǎn)品信息 1.體驗(yàn)環(huán)境 體驗(yàn)機(jī)型:Meizu Pro 6 (Android 7.1.1/ Flyme 6.2....
    木木君的小日子閱讀 1,004評(píng)論 0 5
  • “鴿鴿线椰。”一陣軟軟的聲音從一個(gè)暗道傳來尘盼。 “靈兒憨愉,不管發(fā)生什么事你千萬不能發(fā)出聲音烦绳,記住了么?”葉旭看...
    冰璃月閱讀 211評(píng)論 0 0