10個有用的自定義鉤子vue.js

前端小智發表於2022-04-13
Vue.js
作者：Sang Nguyen
譯者：前端小智
來源：medium

有夢想，有乾貨，微信搜尋 【大遷世界】 關注這個在凌晨還在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收錄，有一線大廠面試完整考點、資料以及我的系列文章。

Vue 是我使用的第一個 JS 框架。可以說，Vue 是我進入JavaScript世界的第一道門之一。目前，Vue 仍然是一個很棒的框架。隨著 composition API 的出現，Vue 只會有更大的發展。在這篇文章中，我將介紹 10 個有用的自定義鉤子，讓我們的程式碼更加好看。

useWindowResize

這是一個基本的鉤子，因為它被用在很多專案中.

import { ref, onMounted, onUnmounted } from 'vue';

export function useWindowResize() {
  const width = ref(window.innerWidth);
  const height = ref(window.innerHeight);
  const handleResize = () => {
    width.value = window.innerWidth;
    height.value = window.innerHeight;
  }

  onMounted(() => {
    window.addEventListener('resize', handleResize)
  });

  onUnmounted(() => {
    window.removeEventListener('resize', handleResize)
  })

  return {
    width,
    height
  }
}

使用就更簡單了，只需要呼叫這個鉤子就可以獲得 window 的寬度和高度。

setup() {
    const { width, height } = useWindowResize();
}

useStorage

你想通過在 session storage 或 local storage 中儲存資料的值來持久化資料，並將該值繫結到檢視？有了一個簡單的鉤子--useStorage，這將變得非常容易。我們只需要建立一個鉤子來返回從儲存空間得到的資料，以及一個函式來在我們想要改變資料時將其儲存在儲存空間。下面是我的鉤子。

import { ref } from 'vue';

const getItem = (key, storage) => {
  let value = storage.getItem(key);
  if (!value) {
    return null;
  }
  try {
    return JSON.parse(value)
  } catch (error) {
    return value;
  }
}

export const useStorage = (key, type = 'session') => {
  let storage = null;
  switch (type) {
    case 'session':
      storage = sessionStorage;
      break;
    case 'local':
      storage = localStorage;
      break;
    default:
      return null;
  }
  const value = ref(getItem(key, storage));
  const setItem = (storage) => {
    return (newValue) => {
      value.value = newValue;
      storage.setItem(key, JSON.stringify(newValue));
    }
  }
  return [
    value,
    setItem(storage)
  ]
}

在我的程式碼中，我使用 JSON.parse 和 JSON.stringify 來格式化資料。如果你不想格式化它，你可以刪除它。下面是一個如何使用這個鉤子的例子。

const [token, setToken] = useStorage('token');
setToken('new token');

useNetworkStatus

這是一個有用的鉤子，支援檢查網路連線的狀態。為了實現這個鉤子，我們需要為事件 "線上"和 "離線"新增事件監聽器。在事件中，我們只是呼叫一個回撥函式，引數為網路狀態。下面是我的程式碼。

import { onMounted, onUnmounted } from 'vue';

export const useNetworkStatus = (callback = () => { }) => {
  const updateOnlineStatus = () => {
    const status = navigator.onLine ? 'online' : 'offline';
    callback(status);
  }

  onMounted(() => {
    window.addEventListener('online', updateOnlineStatus);
    window.addEventListener('offline', updateOnlineStatus);
  });

  onUnmounted(() => {
    window.removeEventListener('online', updateOnlineStatus);
    window.removeEventListener('offline', updateOnlineStatus);
  })
}

呼叫方式：

