5 кастомных React хуков, которые улучшат ваш код

1. Хук useWindowSize - хук для получения размера экрана

Я уверен, что в некоторых проектах, над которыми вы работали, вам нужно было получить ширину и высоту окна пользователя. Так вот, теперь у вас есть хук для этого, так что вы можете сделать это еще проще, чем раньше.

import { useState, useEffect } from "react";

interface WindowSize {
  width: number;
  height: number;
}

const useWindowSize = (): WindowSize => {
  const [windowSize, setWindowSize] = useState<WindowSize>({
    width: window.innerWidth,
    height: window.innerHeight,
  });

  useEffect(() => {
    const handleResize = () => {
      setWindowSize({
        width: window.innerWidth,
        height: window.innerHeight,
      });
    };
    window.addEventListener("resize", handleResize);

    return () => {
      window.removeEventListener("resize", handleResize);
    };
  }, []);

  return windowSize;
};

Этот хук может быть особенно полезен при реализации отзывчивого дизайна, когда по какой-то причине вам нужно запустить определенный код при определенных размерах. Более продвинутый вариант этого хука можно найти в статье “Хук useResize для отслеживания ширины экрана в ReactJS”.

2️. Хук useKeyPress - хук для определения нажатия клавиши

Следующий хук позволяет определить, когда нажата определенная клавиша. Это может вызвать события или действия, основанные на нажатой клавише. Например, для закрытия модального окна, отправки формы и т.д.

import { useState, useEffect } from "react";

const useKeyPress = (targetKey: string): boolean => {
  const [keyPressed, setKeyPressed] = useState(false);

  const downHandler = ({ key }: KeyboardEvent) => {
    if (key === targetKey) {
      setKeyPressed(true);
    }
  };

  const upHandler = ({ key }: KeyboardEvent) => {
    if (key === targetKey) {
      setKeyPressed(false);
    }
  };

  useEffect(() => {
    window.addEventListener("keydown", downHandler);
    window.addEventListener("keyup", upHandler);

    return () => {
      window.removeEventListener("keydown", downHandler);
      window.removeEventListener("keyup", upHandler);
    };
  }, []);

  return keyPressed;
};

Пример использования:

const closeModalKeyPress = useKeyPress("Escape");

3. Хук useInterval - хук для вызова функции setInterval

Этот хук позволяет вам использовать функцию setInterval в качестве хука. Как и функция setInterval, этот хук имеет множество применений, например, анимация, обновление данных через регулярные промежутки времени или даже установка таймера.

import { useState, useEffect, useRef } from "react";

const useInterval = (callback: () => void, delay: number | null) => {
  const savedCallback = useRef<() => void>();

  useEffect(() => {
    savedCallback.current = callback;
  }, [callback]);

  useEffect(() => {
    function tick() {
      savedCallback.current && savedCallback.current();
    }
    if (delay !== null && delay > 0) {
      let id = setInterval(tick, delay);
      return () => clearInterval(id);
    } else {
      tick();
    }
  }, [delay]);
};

Можно использовать этот хук следующим образом:

const [count, setCount] = useState(0);

useInterval(() => {
  setCount(count + 1);
}, 1000);

4. Хук useDebounce

Теперь мы поговорим о хуке, который выполняет функцию только после того, как пройдет определенное количество времени без ее вызова. Это полезно, например, для ограничения скорости вызовов API или обновления состояния при изменении ввода, например, когда вы набираете текст в поисковой строке.

import { useEffect, useRef } from 'react';

export function useDebounce(callback:Function, timeout: number = 200, deps: Array<any> = []) {
  const data = useRef({ firstTime: true });
  useEffect(() => {
    const { firstTime, clearFunc } = data.current;

    const handler = setTimeout(() => {
      if (clearFunc && typeof clearFunc === 'function') {
        clearFunc();
      }
      data.current.clearFunc = callback();
    }, timeout);

    return () => {
      clearTimeout(handler);
    };
  }, [timeout, ...deps]);
}

export default useDebounce;

Пример использования:

const [inputValue, setInputValue] = useState("");

useDebounce(() => {
  // вызов APIl
}, 500);

5️. Хук useThrottle

Throttle означает, что функция будет выполняться один раз за каждый заданный промежуток времени. Это может быть полезно для предотвращения быстрого запуска слишком большого количества вызовов API или событий.

import { useEffect, useRef } from 'react';

