Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

a11y(CardScroll): fix a11y, ul>li combination #8140

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

EldarMuhamethanov
Copy link
Contributor


  • Unit-тесты
  • e2e-тесты
  • Release notes

Описание

Сейчас в компоненте CardScroll есть проблема с доступностью. Карточки li не являются прямыми потомками ul. Нужно придумать как решить эту проблему

Изменения

  • Поменял значение по умолчанию у свойство Component с 'ul' на 'div'(как было раньше). Почему это не breaking change? Потому что по идее это баг, текущее поведение все равно не работало как задумывалось
  • Добавил свойство CardsListComponent, которое позволяет поменять тег используемый для списка карточек. Значение по умолчанию "ul"
  • Сделал рефакторинг CardsScroll, чтобы уменьшить количество нод DOM дерева. Сделал падинги по бокам через псевдоэлементы after/before.
  • В компоненте HorizontalScroll добавил свойства ContentWrapperComponent, contentWrapperRef и contentWrapperClassName для кастомизации обертки над контентом, прокинутом в children. Это было сделано, чтобы в CardsScroll и других возможных местах не создавать доп обертку над контентом и уменьшить количество нод.
  • В тестах убрал отключение тестов a11y - теперь они проходят

Release notes

Улучшения

  • HorizontalScroll: Добавлены свойства ContentWrapperComponent, contentWrapperRef и contentWrapperClassName для кастомизации обертки над контентом, прокинутом в children
  • CardScroll: Добавлено свойство CardsListComponent, которое позволяет поменять тег используемый для списка карточек

Исправления

  • CardScroll:
    • Поправлена проблема с доступностью компонента, теперь li(карточки) являются прямыми потомками ul(списка карточек)
    • Изменено значение по умолчанию для свойства Component с "ul", на "div". Для правильно семантики тего нужно использовать свойство CardsListComponent, которое по умолчанию теперь "ul"

@EldarMuhamethanov EldarMuhamethanov requested a review from a team as a code owner January 10, 2025 12:53
Copy link
Contributor

size-limit report 📦

Path Size
JS 390.05 KB (+0.03% 🔺)
JS (gzip) 118.47 KB (+0.07% 🔺)
JS (brotli) 97.59 KB (+0.19% 🔺)
JS import Div (tree shaking) 1.56 KB (0%)
CSS 343.22 KB (+0.07% 🔺)
CSS (gzip) 42.51 KB (+0.02% 🔺)
CSS (brotli) 33.87 KB (+0.09% 🔺)

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link
Contributor

e2e tests

Playwright Report

Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.53%. Comparing base (58f1020) to head (80ae72a).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8140   +/-   ##
=======================================
  Coverage   95.53%   95.53%           
=======================================
  Files         398      398           
  Lines       11379    11381    +2     
  Branches     3757     3757           
=======================================
+ Hits        10871    10873    +2     
  Misses        508      508           
Flag Coverage Δ
unittests 95.53% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

👀 Docs deployed

Commit 80ae72a

Copy link
Contributor

@andrey-medvedev-vk andrey-medvedev-vk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Красота 👏 👏 👏 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug][CardScroll]: ul тег по умолчанию нарушает семантику ul>li
2 participants