Клавиша / esc

Выразительный React: интерактивность на клиенте

Создаём интерактивные компоненты на React.

Время чтения: больше 15 мин

В статье описан один из стандартных подходов к созданию React-приложения.

Эта статья — продолжение серии «Выразительный React». В предыдущей статье «Выразительный React: простые компоненты на сервере» была показана техника SSR (Server-Side Rendering). В ней разбирались определения, которые пригодятся при чтении этой статьи.

Собираем требования

Скопировано

Даже очень маленький проект лучше всего начинать со сбора функциональных требований. Часто требования изменяются со временем. Главное, чтобы всем, кто занимается проектом, были известны текущие требования.

В предыдущей статье мы создали прямоугольник с собачкой. Кажется собачке скучно просто сидеть в прямоугольнике. Чтобы собачке стало веселее, давайте выдадим ей мячик и сложное задание 🙂

В результате получатся следующие требования:

  1. В прямоугольнике находятся собачка и мячик. Размер прямоугольника — 20 на 20 попугаев.
  2. Собачка находится в левом верхнем углу прямоугольника, а мячик — в левом нижнем.
  3. Пользователь может добавлять и убирать горизонтальные стенки случайного размера, чтобы получился лабиринт. Размер стенки — от 1 до 19 попугаев. Это нужно для того, чтобы игра была честной, и собачка всегда могла добраться до мячика.
  4. Собачка может двигаться только вниз, влево и вправо.
  5. Когда лабиринт готов, собачка бежит за мячиком.
  6. Можно сбросить состояние лабиринта и начать всё заново.

Обратите внимание, что эти требования достаточно расплывчаты. Нигде не описано, что значит «собачка бежит за мячиком», или как определить, что «лабиринт готов». Это типичный пример работы над проектом. Требования — это лишь ограничения вашей системы, а команде инженеров предстоит решить как их реализовать.

Первоначальная настройка

Скопировано

Если вы прочитали предыдущую статью, у вас уже установлен Node.js и вы знаете, что делать на Windows. Если нет, установите его.

Здесь и далее предполагаем, что вы используете macOS, Linux или Windows с WSL.

React-приложение нуждается в сборке. Сборщиков очень много, будем использовать Vite с React и TypeScript.

Создайте проект несколькими командами:

        
          
          npm create vite@latest expressive-react-maze -- --template react-ts -ycd expressive-react-mazenpm installnpm run dev
          npm create vite@latest expressive-react-maze -- --template react-ts -y
cd expressive-react-maze
npm install
npm run dev

        
        
          
        
      

У Vite есть несколько шаблонов. Флаг -template react-ts выбирает шаблон с React и TypeScript, а флаг -y говорит, что вы согласны на всё, что предлагает Vite.

После установки зависимостей Vite запустит dev-сервер и напечатает в консоли адрес приложения. Откройте его в браузере и полюбуйтесь на логотип Vite и React.

Копируем

Скопировано

Перенесём наработки из предыдущей статьи в новый проект. Создадим файл src/Rectangle.tsx и добавим в него следующий код:

        
          
          export const Rectangle = () => <div style={{ border: '1px solid brown' }}>🐶</div>;
          export const Rectangle = () => <div style={{ border: '1px solid brown' }}>🐶</div>;

        
        
          
        
      

Отобразим компонент, для этого отредактируем файл src/App.tsx:

        
          
          import { Rectangle } from './Rectangle';const App = () => (  <div>    <h1>Собачка и мячик</h1>    <Rectangle />  </div>);export default App;
          import { Rectangle } from './Rectangle';

const App = () => (
  <div>
    <h1>Собачка и мячик</h1>
    <Rectangle />
  </div>
);

export default App;

        
        
          
        
      

Также удалим всё содержимое файлов src/App.css и src/index.css. У нас будет свой стиль!

Создаём нужные компоненты

Скопировано

Сейчас прямоугольник — это один большой компонент. Выполним рефакторинг и выделим из компонента Rectangle три новых компонента:

  • Dog — собачка;
  • Ball — мячик;
  • Maze — лабиринт.

Создадим файлы src/Dog.tsx, src/Ball.tsx и src/Maze.tsx и добавим в них следующий код:

        
          
          // Dog.tsxexport const Dog = () => <div>🐶</div>;
          // Dog.tsx
export const Dog = () => <div>🐶</div>;

        
        
          
        
      
        
          
          // Ball.tsxexport const Ball = () => <div>🎾</div>;
          // Ball.tsx