export const useThrottle = (callback:Function, delay: number = 200, deps: Array<any> = []) => {
  const lastRan = useRef(Date.now());

  useEffect(
    () => {
      const handler = setTimeout(function() {
        if (Date.now() - lastRan.current >= delay) {
          callback();
          lastRan.current = Date.now();
        }
      }, delay - (Date.now() - lastRan.current));

      return () => {
        clearTimeout(handler);
      };
    },
    [delay, ...deps],
  );
};

export default useThrottle;

Пример:

const [inputValue, setInputValue] = useState("");

useThrottle(() => {
  // вызов API
}, 500);

Еще больше крутых хуков вы можете найти в каталоге хуков.

Содержание туториала по React Компонентам часто необходимо изменить то, что отображается на экране в результате взаимодействия. Ввод в форму должен обновить поле ввода, нажатие «Далее» на карусели изображений должно изменить отображаемое изображение, нажатие «купить» должно поместить продукт в корзину. Компоненты должны «запоминать» вещи: текущее входное значение, текущее изображение, корзину. В React такой тип памяти для конкретного компонента называется состоянием.

Когда обычной переменной недостаточно

Вот компонент, который рендерит изображение скульптуры. Нажатие кнопки «Далее» должно отобразить следующую скульптуру, изменив индекс на 1, затем на 2 и так далее. Однако это не сработает:

// App.jsx

import { sculptureList } from './data.js';

export default function Gallery() {
  let index = 0;

  function handleClick() {
    index = index + 1;
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <img src={sculpture.url} alt={sculpture.alt} />
      <p>{sculpture.description}</p>
    </>
  );
}

// data.js

export const sculptureList = [
  {
    name: 'Sculpture 1 Name',
    artist: 'Sculpture 1 Artist',
    description: 'Sculpture 1 Description',
    url: 'https://example.com/sculpture1.jpg',
    alt: 'Sculpture 1 Description',
  },
  {
    name: 'Sculpture 2 Name',
    artist: 'Sculpture 2 Artist',
    description: 'Sculpture 2 Description',
    url: 'https://example.com/sculpture2.jpg',
    alt: 'Sculpture 2 Description',
  },
];

Обработчик события handleClick обновляет локальную переменную index. Но две вещи препятствуют тому, чтобы это изменение было видимым:

1. Локальные переменные не сохраняются между рендерами. Когда React рендерит этот компонент во второй раз, он рендерит его с нуля — он не учитывает никаких изменений в локальных переменных.
2. Изменения локальных переменных не вызовут рендеринга. React не понимает, что ему нужно снова визуализировать компонент с новыми данными.

Чтобы обновить компонент новыми данными, должны произойти две вещи:

1. Данные между рендерами должны сохраняться.
2. Нужно заставить React отрендерить компонент с новыми данными (повторный рендеринг).

Хук useState предоставляет две вещи:

1. Переменную состояния для сохранения данных между рендерами.
2. Функцию установки состояния для обновления переменной и запуска React для повторного рендеринга компонента.

Добавление переменной состояния

Чтобы добавить переменную состояния, импортируйте useState из React в начало файла:

import { useState } from 'react';

Затем замените эту строку:

let index = 0;

на эту:

const [index, setIndex] = useState(0);

index — это переменная состояния, а setIndex — функция установки состояния. Синтаксис [ и ] называется деструктурированием массива и позволяет считывать значения из массива. Массив, возвращаемый useState, всегда содержит ровно два элемента. Вот как они работают вместе в handleClick:

function handleClick() {
  setIndex(index + 1);
}

Теперь нажатие кнопки «Далее» переключает текущее изображение:

// App.jsx

import { useState } from 'react';
import { sculptureList } from './data.js';

export default function Gallery() {
  const [index, setIndex] = useState(0);

  function handleClick() {
    setIndex(index + 1);
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <img src={sculpture.url} alt={sculpture.alt} />
      <p>{sculpture.description}</p>
    </>
  );
}

Встречайте свой первый хук

В React useState, как и любая другая функция, начинающаяся с «use», называется хуком. Хуки — это специальные функции, которые доступны только во время рендеринга React (о чем мы поговорим подробнее на следующей странице). Они позволяют вам «подключаться» к различным функциям React. Состояние — это только одна из этих функций, но позже вы познакомитесь с другими хуками. Хуки — функции, начинающиеся с use — могут вызываться только на верхнем уровне ваших компонентов или ваших собственных кастомных хуков. Вы не можете вызывать хуки внутри условий, циклов или других вложенных функций. Хуки — это функции, но полезно думать о них как о безусловных декларациях о потребностях вашего компонента. Вы используете (use) функции React в верхней части вашего компонента, подобно тому, как вы «импортируете» модули в верхней части вашего файла.

Как устроен useState?

