Skip to content

chore: add chevronIconClassName prop to CustomMenu #7163

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

Draft
wants to merge 1 commit into
base: preview
Choose a base branch
from

Conversation

JayashTripathy
Copy link
Member

@JayashTripathy JayashTripathy commented Jun 4, 2025

Description

add chevronIconClassName prop to CustomMenu

Summary by CodeRabbit

  • New Features
    • Added support for custom CSS classes on chevron icons in dropdown menus, allowing for enhanced icon styling options.

Copy link
Contributor

coderabbitai bot commented Jun 4, 2025

Walkthrough

The CustomMenu component was updated to accept a new optional chevronClassName prop, allowing custom CSS classes to be applied to its chevron icons. This change only affects the component's props and the way icon class names are constructed, without altering any other logic or behavior.

Changes

File(s) Change Summary
packages/ui/src/dropdowns/custom-menu.tsx Added optional chevronClassName prop to CustomMenu for custom icon classes; updated icon class assignments accordingly.

Suggested labels

🌐frontend, 🌟improvement, ready to merge

Suggested reviewers

  • anmolsinghbhatia
  • aaryan610
  • sriramveeraghanta

Poem

A chevron dons a brand new coat,
With custom classes, it can gloat.
The menu's look, now yours to steer,
With style and flair, the path is clear.
A tweak so small, yet rabbits cheer!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e35da6e and e47b8f4.

📒 Files selected for processing (1)
  • packages/ui/src/dropdowns/custom-menu.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/ui/src/dropdowns/custom-menu.tsx
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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

🧹 Nitpick comments (1)
packages/ui/src/dropdowns/helper.tsx (1)

36-36: Consider aliasing or deprecating the inherited chevronClassName to avoid confusion
You’ve added chevronIconClassName, but IDropdownProps already exposes chevronClassName. Consumers may be unsure which to use. To maintain backward compatibility, either alias the old prop to the new one or mark chevronClassName as deprecated. Also, adding a brief JSDoc description for chevronIconClassName would improve discoverability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1113f9f and e35da6e.

📒 Files selected for processing (2)
  • packages/ui/src/dropdowns/custom-menu.tsx (3 hunks)
  • packages/ui/src/dropdowns/helper.tsx (1 hunks)
🔇 Additional comments (2)
packages/ui/src/dropdowns/custom-menu.tsx (2)

172-174: Correctly appends chevronIconClassName to the MoreHorizontal icon
Your use of cn with the default sizing/rotation string and the custom class is spot on. Empty or undefined values are handled gracefully.


195-195: Correctly appends chevronIconClassName to the ChevronDown icon
The down-chevron integration mirrors the horizontal one and looks good. No issues here.

@sriramveeraghanta sriramveeraghanta requested review from lifeiscontent and removed request for prateekshourya29 June 5, 2025 08:11
@lifeiscontent
Copy link
Collaborator

This change introduces a chevronClassName prop that exposes direct styling control over internal chevron elements. While this appears to solve immediate customization needs, it actually implements an anti-pattern that will create maintenance and architectural issues down the line.

Issues with this approach:

  1. Breaks encapsulation - Consumers now need to understand the internal DOM structure and specific chevron implementation details
  2. Creates tight coupling - Any refactoring of the chevron rendering logic risks breaking consumer code that depends on these class names
  3. Inconsistent design system - Different consumers will style chevrons differently, leading to UI inconsistency across the application

Recommended alternatives:

Instead of exposing chevronClassName, consider these more maintainable approaches:

  • Variant system: chevronStyle="minimal" | "bold" | "subtle"
  • Boolean controls: hideChevron={true} or showChevron={false}
  • Enum-based positioning: chevronPosition="left" | "right"
  • CSS custom properties: Controlled theming through CSS variables like --chevron-color

This keeps the component API semantic and maintainable while still providing the flexibility consumers need.

Further reading:

For a deeper dive into why exposing className props creates architectural problems, I'd recommend reading this article: [Why Exposing className in React UI Components is an Anti-Pattern](https://dev.to/lifeiscontent/why-exposing-classname-in-react-ui-components-is-an-anti-pattern-28ha)

The principles discussed there apply directly to this situation and explain why component APIs should focus on semantic properties rather than direct styling access.

@JayashTripathy
Copy link
Member Author

JayashTripathy commented Jun 7, 2025

This change introduces a chevronClassName prop that exposes direct styling control over internal chevron elements. While this appears to solve immediate customization needs, it actually implements an anti-pattern that will create maintenance and architectural issues down the line.

Issues with this approach:

  1. Breaks encapsulation - Consumers now need to understand the internal DOM structure and specific chevron implementation details
  2. Creates tight coupling - Any refactoring of the chevron rendering logic risks breaking consumer code that depends on these class names
  3. Inconsistent design system - Different consumers will style chevrons differently, leading to UI inconsistency across the application

Recommended alternatives:

Instead of exposing chevronClassName, consider these more maintainable approaches:

  • Variant system: chevronStyle="minimal" | "bold" | "subtle"
  • Boolean controls: hideChevron={true} or showChevron={false}
  • Enum-based positioning: chevronPosition="left" | "right"
  • CSS custom properties: Controlled theming through CSS variables like --chevron-color

This keeps the component API semantic and maintainable while still providing the flexibility consumers need.

Further reading:

For a deeper dive into why exposing className props creates architectural problems, I'd recommend reading this article: [Why Exposing className in React UI Components is an Anti-Pattern](https://dev.to/lifeiscontent/why-exposing-classname-in-react-ui-components-is-an-anti-pattern-28ha)

The principles discussed there apply directly to this situation and explain why component APIs should focus on semantic properties rather than direct styling access.

sure! ill look into it

@JayashTripathy JayashTripathy reopened this Jun 7, 2025
@JayashTripathy JayashTripathy marked this pull request as draft June 7, 2025 08:33
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.

2 participants