export const Ball = () => <div>🎾</div>;

        
        
          
        
      
        
          
          // Maze.tsxexport const Maze = () => <div>Тут будет лабиринт</div>;
          // Maze.tsx
export const Maze = () => <div>Тут будет лабиринт</div>;

        
        
          
        
      

Добавляем компоненты в прямоугольник

Скопировано

Компонент Rectangle будет служить контейнером для мячика, собачки и лабиринта. Чтобы этого добиться, нужно добавить в файл src/Rectangle.tsx свойство children. Это встроенное свойство любого React-компонента, с его помощью можно определить как будут отображаться вложенные компоненты.

        
          
          import { ReactNode } from 'react'type Props = {  children: ReactNode}export const Rectangle = ({ children }: Props) => (  <div style={{ border: '1px solid brown' }}>{children}</div>)
          import { ReactNode } from 'react'

type Props = {
  children: ReactNode
}

export const Rectangle = ({ children }: Props) => (
  <div style={{ border: '1px solid brown' }}>{children}</div>
)

        
        
          
        
      

ReactNode — это тип, означающий «всё, что может отрендерить React».

Типизировать React-компоненты очень просто. Достаточно описать аргументы функции-компонента.

Особенности передачи компонента

Вы можете передать компонент в качестве любого другого свойства. Например, вот так:

        
          
          <Rectangle dog={<Dog/>} maze={Maze} />
          <Rectangle dog={<Dog/>} maze={Maze} />

        
        
          
        
      

При этом код компонента Rectangle может выглядеть так:

        
          
          type Props = {  dog: ReactNode  maze: ReactNode}export const Rectangle = ({ dog, maze }: Props) => (  <div style={{ border: '1px solid brown' }}>    {dog}    {maze}  </div>)
          type Props = {
  dog: ReactNode
  maze: ReactNode
}

export const Rectangle = ({ dog, maze }: Props) => (
  <div style={{ border: '1px solid brown' }}>
    {dog}
    {maze}
  </div>
)

        
        
          
        
      

Теперь обновим src/App.tsx, чтобы собрать все компоненты вместе:

        
          
          import { Ball } from './Ball';import { Dog } from './Dog';import { Maze } from './Maze';import { Rectangle } from './Rectangle';const App = () => (  <div>    <h1>Собачка и мячик</h1>    <Rectangle>      <Dog />      <Ball />      <Maze />    </Rectangle>  </div>);export default App;
          import { Ball } from './Ball';
import { Dog } from './Dog';
import { Maze } from './Maze';
import { Rectangle } from './Rectangle';

const App = () => (
  <div>
    <h1>Собачка и мячик</h1>
    <Rectangle>
      <Dog />
      <Ball />
      <Maze />
    </Rectangle>
  </div>
);

export default App;

        
        
          
        
      

Строим лабиринт

Скопировано

Лабиринт — самый сложный компонент из всех. Чтобы разобраться в лабиринте, потребуется решить вопрос с «🦜». Попугаи используются для задания размера перегородок лабиринта и для задания размера поля.

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

Мы создадим простую функцию-конвертер попугаев в пиксели и обратно.

        
          
          // src/units.tsconst pixelsInParrot = 20;export const parrotsToPixels = (parrots: number) => parrots * pixelsInParrot;
          // src/units.ts
const pixelsInParrot = 20;
export const parrotsToPixels = (parrots: number) => parrots * pixelsInParrot;

        
        
          
        
      

Кроме этого, полезно завести файлик с константами. В больших проектах этот файлик быстро разрастётся и превратится в папку.

        
          
          // src/constants.tsexport const fieldSize = 20;export const maxWallLength = 20;export const minWallLength = 5;
          // src/constants.ts
export const fieldSize = 20;
export const maxWallLength = 20;
export const minWallLength = 5;

        
        
          
        
      

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

        
          
          import { fieldSize } from './constants'import { parrotsToPixels } from './units'import styles from './Maze.module.css'export const Maze = () => {  const size = parrotsToPixels(fieldSize)  return (    <div      style={{        width: size,        height: size,      }}      className={styles.maze}    >      {Array.from({ length: fieldSize }, (_, i) => (        <button          key={i}          style={{ height: parrotsToPixels(1) }}          className={styles.button}        >          {/* Тут может быть стенка */}        </button>      ))}    </div>  )}
          import { fieldSize } from './constants'