Когда вы вызываете useState, вы сообщаете React, что хотите, чтобы этот компонент что-то запомнил:

const [index, setIndex] = useState(0);

В этом случае вы хотите, чтобы React запомнил index. По соглашению эта пара именуется как const [something, setSomething]. Вы можете назвать их как угодно, но соглашения облегчают понимание разных проектов. Единственный аргумент useState — это начальное значение вашей переменной состояния. В этом примере начальное значение индекса устанавливается равным 0 с помощью useState(0). Каждый раз, когда ваш компонент рендерится, useState предоставляет вам массив, содержащий два значения:

1. Переменная состояния (index) со значением, которое вы сохранили.
2. Функция установки состояния (setIndex), которая может обновлять переменную состояния и запускать React для повторного рендеринга компонента.

Вот как это происходит в действии:

const [index, setIndex] = useState(0);

1. Ваш компонент отображается в первый раз. Поскольку вы передали 0 в useState в качестве начального значения для index, он вернет [0, setIndex]. React помнит, что 0 — это последнее значение состояния.
2. Вы обновляете состояние. Когда пользователь нажимает кнопку, он вызывается setIndex(index + 1). index равен 0, поэтому это setIndex(1). Это говорит React запомнить, что index теперь равен 1, и запускается другой рендеринг.
3. Второй рендер вашего компонента. React по-прежнему видит useState(0), но поскольку React запомнил, что вы установили index равным 1, вместо этого он возвращает [1, setIndex].

И т.д.

Несколько переменных состояния в компоненте

В одном компоненте вы можете иметь столько переменных состояния любого типа, сколько захотите. Этот компонент имеет две переменные состояния, числовой index и логическое значение showMore, которое переключается, когда вы нажимаете "Show details":

import { useState } from 'react';
import { sculptureList } from './data.js';

export default function Gallery() {
  const [index, setIndex] = useState(0);
  const [showMore, setShowMore] = useState(false);

  function handleNextClick() {
    setIndex(index + 1);
  }

  function handleMoreClick() {
    setShowMore(!showMore);
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleNextClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <button onClick={handleMoreClick}>
        {showMore ? 'Hide' : 'Show'} details
      </button>
      {showMore && <p>{sculpture.description}</p>}
      <img src={sculpture.url} alt={sculpture.alt} />
    </>
  );
}

Рекомендуется иметь несколько переменных состояния, если их состояние не связано, например index и showMore в этом примере. Но если вы обнаружите, что часто меняете две переменные состояния вместе, может быть лучше объединить их в одну. Например, если у вас есть форма с множеством полей, удобнее иметь одну переменную состояния, которая содержит объект, чем переменную состояния для каждого поля. В руководстве "Какую структуру состояния выбрать" содержится больше советов по этому вопросу.

Как React узнает, какое состояние вернуть?

Вы могли заметить, что вызов useState не получает никакой информации о том, на какую переменную состояния он ссылается. В useState не передается «идентификатор», так как же он узнает, какую из переменных состояния следует вернуть? Чтобы обеспечить лаконичный синтаксис, хуки полагаются на стабильный порядок вызовов при каждом рендеринге одного и того же компонента. Это хорошо работает на практике, потому что если вы будете следовать правилу выше («вызывать хуки только на верхнем уровне»), хуки всегда будут вызываться в одном и том же порядке. Кроме того, linter плагин отлавливает большинство ошибок. Внутри React хранит массив пар состояний для каждого компонента. Он также поддерживает индекс для текущуй пары, который перед рендерингом устанавливается в 0. Каждый раз, когда вы вызываете useState, React предоставляет вам следующую пару состояний и увеличивает индекс.

В следующем примере не используется React, но он дает представление о внутренней работе useState:

let componentHooks = [];
let currentHookIndex = 0;

// Как useState работает внутри React (упрощенно).
function useState(initialState) {
  let pair = componentHooks[currentHookIndex];
  if (pair) {
    // Это не первый рендер,
    // поэтому пара состояний уже существует.
    // Верните его и приготовьтесь к следующему хуку.
    currentHookIndex++;
    return pair;
  }

  // Это первый рендеринг,
  // поэтому создаем пару состояния и сохраняем ее.
  pair = [initialState, setState];

  function setState(nextState) {
    // Когда пользователь запрашивает изменение состояния,
    // помещаем новое значение в пару.
    pair[0] = nextState;
    updateDOM();
  }

  // Сохраняем пару для будущих рендеров
  // и подготовимся к следующему вызову хука.
  componentHooks[currentHookIndex] = pair;
  currentHookIndex++;
  return pair;
}