useNetworkStatus((status) => { 
    console.log(`Your network status is ${status}`);
}

useCopyToClipboard

剪下板是一個比較常見的功能，我們也可以將它封裝成 hook，程式碼如下所示：

function copyToClipboard(text) {
  let input = document.createElement('input');
  input.setAttribute('value', text);
  document.body.appendChild(input);
  input.select();
  let result = document.execCommand('copy');
  document.body.removeChild(input);
  return result;
}

export const useCopyToClipboard = () => {
  return (text) => {
    if (typeof text === "string" || typeof text == "number") {
      return copyToClipboard(text);
    }
    return false;
  }
}

使用如下：

const copyToClipboard = useCopyToClipboard();
copyToClipboard('just copy');

useTheme

只是一個簡短的鉤子來改變網站的主題。它可以幫助我們輕鬆地切換網站的主題，只需用主題名稱呼叫這個鉤子。下面是一個我用來定義主題變數的CSS程式碼例子。

html[theme="dark"] {
   --color: #FFF;
   --background: #333;
}
html[theme="default"], html {
   --color: #333;
   --background: #FFF;
}

要改變主題，只需要做一個自定義的鉤子，它返回一個函式來通過主題名稱改變主題。程式碼如下：

export const useTheme = (key = '') => {
  return (theme) => {
    document.documentElement.setAttribute(key, theme);
  }
}

使用如下：

const changeTheme = useTheme();
changeTheme('dark');

usePageVisibility

有時，當客戶不專注於我們的網站時，我們需要做一些事情。要做到這一點，我們需要一些東西，讓我們知道使用者是否在關注。這是一個自定義的鉤子。我把它叫做 PageVisibility，程式碼如下：

import { onMounted, onUnmounted } from 'vue';

export const usePageVisibility = (callback = () => { }) => {
  let hidden, visibilityChange;
  if (typeof document.hidden !== "undefined") {
    hidden = "hidden";
    visibilityChange = "visibilitychange";
  } else if (typeof document.msHidden !== "undefined") {
    hidden = "msHidden";
    visibilityChange = "msvisibilitychange";
  } else if (typeof document.webkitHidden !== "undefined") {
    hidden = "webkitHidden";
    visibilityChange = "webkitvisibilitychange";
  }

  const handleVisibilityChange = () => {
    callback(document[hidden]);
  }

  onMounted(() => {
    document.addEventListener(visibilityChange, handleVisibilityChange, false);
  });

  onUnmounted(() => {
    document.removeEventListener(visibilityChange, handleVisibilityChange);
  });
}

用法如下：

usePageVisibility((hidden) => {
   console.log(`User is${hidden ? ' not' : ''} focus your site`);
});

useViewport

有時我們會用寬度來檢測當前的使用者裝置，這樣我們就可以根據裝置來處理對應的內容。這種場景，我們也可以封裝成一個 hook，程式碼如下：

import { ref, onMounted, onUnmounted } from 'vue';

export const MOBILE = 'MOBILE'
export const TABLET = 'TABLET'
export const DESKTOP = 'DESKTOP'

export const useViewport = (config = {}) => {
  const { mobile = null, tablet = null } = config;
  let mobileWidth = mobile ? mobile : 768;
  let tabletWidth = tablet ? tablet : 922;
  let device = ref(getDevice(window.innerWidth));
  function getDevice(width) {
    if (width < mobileWidth) {
      return MOBILE;
    } else if (width < tabletWidth) {
      return TABLET;
    }
    return DESKTOP;
  }

  const handleResize = () => {
    device.value = getDevice(window.innerWidth);
  }

  onMounted(() => {
    window.addEventListener('resize', handleResize);
  });

  onUnmounted(() => {
    window.removeEventListener('resize', handleResize);
  });

  return {
    device
  }
}

使用如下：

const { device } = useViewport({ mobile: 700, table: 900 });

useOnClickOutside

當 model 框彈出時，我們希望能點選其它區域關閉它，這個可以使用 clickOutSide，這種場景我們也可以封裝成鉤子，程式碼如下：

import { onMounted, onUnmounted } from 'vue';

export const useOnClickOutside = (ref = null, callback = () => {}) => {
  function handleClickOutside(event) {
    if (ref.value && !ref.value.contains(event.target)) {
      callback()
    }
  }

  onMounted(() => {
    document.addEventListener('mousedown', handleClickOutside);
  })

  onUnmounted(() => {
    document.removeEventListener('mousedown', handleClickOutside);
  });
}

用法如下：

<template>
    <div ref="container">View</div>
</template>
<script>
import { ref } from 'vue';
export default {
    setup() {
        const container = ref(null);
        useOnClickOutside(container, () => {
            console.log('Clicked outside'); 
        })
    }
}
</script>

useScrollToBottom

除了分頁列表，載入更多（或懶惰載入）是一種友好的載入資料的方式。特別是對於移動裝置，幾乎所有執行在移動裝置上的應用程式都在其使用者介面中應用了load more。要做到這一點，我們需要檢測使用者滾動到列表底部，併為該事件觸發一個回撥。 useScrollToBottom 是一個有用的鉤子，支援你這樣做。程式碼如下：

import { onMounted, onUnmounted } from 'vue';

export const useScrollToBottom = (callback = () => { }) => {
  const handleScrolling = () => {
    if ((window.innerHeight + window.scrollY) >= document.body.scrollHeight) {
      callback();
    }
  }

  onMounted(() => {
    window.addEventListener('scroll', handleScrolling);
  });

  onUnmounted(() => {
    window.removeEventListener('scroll', handleScrolling);
  });
}

用法如下：

useScrollToBottom(() => { console.log('Scrolled to bottom') })

useTimer

useTimer 的程式碼比其他鉤子要長一些。 useTimer 支援執行一個帶有一些選項的定時器，如開始、暫停/恢復、停止。要做到這一點，我們需要使用 setInterval 方法。在這裡，我們需要檢查定時器的暫停狀態。如果定時器沒有暫停，我們只需要呼叫一個回撥函式，該函式由使用者作為引數傳遞。為了支援使用者瞭解該定時器當前的暫停狀態，除了action useTimer之外，還要給他們一個變數 isPaused，其值為該定時器的暫停狀態。程式碼如下：

import { ref, onUnmounted } from 'vue';

export const useTimer = (callback = () => { }, step = 1000) => {
  let timerVariableId = null;
  let times = 0;
  const isPaused = ref(false);
   
  const stop = () => {
    if (timerVariableId) {
      clearInterval(timerVariableId);
      timerVariableId = null;
      resume();
    }
  }
  
  const start = () => {
    stop();
    if (!timerVariableId) {
      times = 0;
      timerVariableId = setInterval(() => {
        if (!isPaused.value) {
          times++;
          callback(times, step * times);
        }
      }, step)
    }
  }

  const pause = () => {
    isPaused.value = true;
  }

  const resume = () => {
    isPaused.value = false;
  }

  onUnmounted(() => {
    if (timerVariableId) {
      clearInterval(timerVariableId);
    }
  })

  return {
    start,
    stop,
    pause,
    resume,
    isPaused
  }
}

用法如下：

function handleTimer(round) {      
    roundNumber.value = round;    
}
const { 
    start,
    stop,
    pause,
    resume,
    isPaused
} = useTimer(handleTimer);

本文分享了10個有用的Vue自定義鉤子。希望它們對你有幫助。Vue. 是一個很棒的框架，希望你能用它來構建更多很棒的東西。

程式碼部署後可能存在的BUG沒法實時知道，事後為了解決這些BUG，花了大量的時間進行log 除錯，這邊順便給大家推薦一個好用的BUG監控工具 Fundebug。

原文：https://javascript.plainengli...

交流

有夢想，有乾貨，微信搜尋 【大遷世界】 關注這個在凌晨還在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收錄，有一線大廠面試完整考點、資料以及我的系列文章。

相關文章