15 个颇有用的自定义 React Hooks

时间 2020-06-15

标签颇有用的自定义 react hooks 栏目 React 繁體版

原文原文链接

React 提供了自定义 Hooks 的特性，咱们能够根据这个特性建立出不少有意思的功能，今天就来分享一些我的认为还不错的 Hooks，共计 15 个。react

若是对于 React Hooks 还不是特别熟悉的话，能够先参阅这篇文章：React Hooks 温故而知新git

useClippy

useClippy 是一个用来读取或写入粘贴板的自定义 Hook，支持 TypeScript。github

官方文档：github.com/CharlesStov…npm

代码示例：api

import useClippy from 'use-clippy';

export default () => {
  const [clipboard, setClipboard] = useClippy();

  return (
    <div> <button onClick={() => { alert(`粘贴板内容为: ${clipboard}`); }} > 读取粘贴板 </button> <button onClick={() => { setClipboard(`新内容: ${Math.random()}`); }} > 写入粘贴板 </button> </div>
  );
};
复制代码

useWindowSize

useWindowSize 用于获取浏览器窗口大小，默认按 debounce 方式获取，固然也能够以 throttled 方式获取。浏览器

官方文档：github.com/jaredLunde/…网络

代码示例：dom

import { useWindowSize } from '@react-hook/window-size';
// import { useWindowSize } from '@react-hook/window-size/throttled';

export default (props) => {
  const [width, height] = useWindowSize();

  return (
    <div> width: {width}, height: {height} </div>
  );
};
复制代码

useMediaQuery

useMediaQuery经过在组件中使用 CSS3 Media Query 来控制组件。异步

官方文档：github.com/jaredLunde/…async

代码示例：

import React from 'react';
import { useMediaQuery, useMediaQueries } from '@react-hook/media-query';

// Using a single media query
// export default () => {
// const matches = useMediaQuery('only screen and (min-width: 400px)');
// return `Matches? ${matches ? 'Matched!' : 'Nope'}`;
// };

// Using multiple media queries
export default () => {
  const { matches, matchesAny, matchesAll } = useMediaQueries({
    screen: 'screen',
    width: '(min-width: 400px)',
  });

  return (
    <ul> <li>Screen matched? {matches.screen ? 'Yes' : 'No'}</li> <li>Width matched? {matches.width ? 'Yes' : 'No'}</li> <li>All matched? {matchesAll ? 'Yes' : 'No'}</li> <li>Any matched? {matchesAny ? 'Yes' : 'No'}</li> </ul>
  );
};
复制代码

useAsync

useAsync 用于优雅地解决、取消和处理异步函数或 Promise，而且当组件卸载时还能够自动清除它们。

官方文档：github.com/jaredLunde/…

代码示例：

import { useAsync } from '@react-hook/async';

export default () => {
  const [{ status, cancel, error, value }, call] = useAsync(() => {
    return new Promise((resolve) => setTimeout(() => resolve('Loaded'), 3000));
  });

  switch (status) {
    case 'loading':
      return (
        <div> <button onClick={cancel}>Cancel</button> Loading... </div>
      );
    case 'cancelled':
      return (
        <div> Cancelled. <button onClick={call}>Try again</button> </div>
      );
    case 'error':
      return `Error: ${error}`;
    case 'success':
      return value || 'Success!';
    default:
      return <button onClick={call}>Load me</button>;
  }
};
复制代码

useBrowserContextCommunication

useBrowserContextCommunication 使用 Broadcast Channel API 为不一样浏览器上下文（选项卡，iframe，窗口）之间的通讯提供简单的解决方案。

官方文档：github.com/AvraamMavri…

代码示例：

import useBrowserContextCommunication from 'react-window-communication-hook';

export default () => {
  // communicationState 是一个 {lastMessage, messages} 对象，用于从其它的浏览器上下文接收数据
  const [communicationState, postMessage] = useBrowserContextCommunication(
    'channel'
  );

  const [status, setStatus] = useState('login');

  function logout() {
    setStatus('logout');
    postMessage('logout');
  }

  const isLogout = [communicationState.lastMessage, status].includes('logout');

  return (
    <div> <h1>状态：{isLogout ? '已退出' : '已登陆'}</h1> <button onClick={logout}>退出</button> </div>
  );
};
复制代码

能够在浏览器里打开两个 Tab，而后在其中一个页面点击「退出」按钮，会发现两个 Tab 的页面都发生了变化。

useScript

useScript 用于动态加载外部脚本，并提供了 onLoad 回调用于获得脚本加载完成的时间。

官方文档：github.com/hupe1980/re…

代码示例：

import { StripeProvider } from 'react-stripe-elements';
import useScript from 'react-script-hook';

export default () => {
  const [loading, error] = useScript({ src: 'https://js.stripe.com/v3/' });

  if (loading) return <h3>Loading Stripe API...</h3>;
  if (error) return <h3>Failed to load Stripe API: {error.message}</h3>;

  return (
    <StripeProvider apiKey="pk_test_6pRNASCoBOKtIshFeQd4XMUh"> <div>Hello</div> </StripeProvider>
  );
};
复制代码