function Gallery() {
  // Каждый вызов useState() будет получать следующую пару.
  const [index, setIndex] = useState(0);
  const [showMore, setShowMore] = useState(false);

  function handleNextClick() {
    setIndex(index + 1);
  }

  function handleMoreClick() {
    setShowMore(!showMore);
  }

  let sculpture = sculptureList[index];
  // В этом примере не используется React,
  //поэтому вернем объект вместо JSX.
  return {
    onNextClick: handleNextClick,
    onMoreClick: handleMoreClick,
    header: `${sculpture.name} by ${sculpture.artist}`,
    counter: `${index + 1} of ${sculptureList.length}`,
    more: `${showMore ? 'Hide' : 'Show'} details`,
    description: showMore ? sculpture.description : null,
    imageSrc: sculpture.url,
    imageAlt: sculpture.alt,
  };
}

function updateDOM() {
  // Сбросить текущий индекс хука
  // перед рендерингом компонента.
  currentHookIndex = 0;
  let output = Gallery();

  // Обновить DOM, чтобы он соответствовал выходным данным.
  // Это та часть, которую React делает за вас.
  nextButton.onclick = output.onNextClick;
  header.textContent = output.header;
  moreButton.onclick = output.onMoreClick;
  moreButton.textContent = output.more;
  image.src = output.imageSrc;
  image.alt = output.imageAlt;
  if (output.description !== null) {
    description.textContent = output.description;
    description.style.display = '';
  } else {
    description.style.display = 'none';
  }
}

let nextButton = document.getElementById('nextButton');
let header = document.getElementById('header');
let moreButton = document.getElementById('moreButton');
let description = document.getElementById('description');
let image = document.getElementById('image');
let sculptureList = [
  {
    name: 'Sculpture 1 Name',
    artist: 'Sculpture 1 Artist',
    description: 'Sculpture 1 Description',
    url: 'https://example.com/sculpture1.jpg',
    alt: 'Sculpture 1 Description',
  },
  {
    name: 'Sculpture 2 Name',
    artist: 'Sculpture 2 Artist',
    description: 'Sculpture 2 Description',
    url: 'https://example.com/sculpture2.jpg',
    alt: 'Sculpture 2 Description',
  },
];

// Сделать интерфейс соответствующим начальному состоянию.
updateDOM();

Вам не нужно понимать это, чтобы использовать React, но вы можете найти полезную ментальную модель.

Состояние изолировано и приватно

Состояние является локальным для экземпляра компонента на экране. Другими словами, если вы рендерите один и тот же компонент дважды, каждая копия будет иметь полностью изолированное состояние. Изменение одного из них не повлияет на другой. В этом примере ранее компонент Gallery визуализируется дважды без каких-либо изменений в его логике.

import Gallery from './Gallery.js';

export default function Page() {
  return (
    <div className="Page">
      <Gallery />
      <Gallery />
    </div>
  );
}

Это то, что отличает состояние от обычных переменных, которые вы можете объявить в верхней части вашего модуля. Состояние не привязано к конкретному вызову функции или месту в коде, но оно «локально» для определенного места на экране. Мы отрендерили два компонента <Gallery />, поэтому их состояние сохраняется отдельно.

Также обратите внимание на то, что компонент Page ничего не «знает» о состоянии Gallery и даже о том, есть ли оно у него. В отличие от пропсов, состояние полностью приватно для компонента, объявляющего его. Родительский компонент не может его изменить. Это позволяет добавлять состояние к любому компоненту или удалять его, не затрагивая остальные компоненты. Что, если вы хотите, чтобы обе галереи синхронизировали свои состояния? Правильный способ сделать это в React — удалить состояние из дочерних компонентов и добавить его к их ближайшему общему родителю. Следующие несколько частей будут посвящены организации состояния одного компонента, но мы вернемся к этой теме в разделе "Обмен данными между компонентами".

Резюме

• Используйте переменную состояния, когда компоненту необходимо «запомнить» некоторую информацию между рендерами.
• Переменные состояния объявляются путем вызова хука useState.
• Хуки — это специальные функции, которые начинаются с use. Они позволяют вам «подключаться» к возможностям React, таким как состояние.
• Вызов хуков, включая useState, действителен только на верхнем уровне компонента или другого хука.
• Хук useState возвращает пару значений: текущее состояние и функцию для его обновления.
• Вы можете иметь более одной переменной состояния. Внутри React сопоставляет их по порядку.
• Состояние является приватным для компонента. Если вы рендерите его в двух местах, каждая копия получает свое состояние.