網(wǎng)站首頁 編程語言 正文
引言
本文是深入淺出 ahooks 源碼系列文章的第十四篇,這個系列的目標(biāo)主要有以下幾點(diǎn):
- 加深對 React hooks 的理解。
- 學(xué)習(xí)如何抽象自定義 hooks。構(gòu)建屬于自己的 React hooks 工具庫。
- 培養(yǎng)閱讀學(xué)習(xí)源碼的習(xí)慣,工具庫是一個對源碼閱讀不錯的選擇。
上一篇我們探討了 ahooks 對 DOM 類 Hooks 使用規(guī)范,以及源碼中是如何去做處理的。接下來我們就針對關(guān)于 DOM 的各個 Hook 封裝進(jìn)行解讀。
useEventListener
優(yōu)雅的使用 addEventListener。
我們先來看看 addEventListener 的定義,以下來自 MDN 文檔:
EventTarget.addEventListener() 方法將指定的監(jiān)聽器注冊到 EventTarget 上,當(dāng)該對象觸發(fā)指定的事件時,指定的回調(diào)函數(shù)就會被執(zhí)行。
這里的 EventTarget 可以是一個文檔上的元素 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)行傳遞。可以留意注釋中的幾個參數(shù)的作用,當(dāng)做復(fù)習(xí),這里不展開細(xì)說。
- useEffect 的返回邏輯,也就是組件卸載的時候,會自動清除事件監(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 時觸發(fā)。
capture: options.capture,
// listener 在添加之后最多只調(diào)用一次。如果是 true,listener 會在其被調(diào)用之后自動移除。
once: options.once,
// 設(shè)置為 true 時,表示 listener 永遠(yuǎn)不會調(diào)用 preventDefault() 。如果 listener 仍然調(diào)用了這個函數(shù),客戶端將會忽略它并拋出一個控制臺警告
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)擊事件。
提到這個的應(yīng)用場景,應(yīng)該是模態(tài)框,點(diǎn)擊外部陰影部分,自動關(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)聽事件。組件卸載的時候清除事件監(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ā)事件的對象 (某個 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)題。
這個頁面標(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 的這個 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]);
};
原文鏈接:https://juejin.cn/post/7113033393146691592
相關(guān)推薦
- 2023-02-15 PyQt5+PyQt5Designer的安裝步驟_python
- 2022-05-29 C/C++迭代器的失效問題詳解_C 語言
- 2022-12-02 python3中join和格式化的用法小結(jié)_python
- 2022-09-19 Python?matplotlib數(shù)據(jù)可視化圖繪制_python
- 2022-08-11 boost.asio框架系列之buffer函數(shù)_C 語言
- 2023-04-06 C語言中的多行輸入問題及說明_C 語言
- 2022-02-12 使用background-attachment實(shí)現(xiàn)視差滾動、水波
- 2022-07-12 Samba安裝與配置流程
- 最近更新
-
- window11 系統(tǒng)安裝 yarn
- 超詳細(xì)win安裝深度學(xué)習(xí)環(huán)境2025年最新版(
- Linux 中運(yùn)行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎(chǔ)操作-- 運(yùn)算符,流程控制 Flo
- 1. Int 和Integer 的區(qū)別,Jav
- spring @retryable不生效的一種
- Spring Security之認(rèn)證信息的處理
- Spring Security之認(rèn)證過濾器
- Spring Security概述快速入門
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權(quán)
- redisson分布式鎖中waittime的設(shè)
- maven:解決release錯誤:Artif
- restTemplate使用總結(jié)
- Spring Security之安全異常處理
- MybatisPlus優(yōu)雅實(shí)現(xiàn)加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務(wù)發(fā)現(xiàn)-Nac
- Spring Security之基于HttpR
- Redis 底層數(shù)據(jù)結(jié)構(gòu)-簡單動態(tài)字符串(SD
- arthas操作spring被代理目標(biāo)對象命令
- Spring中的單例模式應(yīng)用詳解
- 聊聊消息隊(duì)列,發(fā)送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠(yuǎn)程分支