import { parrotsToPixels } from './units'
import styles from './Maze.module.css'

export const Maze = () => {
  const size = parrotsToPixels(fieldSize)

  return (
    <div
      style={{
        width: size,
        height: size,
      }}
      className={styles.maze}
    >
      {Array.from({ length: fieldSize }, (_, i) => (
        <button
          key={i}
          style={{ height: parrotsToPixels(1) }}
          className={styles.button}
        >
          {/* Тут может быть стенка */}
        </button>
      ))}
    </div>
  )
}

        
        
          
        
      
        
          
          /* src/Maze.module.css */.maze {  border: 1px solid brown;  display: flex;  flex-direction: column;}.button {  background-color: transparent;  border: none;  cursor: pointer;  width: 100%;  display: flex;  align-items: center;  position: relative;  margin: 0;  padding: 0;  &:hover {    background-color: #f0f0f0;  }}.wall {  background-color: black;  height: 2px;  position: relative;}
          /* src/Maze.module.css */
.maze {
  border: 1px solid brown;
  display: flex;
  flex-direction: column;
}

.button {
  background-color: transparent;
  border: none;
  cursor: pointer;
  width: 100%;
  display: flex;
  align-items: center;
  position: relative;
  margin: 0;
  padding: 0;

  &:hover {
    background-color: #f0f0f0;
  }
}

.wall {
  background-color: black;
  height: 2px;
  position: relative;
}

        
        
          
        
      

Обратите внимание, как добавляются стили. Мы описываем стили в файле Maze.module.css и импортируем их в компонент. Файл стилей можно называть как угодно. Важно, чтобы он заканчивался на .module.css. Когда Vite видит такое окончание файла, он будет добавлять к каждому классу уникальный префикс. Префикс поможет избежать пересечения стилей. Можно использовать одинаковые названия классов в разных файлах стилей. Стили для каждого из классов не будут смешиваться.

Чтобы зафиксировать размер кнопок и лабиринта, мы передаём размер поля в специальный атрибут style. В React можно передавать стили в виде объекта, где ключи — это CSS-свойства, а значения — их значения 🤷‍♀️. В данном случае мы устанавливаем ширину и высоту лабиринта равными 20 попугаям. У такой передачи есть несколько особенностей:

  1. Можно передавать значения размеров числом, в пикселях. Стиль автоматически преобразуется в строку.
  2. Названия стилей соответствуют JavaScript-названиям стилей. Как если бы вы устанавливали стили через свойство style.

Генерируем массив кнопок, используя функцию Array.from. В JSX можно использовать массив вместо единственного элемента в качестве параметра children, если вы не переопределили это поведение у вашего компонента. Обратите внимание на свойство key. Это очень важное свойство. Оно должно быть уникальным для каждого элемента.

Стенки лабиринта будут добавляться при клике на соответствующую часть лабиринта (не просто так мы сделали её кнопкой). Чтобы добиться этого результата, нужно познакомиться с ещё с одним концептом – хуком useState.

Состояние компонента

Скопировано

Хук useState позволяет определить переменную-состояние и даёт функцию для изменения этого состояния. React гарантирует, что после изменения состояния компонент перерендерится, но не гарантирует, что это произойдёт мгновенно.

Будем хранить в переменной состояния все стены лабиринта. При клике на соответствующую часть лабиринта будем добавлять случайную стенку, такую, чтобы собачка могла добраться до мячика.

Попробуйте разобраться что происходит в примере кода ниже. Если чуть-чуть получится – отлично, если нет – это нормально. К React надо привыкнуть 🙂 Чуть ниже будет подробное объяснение.

        
          
          import { fieldSize, maxWallLength, minWallLength } from './constants'import { parrotsToPixels } from './units'import { useCallback, useState } from 'react'import styles from './Maze.module.css'type Wall = {  left: number  width: number}const randomInt = (minVal: number, maxVal: number) =>  Math.floor(Math.random() * (maxVal - minVal + 1)) + minValconst generateNewWall = (): Wall => {  const width = randomInt(minWallLength, maxWallLength)  const alignLeft = Math.random() > 0.5  return {    left: alignLeft ? 0 : fieldSize - width,    width,  }}export const Maze = () => {  const size = parrotsToPixels(fieldSize)  const [walls, setWalls] = useState<Wall[]>(    () => Array.from({ length: fieldSize }, () => ({      left: 0,      width: 0,    })),  )  const toggleWall = useCallback((mazeRow: number) => {    setWalls((walls) =>      walls.map((wall, i) => {        if (i === mazeRow) {          if (wall.width === 0) {            return generateNewWall()          } else {            return {              left: 0,              width: 0,            }          }        }        return wall      }),    )  }, [])  return (    <div      style={{        width: size,        height: size,      }}      className={styles.maze}    >      {Array.from({ length: fieldSize }, (_, i) => (        <button          key={i}          style={{ height: parrotsToPixels(1) }}          className={styles.button}          onClick={() => toggleWall(i)}        >          <span            key={`${i}`}            className={styles.wall}            style={{              width: parrotsToPixels(walls[i].width),              left: parrotsToPixels(walls[i].left),            }}          />        </button>      ))}    </div>  )}
          import { fieldSize, maxWallLength, minWallLength } from './constants'
import { parrotsToPixels } from './units'
import { useCallback, useState } from 'react'
import styles from './Maze.module.css'

type Wall = {
  left: number
  width: number
}

const randomInt = (minVal: number, maxVal: number) =>
  Math.floor(Math.random() * (maxVal - minVal + 1)) + minVal

const generateNewWall = (): Wall => {
  const width = randomInt(minWallLength, maxWallLength)
  const alignLeft = Math.random() > 0.5

  return {
    left: alignLeft ? 0 : fieldSize - width,
    width,
  }
}

export const Maze = () => {
  const size = parrotsToPixels(fieldSize)
  const [walls, setWalls] = useState<Wall[]>(
    () => Array.from({ length: fieldSize }, () => ({
      left: 0,
      width: 0,
    })),
  )

  const toggleWall = useCallback((mazeRow: number) => {
    setWalls((walls) =>
      walls.map((wall, i) => {
        if (i === mazeRow) {
          if (wall.width === 0) {
            return generateNewWall()
          } else {
            return {
              left: 0,
              width: 0,
            }
          }
        }
        return wall
      }),
    )
  }, [])

  return (
    <div
      style={{
        width: size,
        height: size,
      }}
      className={styles.maze}
    >
      {Array.from({ length: fieldSize }, (_, i) => (
        <button
          key={i}
          style={{ height: parrotsToPixels(1) }}
          className={styles.button}
          onClick={() => toggleWall(i)}
        >
          <span
            key={`${i}`}
            className={styles.wall}
            style={{
              width: parrotsToPixels(walls[i].width),
              left: parrotsToPixels(walls[i].left),
            }}
          />
        </button>
      ))}
    </div>
  )
}

        
        
          
        
      

Часто бывает полезно сначала представить решение задачи и только потом его реализовывать. TypeScript отлично помогает зафиксировать подобное представление. Если вы заранее опишите примитивы с которыми будете работать, вам будет легче разработать реализацию.

В этом примере создаётся тип Wall для хранения структуры стенки. Она будет задаваться двумя параметрами – отступом от левого края лабиринта и его длинной.

Далее создаём несколько вспомогательных функций для генерации случайной стенки таким образом, чтобы собачка всегда могла пройти. Принимаем решение выравнивать стенку всегда либо по левому краю, либо по правому. Если стенка выравнивается по левому краю, то отступ от левого края будет равен нулю.

Далее используем сочетание хуков useState и useCallback. useCallback позволяет зафиксировать функцию-обработчик, привязанную к переменной toggleWall. Значение этой переменной не будет меняться при перерисовке компонента. За это отвечает второй аргумент функции. Вторым аргументом является массив зависимостей. Если зависимостей нет (передан пустой массив), то значение переменной не будет меняться при перерисовке компонента.

Теперь подробнее взглянем на установщик состояния setWalls. Есть два способа использовать эту функцию: передавать в качестве аргумента новое состояние (так делать не будем) или передавать функцию, принимающую текущее состояние и возвращающую новое, которое будет установлено в качестве текущего.

        
          
          setWalls((walls) =>  walls.map((wall, i) => {    if (i === mazeRow) {      if (wall.width === 0) {        return generateNewWall()      } else {        return {          left: 0,          width: 0,        }      }    }    return wall  }),)
          setWalls((walls) =>
  walls.map((wall, i) => {
    if (i === mazeRow) {
      if (wall.width === 0) {
        return generateNewWall()
      } else {
        return {
          left: 0,
          width: 0,
        }
      }
    }
    return wall
  }),
)

        
        
          
        
      

Здесь изменяем только ту часть лабиринта, на которую кликнул пользователь. Если в области клика стенки нет, то добавляем новую стенку. Если стенка есть, то удаляем её.

Лабиринт готов! Пора запустить собачку.

Запускаем собачку?

Скопировано

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

  1. Переместить собачку внутрь лабиринта.
  2. Вытащить состояние из лабиринта в родительский компонент и передавать это состояние как свойство собачке и лабиринту.
  3. Использовать контекст, чтобы сделать состояние доступным для всех компонентов.

Первый способ не самый изящный, но позволит добиться результата быстро. В следующих статьях рассмотрим другие варианты.

Убираем собачку из Rectangle, для этого изменяем файл src/App.tsx:

        
          
          // App.tsximport { Ball } from './Ball';import { Maze } from './Maze';import { Rectangle } from './Rectangle';const App = () => (  <div>    <h1>Собачка и мячик</h1>    <Rectangle>      {/* Тут была собачка, но она ушла в лабиринт */}      <Maze />      <Ball />    </Rectangle>  </div>);export default App;
          // App.tsx
import { Ball } from './Ball';
import { Maze } from './Maze';
import { Rectangle } from './Rectangle';

const App = () => (
  <div>
    <h1>Собачка и мячик</h1>
    <Rectangle>
      {/* Тут была собачка, но она ушла в лабиринт */}
      <Maze />
      <Ball />
    </Rectangle>
  </div>
);

export default App;

        
        
          
        
      

И добавляем собачку в Maze:

        
          
          // Maze.tsximport { Dog } from './Dog';//...<>  <Dog /> {/* 🐶 */}  <div    style={{      width: size,      height: size,    }}    className={styles.maze}  >    {/* Реализация лабиринта */}  </div></>
          // Maze.tsx
import { Dog } from './Dog';
//...
<>
  <Dog /> {/* 🐶 */}
  <div
    style={{
      width: size,
      height: size,
    }}
    className={styles.maze}
  >
    {/* Реализация лабиринта */}
  </div>
</>

        
        
          
        
      

Мы добавили собачку и завернули все элементы во фрагмент. Фрагмент не генерирует DOM-элемент, это удобный способ объединить несколько элементов в один.

Ссылаемся на собачку

Скопировано

Добавим кнопку запуска собачки. Вы уже знаете как добавлять новые компоненты. Добавим кнопку и обработчик клика в компонент Maze.

        
          
          // Maze.tsxconst getBall = useCallback(() => {  console.log('Гав!')}, [])// Все остальные функции<>  <button onClick={getBall}>Апорт!</button>  <Dog />  {/* 🐶 */}  {/* Остальной код */}</>
          // Maze.tsx

const getBall = useCallback(() => {
  console.log('Гав!')
}, [])

// Все остальные функции
<>
  <button onClick={getBall}>Апорт!</button>
  <Dog />  {/* 🐶 */}
  {/* Остальной код */}
</>

        
        
          
        
      

Кажется, что собака пока не готова бежать за мячиком. Исправим ситуацию, немного изменив обработчик getBall. Для этого воспользуемся JavaScript-анимацией. Это DOM API, чтобы им воспользоваться, нам нужно получить доступ к DOM-элементу собачки. Тут нам пригодится хук useRef. Этот хук можно использовать для множества вещей: хранить глобальное состояние или ссылаться на DOM-элементы. Глобальное состояние нужно, когда мы хотим отвязать состояние какого-то объекта от цикла перерисовки.

Сначала научим собачку работать со ссылками. Это можно сделать при помощи функции-обёртки forwardRef, которая позволяет передать внешнюю ссылку внутрь компонента.

        
          
          // Dog.tsximport { forwardRef } from 'react';export const Dog =forwardRef<HTMLDivElement>((_, ref) => <div ref={ref}>🐶</div>);
          // Dog.tsx
import { forwardRef } from 'react';

export const Dog =forwardRef<HTMLDivElement>((_, ref) => <div ref={ref}>🐶</div>);

        
        
          
        
      

Внутри компонента воспользуемся хуком useRef, чтобы получить доступ к DOM-элементу собачки в обработчике getBall.

        
          
          // Maze.tsximport { useCallback, useState, useRef } from 'react'// Все остальные функцииexport const Maze = () => {  const dogRef = useRef<HTMLDivElement>(null)  // Все остальные функции  <>    <button onClick={getBall}>Апорт!</button>    <Dog ref={dogRef} />    {/* Остальной код */}  </>}
          // Maze.tsx
import { useCallback, useState, useRef } from 'react'

// Все остальные функции

export const Maze = () => {
  const dogRef = useRef<HTMLDivElement>(null)

  // Все остальные функции
  <>
    <button onClick={getBall}>Апорт!</button>
    <Dog ref={dogRef} />
    {/* Остальной код */}
  </>
}

        
        
          
        
      

Пишем вспомогательные функции

Скопировано

Самое трудное позади. Осталось написать несколько функций-утилит для запуска собачки. Как и прежде мы будем использовать TypeScript, чтобы спроектировать наши функции.

        
          
          type Point = {  x: number  y: number}const generatePathAroundWalls = (  walls: Wall[],  start: Point,  end: Point,): Point[] => {  const path = [start]  const reversedWalls = walls.slice().reverse()  let currentY = start.y  path.push({ ...start })  while (reversedWalls.length) {    const wall = reversedWalls.pop() as Wall    currentY++    if (wall.width === 0) {      continue    }    if (wall.left === 0) {      path.push({ x: wall.width + 0.5, y: currentY })    } else {      path.push({ x: 0, y: currentY })    }  }  path.push(end)  return path}// Для анимацииconst generateKeyframes = (path: Point[]) =>  path.map(({ x, y }) => ({    transform: `translate(${parrotsToPixels(x)}px, ${parrotsToPixels(y)}px)`,  }))
          type Point = {
  x: number
  y: number
}

const generatePathAroundWalls = (
  walls: Wall[],
  start: Point,
  end: Point,
): Point[] => {
  const path = [start]
  const reversedWalls = walls.slice().reverse()
  let currentY = start.y
  path.push({ ...start })

  while (reversedWalls.length) {
    const wall = reversedWalls.pop() as Wall
    currentY++

    if (wall.width === 0) {
      continue
    }

    if (wall.left === 0) {
      path.push({ x: wall.width + 0.5, y: currentY })
    } else {
      path.push({ x: 0, y: currentY })
    }
  }

  path.push(end)
  return path
}

// Для анимации
const generateKeyframes = (path: Point[]) =>
  path.map(({ x, y }) => ({
    transform: `translate(${parrotsToPixels(x)}px, ${parrotsToPixels(y)}px)`,
  })
)

        
        
          
        
      

Был создан новый тип Point для хранения координат. Функция generatePathAroundWalls сгенерирует путь, чтобы собачка облетала стенки, а не врезалась в них.

Функция generateKeyframes преобразует путь в массив объектов, которые можно передать в CSS-анимацию. transform: это CSS-строка, которая задаёт текущие стили элемента. Мы используем трансформацию translate, чтобы переместить собачку в нужное место.

Запускаем собачку

Скопировано

Для запуска собачки нам нужно обновить колбэк getBall:

        
          
          // Maze.tsxconst getBall = useCallback(() => {  const start = { x: 0, y: 0 } // 🐶  const end = { x: 0, y: fieldSize + 1 } // 🎾  const path = generatePathAroundWalls(walls, start, end)  dogRef.current?.animate(generateKeyframes(path), {    duration: 3000,    easing: 'linear',    fill: 'forwards',  })}, [walls])
          // Maze.tsx
const getBall = useCallback(() => {
  const start = { x: 0, y: 0 } // 🐶

  const end = { x: 0, y: fieldSize + 1 } // 🎾

  const path = generatePathAroundWalls(walls, start, end)
  dogRef.current?.animate(generateKeyframes(path), {
    duration: 3000,
    easing: 'linear',
    fill: 'forwards',
  })
}, [walls])

        
        
          
        
      

Два момента, на которые стоит обратить внимание:

  1. Зависимость walls в массиве зависимостей хука useCallback. Нужно обновлять функцию-колбэк при добавлении или удалении стенок.
  2. Метод animate. Передаём в него keyframes и объект с настройками анимации. В настройках указываем продолжительность анимации, функцию сглаживания и что делать с элементом после анимации.

Ключевое слово forwards означает, что элемент останется в последнем состоянии анимации, собачка от мячика не убежит.

Попробуйте сами.

Посмотрите на лабиринт

Скопировано

Посмотрите на код компонента Maze, подумайте что с ним не так.

        
          
          import { fieldSize, maxWallLength, minWallLength } from './constants'import { parrotsToPixels } from './units'import { useCallback, useState, useRef } from 'react'import styles from './Maze.module.css'import { Dog } from './Dog'type Wall = {  left: number  width: number}const randomInt = (minVal: number, maxVal: number) =>  Math.floor(Math.random() * (maxVal - minVal + 1)) + minValconst generateNewWall = (): Wall => {  const width = randomInt(minWallLength, maxWallLength)  const alignLeft = Math.random() > 0.5  return {    left: alignLeft ? 0 : fieldSize - width,    width,  }}type Point = {  x: number  y: number}const generatePathAroundWalls = (  walls: Wall[],  start: Point,  end: Point,): Point[] => {  const path = [start]  const reversedWalls = walls.toReversed()  let currentY = start.y  path.push({ ...start })  while (reversedWalls.length) {    const wall = reversedWalls.pop() as Wall    currentY++    if (wall.width === 0) {      continue    }    if (wall.left === 0) {      path.push({ x: wall.width + 0.5, y: currentY })    } else {      path.push({ x: 0, y: currentY })    }  }  path.push(end)  return path}const generateKeyframes = (path: Point[]) =>  path.map(({ x, y }) => ({    transform: `translate(${parrotsToPixels(x)}px, ${parrotsToPixels(y)}px)`,  }))export const Maze = () => {  const size = parrotsToPixels(fieldSize)  const [walls, setWalls] = useState<Wall[]>(() =>    Array.from({ length: fieldSize }, () => ({      left: 0,      width: 0,    })),  )  const dogRef = useRef<HTMLDivElement | null>(null)  const toggleWall = useCallback((mazeRow: number) => {    setWalls((walls) =>      walls.map((wall, i) => {        if (i === mazeRow) {          if (wall.width === 0) {            return generateNewWall()          } else {            return {              left: 0,              width: 0,            }          }        }        return wall      }),    )  }, [])  const getBall = useCallback(() => {    const start = { x: 0, y: 0 } // 🐶    const end = { x: 0, y: fieldSize + 1 } // 🎾    const path = generatePathAroundWalls(walls, start, end)    dogRef.current?.animate(generateKeyframes(path), {      duration: 3000,      easing: 'linear',      fill: 'forwards',    })  }, [walls])  return (    <>      <button onClick={getBall}>Апорт!</button>      <Dog ref={dogRef} />      {/* 🐶 */}      <div        style={{          width: size,          height: size,        }}        className={styles.maze}      >        {Array.from({ length: fieldSize }, (_, i) => (          <button            key={i}            style={{ height: parrotsToPixels(1) }}            className={styles.button}            onClick={() => toggleWall(i)}          >            <span              className={styles.wall}              style={{                width: parrotsToPixels(walls[i].width),                left: parrotsToPixels(walls[i].left),              }}            />          </button>        ))}      </div>    </>  )}
          import { fieldSize, maxWallLength, minWallLength } from './constants'
import { parrotsToPixels } from './units'
import { useCallback, useState, useRef } from 'react'
import styles from './Maze.module.css'
import { Dog } from './Dog'

type Wall = {
  left: number
  width: number
}

const randomInt = (minVal: number, maxVal: number) =>
  Math.floor(Math.random() * (maxVal - minVal + 1)) + minVal

const generateNewWall = (): Wall => {
  const width = randomInt(minWallLength, maxWallLength)
  const alignLeft = Math.random() > 0.5

  return {
    left: alignLeft ? 0 : fieldSize - width,
    width,
  }
}

type Point = {
  x: number
  y: number
}
const generatePathAroundWalls = (
  walls: Wall[],
  start: Point,
  end: Point,
): Point[] => {
  const path = [start]
  const reversedWalls = walls.toReversed()
  let currentY = start.y
  path.push({ ...start })

  while (reversedWalls.length) {
    const wall = reversedWalls.pop() as Wall
    currentY++

    if (wall.width === 0) {
      continue
    }

    if (wall.left === 0) {
      path.push({ x: wall.width + 0.5, y: currentY })
    } else {
      path.push({ x: 0, y: currentY })
    }
  }

  path.push(end)
  return path
}

const generateKeyframes = (path: Point[]) =>
  path.map(({ x, y }) => ({
    transform: `translate(${parrotsToPixels(x)}px, ${parrotsToPixels(y)}px)`,
  })
)

export const Maze = () => {
  const size = parrotsToPixels(fieldSize)
  const [walls, setWalls] = useState<Wall[]>(() =>
    Array.from({ length: fieldSize }, () => ({
      left: 0,
      width: 0,
    })),
  )

  const dogRef = useRef<HTMLDivElement | null>(null)

  const toggleWall = useCallback((mazeRow: number) => {
    setWalls((walls) =>
      walls.map((wall, i) => {
        if (i === mazeRow) {
          if (wall.width === 0) {
            return generateNewWall()
          } else {
            return {
              left: 0,
              width: 0,
            }
          }
        }
        return wall
      }),
    )
  }, [])

  const getBall = useCallback(() => {
    const start = { x: 0, y: 0 } // 🐶

    const end = { x: 0, y: fieldSize + 1 } // 🎾

    const path = generatePathAroundWalls(walls, start, end)
    dogRef.current?.animate(generateKeyframes(path), {
      duration: 3000,
      easing: 'linear',
      fill: 'forwards',
    })
  }, [walls])

  return (
    <>
      <button onClick={getBall}>Апорт!</button>
      <Dog ref={dogRef} />
      {/* 🐶 */}
      <div
        style={{
          width: size,
          height: size,
        }}
        className={styles.maze}
      >
        {Array.from({ length: fieldSize }, (_, i) => (
          <button
            key={i}
            style={{ height: parrotsToPixels(1) }}
            className={styles.button}
            onClick={() => toggleWall(i)}
          >
            <span
              className={styles.wall}
              style={{
                width: parrotsToPixels(walls[i].width),
                left: parrotsToPixels(walls[i].left),
              }}
            />
          </button>
        ))}
      </div>
    </>
  )
}

        
        
          
        
      

Несмотря на то, что всё работает правильно, код компонента далёк от совершенства. Слишком много логики содержится в одном файле компонента. Создание подобных компонентов — это типичная ошибка при знакомстве с React. Проблема в том, что мы не нашли удобного способа разделить состояние между всеми компонентами и просто сложили всё в одну кучу (точнее, в один лабиринт).

Даже когда кажется, что всё работает стабильно, стоит потратить немного времени на тестирование UX (user experience, пользовательское взаимодействие). Текущее решение содержит один неучтённый нюанс: после нажатия на кнопку «Апорт!» пользователь может добавить несколько стенок в лабиринте до того, как начнётся анимация. При этом у собачки появляются суперспособности проходить сквозь стены. Для устранения этой недокументированной возможности потребуется запретить обработку нажатий на кнопки добавления стен лабиринта как только была нажата кнопка «Апорт!» и до момента окончания анимации. Для этого можно добавить ещё одну переменную-состояние, чтобы знать, когда можно, а когда нельзя строить стены.

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

Попробуйте реализовать это исправление самостоятельно.

В следующей статье разберёмся как разделить состояние между компонентами.

На практике

Скопировано

Viktar Nezhbart советует

Скопировано

🛠 Обратите внимание как устанавливается первоначальное значение состояния в компоненте Maze. Аргументом хука useState тут является функция, возвращающая результат выполнения Array.from():

        
          
          // Пример Aconst [walls, setWalls] = useState<Wall[]>(  () => Array.from({ length: fieldSize }, () => ({    left: 0,    width: 0,  })))
          // Пример A
const [walls, setWalls] = useState<Wall[]>(
  () => Array.from({ length: fieldSize }, () => ({
    left: 0,
    width: 0,
  }))
)

        
        
          
        
      

Всё будет работать точно так же, если использовать Array.from() непосредственно как аргумент useState:

        
          
          // Пример Bconst [walls, setWalls] = useState<Wall[]>(  Array.from({ length: fieldSize }, () => ({    left: 0,    width: 0,  })))
          // Пример B
const [walls, setWalls] = useState<Wall[]>(
  Array.from({ length: fieldSize }, () => ({
    left: 0,
    width: 0,
  }))
)

        
        
          
        
      

В чём же разница между примером A и примером B?

Представим, что установка первоначального значения состояния требует вычислений и затратна по времени.

Инициализация состояния происходит только при первом рендеринге компонента. Функция () => Array.from() в примере A будет выполнена только один раз. Выполнение Array.from() в примере B будет происходить при каждом рендеринге компонента.

🛠 Возможность использовать функцию в качестве аргумента useState предусмотрена для случаев, когда вычисление первоначального состояния необходимо выполнить только один раз.