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

465-refactor: Customize slider #466

Merged
merged 12 commits into from
Sep 8, 2024
Merged

Conversation

natanchik
Copy link
Collaborator

@natanchik natanchik commented Aug 29, 2024

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

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

Description

The following accessibility and SEO issues with Slider have been resolved:

  • Image elements do not have alt attributes;
  • Lists contain elements other than li elements and script and template elements;
  • Uses ARIA roles on incompatible elements;

Additional features have also been added to improve the user experience:

  • autoplay;
  • swipe on the Desktop;
  • the ability to use arrow keys to switch between slides;
  • added a contrasting background for the slider navigation bars, and increased the size of the radio buttons;
  • added infinite loop for slider;
  • centering of the selected image is set.

Related Tickets & Documents

Screenshots, Recordings

Before:
Screenshot 2024-08-29 084022
After:
Screenshot 2024-08-29 084035
Before:
image
After:
image

Added/updated tests?

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

Summary by CodeRabbit

  • New Features

    • Enhanced accessibility for images by adding alt attributes.
    • Updated Carousel component with new props for improved functionality, including autoPlay and infiniteLoop.
    • Improved semantic structure by replacing <div> with <section> in the Pictures component.
  • Style

    • Reorganized and enhanced styling for the carousel component, introducing a new .carousel class and improved control elements.
    • Streamlined CSS for better responsiveness and user interaction feedback in the carousel.
  • Bug Fixes

    • Adjusted the expected number of images in the Pictures component's test suite from 9 to 11.

@github-actions github-actions bot changed the title Refactor/465 customize slider 465-refactor: Customize slider Aug 29, 2024
@natanchik natanchik marked this pull request as ready for review August 29, 2024 16:12
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

Walkthrough

The changes involve enhancements to accessibility and styling across multiple components, including the addition of alt attributes to images, restructuring of CSS classes, and updates to the Carousel component's functionality. These modifications aim to improve semantic HTML usage, user experience, and compliance with accessibility standards.

Changes

Files Change Summary
src/entities/events/ui/event-card/event-card.module.scss Moved -webkit-line-clamp property for better organization; no functional changes.
src/widgets/events/ui/events.tsx Added alt attribute to Image component for accessibility.
src/widgets/pictures/pictures.test.tsx Updated test expectation for the number of images from 9 to 11.
src/widgets/pictures/ui/pictures.scss Reorganized styles, introduced .carousel class, and added styling for control elements.
src/widgets/pictures/ui/pictures.tsx Replaced <div> with <section>, added new props to Carousel, and included alt attributes.

Assessment against linked issues

Objective Addressed Explanation
Image elements do not have alt attributes (465) βœ…
Lists contain elements other than li elements (465) ❌ No changes to list structure made.
Uses ARIA roles on incompatible elements (465) ❓ Unclear if ARIA roles were addressed.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5eb0b27 and c056611.

Files selected for processing (1)
  • src/widgets/pictures/ui/pictures.scss (1 hunks)
Additional comments not posted (4)
src/widgets/pictures/ui/pictures.scss (4)

1-4: Ensure Accessibility for Interactive Elements

The .slide class uses cursor: pointer, which is good for indicating interactivity. However, ensure that this visual cue is complemented with appropriate ARIA roles or labels to enhance accessibility for users relying on screen readers.


37-39: Dot Class Styling Approved

The styling for the .dot class is appropriate and follows standard practices for carousel indicators.


43-50: Responsive Design Enhancements Approved

The modifications to the .social-media-container class enhance its responsiveness and alignment on different devices, which is crucial for maintaining a good user experience across platforms.


10-33: Review Use of CSS Variables and Hover Effects

The control buttons make good use of CSS variables for dimensions and positioning, which enhances maintainability. However, the hover effects defined under @media (hover: hover) need to be tested on touch devices to ensure they do not cause any unwanted behavior as previously discussed by KristiBo.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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: 87 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

Lighthouse Report:

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

View detailed report

Copy link

github-actions bot commented Sep 1, 2024

Lighthouse Report:

  • Performance: 83 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

github-actions bot commented Sep 1, 2024

Lighthouse Report:

  • Performance: 81 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

github-actions bot commented Sep 8, 2024

Lighthouse Report:

  • Performance: 99 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

github-actions bot commented Sep 8, 2024

Lighthouse Report:

  • Performance: 89 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Copy link

github-actions bot commented Sep 8, 2024

Lighthouse Report:

  • Performance: 65 / 100
  • Accessibility: 94 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

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

Successfully merging this pull request may close these issues.

Lighthouse. Fix accessibility and SEO problems with Slider on Community page
6 participants