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

771-feat: Mentorship post release updates: Modal improvements #773

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

Quiddlee
Copy link
Member

@Quiddlee Quiddlee commented Feb 2, 2025

What type of PR is this? (select all that apply)

  • πŸ• Feature
  • πŸ› Bug Fix
  • 🚧 Breaking Change
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ“ Documentation Update

Description

Related Tickets & Documents

Screenshots, Recordings

Added/updated tests?

  • πŸ‘Œ Yes
  • πŸ™…β€β™‚οΈ No, because they aren't needed
  • πŸ™‹β€β™‚οΈ No, because I need help

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Summary by CodeRabbit

  • New Features

    • Introduced smoother modal transitions with a new fade-out effect on close.
    • Enhanced motion dynamics through new animation easing options.
    • Added keyboard support for closing the modal using the 'Escape' key.
  • Style

    • Refined modal design with updated padding, responsive adjustments, and an improved close button appearance.
  • Bug Fixes

    • Improved test reliability for modal closing behavior by incorporating asynchronous checks.

@Quiddlee Quiddlee self-assigned this Feb 2, 2025
@Quiddlee Quiddlee added the feature New feature or request label Feb 2, 2025
@github-actions github-actions bot changed the title Feat/771 modal improvements 771-feat: Modal improvements Feb 2, 2025
@Quiddlee Quiddlee added preview and removed preview labels Feb 3, 2025
Copy link

github-actions bot commented Feb 3, 2025

Lighthouse Report:

  • Performance: 70 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

github-actions bot commented Feb 9, 2025

Lighthouse Report:

  • Performance: 85 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

@Quiddlee Quiddlee requested a review from Copilot February 9, 2025 13:24
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 5 changed files in this pull request and generated 3 comments.

Files not reviewed (2)
  • src/core/styles/_constants.scss: Language not supported
  • src/shared/ui/modal/modal.module.scss: Language not supported

@Quiddlee Quiddlee changed the title 771-feat: Modal improvements 771-feat: Mentorship post release updates: Modal improvements Feb 9, 2025
@SpaNb4 SpaNb4 marked this pull request as ready for review February 10, 2025 11:23
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

πŸ“ Walkthrough

Walkthrough

The changes introduce two new easing function variables in the SCSS file and update test files to utilize the asynchronous waitFor function for modal close assertions. Additionally, the modal styling is modified by adjusting paddings, adding fade-in/out animations, and updating keyframes. The modal component’s close logic now triggers a fade-out animation before executing the close procedure. These modifications enhance the modal’s animation transitions and responsiveness.

Changes

File(s) Change Summary
src/core/styles/_constants.scss Added easing function variables: $ease-in-cubic (cubic-bezier(0.32, 0, 0.67, 0)) and $ease-out-quart (cubic-bezier(0.25, 1, 0.5, 1)).
src/.../mentor-feedback-card.test.tsx, src/.../modal.test.tsx Updated test assertions to use waitFor for asynchronous modal close behavior.
src/shared/ui/modal/modal.module.scss Adjusted modal styles: reduced padding, added fade-in/out animations with keyframes, modified modal body and close button styling.
src/shared/ui/modal/modal.tsx Revised the modal close logic to add a 'fade-out' class and delay the close action with an event listener for the animation end.
src/shared/constants.ts Added new constant KEY_CODES with ESCAPE key defined.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as Modal Component
    participant D as DOM/Animation Handler
    U->>M: Clicks close button
    M->>M: Add 'fade-out' class
    M->>D: Wait for 'animationend' event
    D-->>M: Emits 'animationend'
    M->>M: Remove 'fade-out' class and close modal
    M->>onClose: Invoke onClose callback
Loading

Suggested labels

refactor

Suggested reviewers

  • andron13
  • dzmitry-varabei
  • natanchik
  • SpaNb4
  • ansivgit
✨ Finishing Touches
  • πŸ“ Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Lighthouse Report:

  • Performance: 67 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
src/shared/ui/modal/modal.tsx (3)

22-22: Consider using ResizeObserver for dynamic scrollbar width updates.

The scrollbar width calculation is only done once on mount. This might not handle dynamic changes to the scrollbar width (e.g., when content changes affect scrollbar visibility).

 useEffect(() => {
-  scrollbarWidth.current = window.innerWidth - document.documentElement.clientWidth;
+  const updateWidth = () => {
+    scrollbarWidth.current = window.innerWidth - document.documentElement.clientWidth;
+  };
+  const resizeObserver = new ResizeObserver(updateWidth);
+  resizeObserver.observe(document.documentElement);
+  return () => resizeObserver.disconnect();
 }, []);

Also applies to: 25-27, 86-88


29-37: Consider extracting animation duration from CSS.

The animation duration is hardcoded in CSS. Consider making it configurable to ensure the cleanup timeout matches the animation duration.

+const FADE_OUT_DURATION = 300; // ms
+
 const handleClose = useCallback(() => {
   dialogRef.current?.classList.add(cx('fade-out'));
-  dialogRef.current?.addEventListener('animationend', () => {
+  const cleanup = () => {
     dialogRef.current?.classList.remove(cx('fade-out'));
     dialogRef.current?.close();
     onClose();
     updateScrollbarWidth();
-  }, { once: true });
+  };
+  dialogRef.current?.addEventListener('animationend', cleanup, { once: true });
+  // Fallback cleanup in case animation event doesn't fire
+  setTimeout(cleanup, FADE_OUT_DURATION);
 }, [onClose]);

76-84: Consider adding aria attributes for better accessibility.

The modal implementation could benefit from additional ARIA attributes.

 <dialog
   className={cx('modal', className)}
   ref={dialogRef}
   onClose={handleClose}
   onKeyDown={handleCloseOnEscPress}
   data-testid="modal"
+  aria-modal="true"
+  aria-labelledby={title ? 'modal-title' : undefined}
+  role="dialog"
 >

Also applies to: 99-99

πŸ“œ Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 4545bcd and 87cc7c0.

πŸ“’ Files selected for processing (2)
  • src/shared/constants.ts (1 hunks)
  • src/shared/ui/modal/modal.tsx (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: CI
πŸ”‡ Additional comments (3)
src/shared/constants.ts (1)

28-28: LGTM! Good use of type-safe constants.

The KEY_CODES constant follows best practices by using uppercase naming and the as const assertion.

src/shared/ui/modal/modal.tsx (2)

1-1: LGTM! Clean import organization.

Good separation of React imports, third-party imports, and local imports.

Also applies to: 7-7


60-66: LGTM! Good keyboard accessibility implementation.

The ESC key handler improves accessibility and follows best practices by using a constant for the key code.

Copy link

Lighthouse Report:

  • Performance: 96 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

@Quiddlee Quiddlee requested a review from ansivgit February 23, 2025 21:16
}

@include media-tablet {
padding: 0 16px 16px 16px;
width: 100dvw;
max-width: unset !important;
Copy link
Collaborator

Choose a reason for hiding this comment

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

What about increasing specificity by using .dialog.modal instead of using !important?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The animation seems too fast or something like that. Personally, I don't really like it

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

Successfully merging this pull request may close these issues.

Modal improvements
4 participants