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

feat(ScrollLock): add useScrollingLockedScroll to scroll locked layout #8137

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

Conversation

EldarMuhamethanov
Copy link
Contributor

@EldarMuhamethanov EldarMuhamethanov commented Jan 9, 2025


  • Unit-тесты
  • Release notes

Описание

В issue #8069 был приложен пример, где нужно было реализовать скролл фона при открытии ModalCard. Это было сделано не самым удобным способом - убиранием блокировки, изменение скролла window, и возвратом блокировки. У данного подхода есть еще проблема в том, что при изменении скролла, скроллбар справа появляется и потом пропадает. Выглядит не очень

Сейчас в контексте ScrollContext уже есть методы scrollTo и getScroll, которые позволяют скроллить, но только, когда скролл не заблочен. Нужно доработать эти функции, чтобы они работали корректно и при заблокированном скролле. Также надо подумать как из отдать пользователю наружу

Изменения

  • Доработал логику функций из контекста scrollTo и getScroll, так чтобы они корректно работали при заблокированном скролле. Для этого добавил правильный расчет x и y на основании стилей у body
  • Добавил тест, проверяющий новый функционал со скроллом при заблокированном контенте.
  • Добавил хук useScrollingLockedScroll, который возвращает только scrollTo и getScroll из контекста ScrollContext, чтобы не экспортировать больше чем нужно

Release notes

Улучшения

  • Добавлен хук useScrollingLockedScroll, который позволяет скролить заблокированный скролл вручную.

Copy link
Contributor

github-actions bot commented Jan 9, 2025

size-limit report 📦

Path Size
JS 390.34 KB (+0.11% 🔺)
JS (gzip) 118.54 KB (+0.12% 🔺)
JS (brotli) 97.63 KB (+0.22% 🔺)
JS import Div (tree shaking) 1.56 KB (0%)
CSS 342.99 KB (0%)
CSS (gzip) 42.5 KB (0%)
CSS (brotli) 33.84 KB (0%)

Copy link

codesandbox-ci bot commented Jan 9, 2025

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

github-actions bot commented Jan 9, 2025

e2e tests

Playwright Report

Copy link
Contributor

github-actions bot commented Jan 9, 2025

👀 Docs deployed

Commit 2c097a1

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

Attention: Patch coverage is 82.85714% with 6 lines in your changes missing coverage. Please review.

Project coverage is 95.49%. Comparing base (58f1020) to head (2c097a1).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...ages/vkui/src/components/AppRoot/ScrollContext.tsx 82.85% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8137      +/-   ##
==========================================
- Coverage   95.53%   95.49%   -0.05%     
==========================================
  Files         398      398              
  Lines       11379    11400      +21     
  Branches     3757     3762       +5     
==========================================
+ Hits        10871    10886      +15     
- Misses        508      514       +6     
Flag Coverage Δ
unittests 95.49% <82.85%> (-0.05%) ⬇️

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

@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.

🔥

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
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

2 participants