固然也能够以回调函数的形式使用：

useScript({ 
  src: 'https://js.stripe.com/v3/',
  onload: () => console.log('Script loaded!') 
})
复制代码

useLocalStorage

useLocalStorage 用于经过 localStorage API 进行数据存取。

官方文档：github.com/rehooks/loc…

代码示例：

import { useLocalStorage, writeStorage } from '@rehooks/local-storage';

let counter = 0;

export default () => {
  const [counterData] = useLocalStorage('counter');

  return (
    <> {counter} <button onClick={() => writeStorage('counter', ++counter)}>Write</button> <button onClick={() => alert(counterData)}>Read</button> </> ); }; 复制代码

useIdb

useIdb 使用浏览器中的 IndexedDB 来存储数据，跟 useLocalStorage 相似。

官方文档：github.com/kigiri/reac…

代码示例：

import { useIdb } from 'react-use-idb';

export default () => {
  const [value, setValue] = useIdb('my-key', 'foo');

  return (
    <div> <div>Value: {value}</div> <button onClick={() => setValue('bar')}>bar</button> <button onClick={() => setValue('baz')}>baz</button> </div>
  );
};
复制代码

use-mouse-action

use-mouse-action 用于监听点击事件时鼠标（也多是触摸板）按下或弹起。

官方文档：github.com/dimitrinico…

代码示例：

import useMouseAction from 'use-mouse-action';

export default () => {
  const props = useMouseAction({
    onAction: () => console.log('You clicked or mouse downed me!'),
    down: true,
  });

  return (
    <button type="button" {...props}> Click me fast! </button>
  );
};
复制代码

useDebounce

useDebounce 用于延迟 setState 或者其它回调函数的执行。

官方文档：github.com/jaredLunde/…

代码示例：

import {useDebounce, useDebounceCallback} from '@react-hook/debounce'

const Component = (props) => {
  // at a basic level, used just like useState
  const [value, setValue] = useDebounce('initialValue')
}

const useMyCallback = (initialState, wait, leading) => {
  // this is the same code useDebounce() uses to debounce setState
  const [state, setState] = useState(initialState)
  return [state, useDebounceCallback(setState, wait, leading)]
}
复制代码

useThrottle

useThrottle 用于稀释 setState 或者其它回调函数的执行频率。

官方文档：github.com/jaredLunde/…

代码示例：

import {useThrottle, useThrottleCallback} from '@react-hook/throttle'

const Component = (props) => {
  // at a basic level, used just like useState
  const [value, setValue] = useThrottle('initialValue')
}

const useMyCallback = (initialState, fps, leading) => {
  // this is the same code useThrottle() uses to throttle setState
  const [state, setState] = useState(initialState)
  return [state, useThrottleCallback(setState, fps, leading)]
}
复制代码

useOnlineStatus

useOnlineStatus 用于获取当前的网络状态，内部经过监听 online 及 offline 事件实现。

官方文档：github.com/rehooks/onl…

代码示例：

import useOnlineStatus from '@rehooks/online-status';

export default () => {
  const onlineStatus = useOnlineStatus();
  return (
    <div> <h1>You are {onlineStatus ? 'Online' : 'Offline'}</h1> </div>
  );
};
复制代码

useDocumentTitle

useDocumentTitle 用于更新页面标题。

官方文档：github.com/rehooks/doc…

代码示例：

import useDocumentTitle from '@rehooks/document-title';

export default () => {
  useDocumentTitle('Page Title');
  return <div />; }; 复制代码

useNetworkStatus

useNetworkStatus 暴露了navigator.connection 对象，用于实时获取网络状态。

官方文档：github.com/rehooks/net…

代码示例：

import useNetworkStatus from '@rehooks/network-status';

export default () => {
  let connection = useNetworkStatus();
  return (
    <div> <div>downlink: {connection.downlink}</div> <div>effectiveType: {connection.effectiveType}</div> <div>rtt: {connection.rtt}</div> <div>saveData: {connection.saveData ? 'yes' : 'no'}</div> </div>
  );
};
复制代码

useSpeechSynthesis

useSpeechSynthesis 经过使用 Web Speech API 提供了语音识别及文字转语音的能力，还能够识别中英文。

官方文档：www.npmjs.com/package/rea… 在线示例：mikeyparton.github.io/react-speec…

代码示例：

import { useSpeechSynthesis, useSpeechRecognition } from 'react-speech-kit';

export default () => {
  const [value, setValue] = useState('');
  const { speak } = useSpeechSynthesis();

  const { listen, listening, stop } = useSpeechRecognition({
    onResult: (result) => {
      setValue(result);
    },
  });

  return (
    <div> <textarea value={value} onChange={(event) => setValue(event.target.value)} /> <br /> <button onMouseDown={listen} onMouseUp={stop}> Listen </button> <button onClick={() => speak({ text: value })}>Speak</button> {listening && <div>Go ahead I'm listening</div>} </div> ); }; 复制代码

能够按住 Listen 按钮不放随便说一句话，它会自动识别录入到文本框里，而后再点击Speak 按钮，它会自动识别文本框中的内容并语音播放。