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

fix(calendar): arrows changing order when html has dir="rtl" #3656

Merged
merged 3 commits into from
Aug 30, 2024

Conversation

ameybh
Copy link
Contributor

@ameybh ameybh commented Aug 13, 2024

Closes #3641
Closes #3642

📝 Description

⛳️ Current behavior (updates)

As described in #3641, currently, if the html has dir attribute equal to rtl, the arrow keys look incorrect.

🚀 New behavior

Added order to prevButton, nextButton and header . Added rtl:flex-row-reverse to headerWrapper.
The prev button should always be a left arrow and the next button should always be a right arrow, hence removed condition that changed arrow type based on locale direction.

Calendar with dir="rtl"

image

Date Picker with dir="rtl"

image

Date picker in Arabic

image

💣 Is this a breaking change (Yes/No):

No.

Summary by CodeRabbit

  • New Features

    • Improved keyboard navigation for RTL (right-to-left) layouts in the calendar component for enhanced accessibility.
  • Bug Fixes

    • Resolved issues with arrow key navigation order in RTL environments.
  • Style

    • Updated visual order of calendar navigation elements to improve user experience in RTL layouts.

Copy link

changeset-bot bot commented Aug 13, 2024

🦋 Changeset detected

Latest commit: 4b34d6c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@nextui-org/calendar Patch
@nextui-org/theme Patch
@nextui-org/date-picker Patch
@nextui-org/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Aug 13, 2024

@ameybh is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Walkthrough

This update enhances the @nextui-org/calendar package by addressing keyboard navigation for right-to-left (RTL) layouts and simplifying the rendering of navigation icons. It ensures that arrow keys function intuitively in RTL contexts, improving accessibility. Additionally, the internal logic has been streamlined by removing unnecessary hooks, and the visual arrangement of calendar navigation buttons has been adjusted for better compatibility with RTL layouts.

Changes

Files Change Summary
.changeset/slow-forks-nail.md Introduced patch for RTL keyboard navigation in @nextui-org/calendar.
calendar-base.tsx Removed useLocale hook; static rendering for ChevronLeftIcon and ChevronRightIcon.
packages/core/theme/src/components/calendar.ts Added ordering classes for buttons and header; modified headerWrapper for RTL layout with rtl:flex-row-reverse.

Assessment against linked issues

Objective Addressed Explanation
Fix RTL navigation issues in Calendar (3641)
Ensure correct display of navigation icons (3641)
Simplify component logic related to navigation
Improve accessibility for RTL layouts

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1973864 and 8162066.

Files selected for processing (3)
  • .changeset/slow-forks-nail.md (1 hunks)
  • packages/components/calendar/src/calendar-base.tsx (4 hunks)
  • packages/core/theme/src/components/calendar.ts (1 hunks)
Additional comments not posted (3)
.changeset/slow-forks-nail.md (1)

1-5: Changeset file looks good.

The changeset correctly describes the fix for the arrow keys order in RTL mode.

packages/components/calendar/src/calendar-base.tsx (1)

Line range hint 72-86: Simplified icon rendering logic is effective.

The removal of locale-based conditions for icon rendering reduces complexity and potential errors.

However, verify if the removal of useLocale affects other parts of the codebase.

packages/core/theme/src/components/calendar.ts (1)

13-24: CSS class changes enhance RTL support.

The introduction of specific ordering classes and rtl:flex-row-reverse improves RTL layout handling.

Verify if the CSS class changes are consistently applied across the component.

Verification successful

CSS class changes verified for RTL support in calendar.ts.

The CSS classes order-1, order-2, order-3, and rtl:flex-row-reverse are consistently applied in the calendar.ts component, enhancing RTL layout handling as intended. No inconsistencies were found within this component.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify consistent application of CSS class changes for RTL support.

# Test: Search for the usage of `order-1`, `order-2`, `order-3`, and `rtl:flex-row-reverse`. Expect: Consistent usage across the component.
rg --type ts 'order-1|order-2|order-3|rtl:flex-row-reverse'

Length of output: 8986

@wingkwong wingkwong self-assigned this Aug 14, 2024
Copy link

vercel bot commented Aug 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 14, 2024 4:40pm

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8162066 and 4b34d6c.

Files selected for processing (1)
  • .changeset/slow-forks-nail.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .changeset/slow-forks-nail.md

@wingkwong wingkwong assigned jrgarciadev and unassigned wingkwong Aug 14, 2024
@wingkwong wingkwong modified the milestones: v2.5.0, v2.4.7 Aug 14, 2024
@wingkwong wingkwong merged commit 55c9298 into nextui-org:canary Aug 30, 2024
7 of 8 checks passed
@ameybh ameybh deleted the fix/calendar-rtl branch September 2, 2024 18:41
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] - Lack of RTL Support in Date Range Picker [BUG] - Lack of RTL Support in Calendar
3 participants