React前端DOM常見Hook封裝示例上
引言
本文是深入淺出 ahooks 源碼系列文章的第十四篇,這個(gè)系列的目標(biāo)主要有以下幾點(diǎn):
- 加深對 React hooks 的理解。
- 學(xué)習(xí)如何抽象自定義 hooks。構(gòu)建屬于自己的 React hooks 工具庫。
- 培養(yǎng)閱讀學(xué)習(xí)源碼的習(xí)慣,工具庫是一個(gè)對源碼閱讀不錯(cuò)的選擇。
上一篇我們探討了 ahooks 對 DOM 類 Hooks 使用規(guī)范,以及源碼中是如何去做處理的。接下來我們就針對關(guān)于 DOM 的各個(gè) Hook 封裝進(jìn)行解讀。
useEventListener
優(yōu)雅的使用 addEventListener。
我們先來看看 addEventListener 的定義,以下來自 MDN 文檔:
EventTarget.addEventListener() 方法將指定的監(jiān)聽器注冊到 EventTarget 上,當(dāng)該對象觸發(fā)指定的事件時(shí),指定的回調(diào)函數(shù)就會被執(zhí)行。
這里的 EventTarget 可以是一個(gè)文檔上的元素 Element,Document和Window 或者任何其他支持事件的對象 (比如 XMLHttpRequest)。
我們看 useEventListener 函數(shù) TypeScript 定義,通過類型重載,它對 Element、Document、Window 等元素以及其事件名稱和回調(diào)參數(shù)都做了定義。
function useEventListener<K extends keyof HTMLElementEventMap>( eventName: K, handler: (ev: HTMLElementEventMap[K]) => void, options?: Options<HTMLElement>, ): void; function useEventListener<K extends keyof ElementEventMap>( eventName: K, handler: (ev: ElementEventMap[K]) => void, options?: Options<Element>, ): void; function useEventListener<K extends keyof DocumentEventMap>( eventName: K, handler: (ev: DocumentEventMap[K]) => void, options?: Options<Document>, ): void; function useEventListener<K extends keyof WindowEventMap>( eventName: K, handler: (ev: WindowEventMap[K]) => void, options?: Options<Window>, ): void; function useEventListener(eventName: string, handler: noop, options: Options): void;
內(nèi)部代碼比較簡單:
- 判斷是否支持 addEventListener,支持則將參數(shù)進(jìn)行傳遞??梢粤粢庾⑨屩械膸讉€(gè)參數(shù)的作用,當(dāng)做復(fù)習(xí),這里不展開細(xì)說。
- useEffect 的返回邏輯,也就是組件卸載的時(shí)候,會自動(dòng)清除事件監(jiān)聽器,避免產(chǎn)生內(nèi)存泄露。
function useEventListener(
// 事件名稱
eventName: string,
// 處理函數(shù)
handler: noop,
// 設(shè)置
options: Options = {},
) {
const handlerRef = useLatest(handler);
useEffectWithTarget(
() => {
const targetElement = getTargetElement(options.target, window);
if (!targetElement?.addEventListener) {
return;
}
const eventListener = (event: Event) => {
return handlerRef.current(event);
};
// 監(jiān)聽事件
targetElement.addEventListener(eventName, eventListener, {
// listener 會在該類型的事件捕獲階段傳播到該 EventTarget 時(shí)觸發(fā)。
capture: options.capture,
// listener 在添加之后最多只調(diào)用一次。如果是 true,listener 會在其被調(diào)用之后自動(dòng)移除。
once: options.once,
// 設(shè)置為 true 時(shí),表示 listener 永遠(yuǎn)不會調(diào)用 preventDefault() 。如果 listener 仍然調(diào)用了這個(gè)函數(shù),客戶端將會忽略它并拋出一個(gè)控制臺警告
passive: options.passive,
});
// 移除事件
return () => {
targetElement.removeEventListener(eventName, eventListener, {
capture: options.capture,
});
};
},
[eventName, options.capture, options.once, options.passive],
options.target,
);
}
useClickAway
監(jiān)聽目標(biāo)元素外的點(diǎn)擊事件。
提到這個(gè)的應(yīng)用場景,應(yīng)該是模態(tài)框,點(diǎn)擊外部陰影部分,自動(dòng)關(guān)閉的場景。那這里它是怎么實(shí)現(xiàn)的呢?
首先它支持傳遞 DOM 節(jié)點(diǎn)或者 Ref,并且是支持?jǐn)?shù)組方式。 事件默認(rèn)是支持 click,開發(fā)者可以自行傳遞并支持?jǐn)?shù)組方式。
export default function useClickAway<T extends Event = Event>(
// 觸發(fā)函數(shù)
onClickAway: (event: T) => void,
// DOM 節(jié)點(diǎn)或者 Ref,支持?jǐn)?shù)組
target: BasicTarget | BasicTarget[],
// 指定需要監(jiān)聽的事件,支持?jǐn)?shù)組
eventName: string | string[] = 'click',
) {
}
然后內(nèi)部通過 document.addEventListener 監(jiān)聽事件。組件卸載的時(shí)候清除事件監(jiān)聽。
// 事件列表
const eventNames = Array.isArray(eventName) ? eventName : [eventName];
// document.addEventListener 監(jiān)聽事件,通過事件代理的方式知道目標(biāo)節(jié)點(diǎn)
eventNames.forEach((event) => document.addEventListener(event, handler));
return () => {
eventNames.forEach((event) => document.removeEventListener(event, handler));
};
最后看 handler 函數(shù),通過 event.target 獲取到觸發(fā)事件的對象 (某個(gè) DOM 元素) 的引用,判斷假如不在傳入的 target 列表中,則觸發(fā)定義好的 onClickAway 函數(shù)。
const handler = (event: any) => {
const targets = Array.isArray(target) ? target : [target];
if (
// 判斷點(diǎn)擊的 DOM Target 是否在定義的 DOM 元素(列表)中
targets.some((item) => {
const targetElement = getTargetElement(item);
return !targetElement || targetElement.contains(event.target);
})
) {
return;
}
// 觸發(fā)點(diǎn)擊事件
onClickAwayRef.current(event);
};
小結(jié)一下,useClickAway 就是使用了事件代理的方式,通過 document 監(jiān)聽事件,判斷觸發(fā)事件的 DOM 元素是否在 target 列表中,從而決定是否要觸發(fā)定義好的函數(shù)。
useEventTarget
常見表單控件(通過 e.target.value 獲取表單值) 的 onChange 跟 value 邏輯封裝,支持自定義值轉(zhuǎn)換和重置功能。
直接看代碼,比較簡單,其實(shí)就是監(jiān)聽表單的 onChange 事件,拿到值后更新 value 值,更新的邏輯支持自定義。
function useEventTarget<T, U = T>(options?: Options<T, U>) {
const { initialValue, transformer } = options || {};
const [value, setValue] = useState(initialValue);
// 自定義轉(zhuǎn)換函數(shù)
const transformerRef = useLatest(transformer);
const reset = useCallback(() => setValue(initialValue), []);
const onChange = useCallback((e: EventTarget<U>) => {
// 獲取 e.target.value 的值,并進(jìn)行設(shè)置
const _value = e.target.value;
if (isFunction(transformerRef.current)) {
return setValue(transformerRef.current(_value));
}
// no transformer => U and T should be the same
return setValue(_value as unknown as T);
}, []);
return [
value,
{
onChange,
reset,
},
] as const;
}
useTitle
用于設(shè)置頁面標(biāo)題。
這個(gè)頁面標(biāo)題指的是瀏覽器 Tab 中展示的。通過 document.title 設(shè)置。

