События на практике — JS: DOM API

События – один из основных источников сложности во фронтенде. Даже их небольшое количество способно сделать код очень сложным для восприятия. Для борьбы с этой сложностью существуют как и архитектурные решения (рассматриваются в курсе по фронтенд архитектуре), так и просто общепринятые подходы для каких-то типичных ситуаций. Все их рассмотреть в рамках курса невозможно, но кое-какие концепции все же стоит узнать заранее. В этом уроке мы рассмотрим решение типичной фронтенд задачи, пользуясь полученными ранее знаниями.

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

See the Pen js_dom_events_in_action_nav by Hexlet (@hexlet) on CodePen.

Если решать эту задачу в лоб, то нам понадобится извлечь из DOM все ссылки меню и повесить на каждую из них обработчик нажатия. Этот обработчик будет активировать текущий элемент и деактивировать предыдущий:

// nav-link – класс у ссылок в меню бутстрапа
// Нужно извлечь ВСЕ ссылки
const links = document.querySelectorAll('.nav-link');
// На каждую кнопку вешается событие
// Для этого обходим все ссылки и на каждую вешаем обработчик
links.forEach((link) => {
  link.addEventListener('click', () => {
    // Нужно деактивировать предыдущий выбранный элемент

    // Выделяем текущий
    link.classList.add('active');
  });
});

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

1. Запоминать выделенный элемент и снимать с него нужный класс в момент клика по новому элементу. Этот способ требует введения состояния, какой-то переменной, которая хранит текущий выделенный элемент. Дополнительную сложность добавляет первая загрузка, так как выделенный элемент скорее всего уже приходит в готовом HTML, а значит в js еще нет информации о том, кто активен. В целом этот способ довольно затратен в реализации.

2. Гораздо проще пойти другим путем. Вместо того, чтобы пытаться обновлять элементы точечно, мы просто снимем выделение со всех элементов сразу. И не важно был ли выделен элемент или нет – операция удаления класса идемпотентная, то есть она не приводит к ошибке если у элемента не было класса, который удаляется.

links.forEach((link) => {
  link.addEventListener('click', () => {
    // Удаляем активный класс со всех ссылок
    links.forEach((link) => link.classList.remove('active'));
    link.classList.add('active');
  });
});

Такое решение намного проще, хотя и делает немного лишней работы.

На этом можно было бы закончить, если бы не одно серьёзное но. Инициализация меню работает неправильно. Почему?

Не каждое меню бутстрапа управляется js, но текущий код этого не учитывает. Он будет пытаться работать с любым меню на странице, что неправильно. Правильный способ основан на использовании специального указателя, который говорит о том, что меню должно управляться с помощью js. Хорошей практикой считается использовать для этого data-* атрибуты.

В документации бутстрапа есть такой абзац:

You can activate a tab or pill navigation without writing any JavaScript by simply specifying data-toggle="tab" or data-toggle="pill" on an element. Use these data attributes on .nav-tabs or .nav-pills.

То есть добавление js логики работает только для тех меню, у которых есть нужный атрибут:

<ul class="nav nav-tabs" id="myTab" role="tablist">
  <li class="nav-item" role="presentation">
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
  </li>
  <li class="nav-item" role="presentation">
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
  </li>
  <li class="nav-item" role="presentation">
    <a class="nav-link" id="messages-tab" data-toggle="tab" href="#messages" role="tab" aria-controls="messages" aria-selected="false">Messages</a>
  </li>
</ul>

Соответственно наш код должен поменяться на следующий:

const links = document.querySelectorAll('[data-toggle="tab"]');

Но даже в этом случае код работает неверно. Сейчас он построен исходя из расчета одного меню на страницу. А компонент nav может добавляться на одну страницу неограниченное число раз. Например, на Хекслете есть места с тремя меню на одной странице.

Если запустить текущий код с несколькими меню, то можно заметить следующий баг. Клик по любому из пунктов в одном меню приводит к снятию активности с другого меню. Происходит это из-за этой строчки:

// links относится вообще ко всем ссылкам всех меню на странице
links.forEach((link) => link.classList.remove('active'));

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

1. Сначала найти корневой элемент текущего меню, того, по элементу которого произошел клик.
2. Найти активную ссылку внутри текущего меню и убрать с нее активность.

links.forEach((link) => {
  link.addEventListener('click', () => {
    // closest находит ближайшего родителя по нужному селектору
    // Наше меню имеет класс .nav
    const nav = link.closest('.nav');
    // Находим активный элемент внутри меню
    const activeElement = nav.querySelector('.nav-link.active');
    activeElement.classList.remove('active');
    link.classList.add('active');
  });
});

За кадром остался вопрос производительности, но это уже другая история.

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.