代碼非常簡單,一看就會:
function useTitle(title: string, options: Options = DEFAULT_OPTIONS) {
const titleRef = useRef(isBrowser ? document.title : '');
useEffect(() => {
document.title = title;
}, [title]);
useUnmount(() => {
// 組件卸載后,恢復(fù)上一次的 title
if (options.restoreOnUnmount) {
document.title = titleRef.current;
}
});
}
useFavicon
設(shè)置頁面的 favicon。
favicon 指的是頁面 Tab 的這個(gè) ICON。

原理是通過 link 標(biāo)簽設(shè)置 favicon。
const useFavicon = (href: string) => {
useEffect(() => {
if (!href) return;
const cutUrl = href.split('.');
const imgSuffix = cutUrl[cutUrl.length - 1].toLocaleUpperCase() as ImgTypes;
const link: HTMLLinkElement =
document.querySelector("link[rel*='icon']") || document.createElement('link');
// 用于定義鏈接的內(nèi)容的類型。
link.type = ImgTypeMap[imgSuffix];
// 指定被鏈接資源的URL。
link.href = href;
// 此屬性命名鏈接文檔與當(dāng)前文檔的關(guān)系。
link.rel = 'shortcut icon';
document.getElementsByTagName('head')[0].appendChild(link);
}, [href]);
};以上就是React前端DOM常見Hook封裝示例上的詳細(xì)內(nèi)容,更多關(guān)于React前端DOM Hook封裝的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
基于react框架使用的一些細(xì)節(jié)要點(diǎn)的思考
下面小編就為大家?guī)硪黄趓eact框架使用的一些細(xì)節(jié)要點(diǎn)的思考。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-05-05
React antd tabs切換造成子組件重復(fù)刷新
這篇文章主要介紹了React antd tabs切換造成子組件重復(fù)刷新,需要的朋友可以參考下2021-04-04
React-router?v6在Class組件和非組件代碼中的正確使用
這篇文章主要介紹了React-router?v6在Class組件和非組件代碼中的正確使用方式,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-03-03
React?Hooks之useDeferredValue鉤子用法示例詳解
useDeferredValue鉤子的主要目的是在React的并發(fā)模式中提供更流暢的用戶體驗(yàn),特別是在有高優(yōu)先級和低優(yōu)先級更新的情況下,本文主要講解一些常見的使用場景及其示例2023-09-09
react hooks使用Echarts圖表中遇到的情況及相關(guān)配置問題
這篇文章主要介紹了react hooks使用Echarts圖表中遇到的情況及相關(guān)配置問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-03-03

