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

[WEB-2453] fix: Render on hover only when enabled #5609

Merged
merged 4 commits into from
Sep 20, 2024

Conversation

rahulramesha
Copy link
Collaborator

@rahulramesha rahulramesha commented Sep 13, 2024

This PR changes the code to enable render on Hover for both dropdown and tooltip only when enabled and treats renderByDefault as the single source of truth for issue property dropdowns

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new property, renderToolTipByDefault, across various dropdown components to enhance tooltip rendering flexibility.
    • Added renderByDefault prop to several spreadsheet column components, allowing for controlled rendering based on user context.
  • Bug Fixes

    • Corrected formatting inconsistencies in prop declarations for improved clarity and consistency.

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

The changes introduce a new optional property, renderToolTipByDefault, to various dropdown components, enhancing tooltip rendering behavior. This property allows developers to control whether tooltips are rendered by default, improving flexibility across components like DropdownButton, CycleDropdown, DateRangeDropdown, and others. Additionally, minor formatting adjustments were made to ensure consistency in prop declarations.

Changes

File Path Change Summary
web/core/components/dropdowns/buttons.tsx Added renderToolTipByDefault?: boolean to DropdownButtonProps and ButtonProps.
web/core/components/dropdowns/cycle/index.tsx Added renderToolTipByDefault prop to CycleDropdown component.
web/core/components/dropdowns/date-range.tsx Added renderToolTipByDefault prop to DateRangeDropdown component.
web/core/components/dropdowns/date.tsx Added renderToolTipByDefault prop to DateDropdown component.
web/core/components/dropdowns/estimate.tsx Added renderToolTipByDefault prop to EstimateDropdown component.
web/core/components/dropdowns/member/index.tsx Added renderToolTipByDefault prop and corrected formatting of optionsClassName in MemberDropdown.
web/core/components/dropdowns/module/index.tsx Added renderToolTipByDefault prop to ModuleDropdown component.
web/core/components/dropdowns/priority.tsx Added renderToolTipByDefault?: boolean to ButtonProps and updated button components to use this prop.
web/core/components/dropdowns/project.tsx Added renderToolTipByDefault prop to ProjectDropdown component.
web/core/components/dropdowns/state.tsx Added renderToolTipByDefault prop to StateDropdown component.
web/core/components/issues/issue-layouts/properties/labels.tsx Updated renderByDefault to use a dynamic reference instead of hardcoded false.
web/core/components/issues/issue-layouts/spreadsheet/columns/assignee-column.tsx Added renderByDefault: boolean prop to SpreadsheetAssigneeColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/cycle-column.tsx Added renderByDefault: false to SpreadsheetCycleColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/due-date-column.tsx Added renderByDefault: false to SpreadsheetDueDateColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/estimate-column.tsx Added renderByDefault: false to SpreadsheetEstimateColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/label-column.tsx Added renderByDefault: false to SpreadsheetLabelColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/module-column.tsx Added renderByDefault: false to SpreadsheetModuleColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/priority-column.tsx Added renderByDefault: false to SpreadsheetPriorityColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/start-date-column.tsx Added renderByDefault: boolean to SpreadsheetStartDateColumn.
web/core/components/issues/issue-layouts/spreadsheet/columns/state-column.tsx Added renderByDefault: false to SpreadsheetStateColumn.

Possibly related PRs

  • [WEB-2443] fix: issue properties dropdown #5592: The changes in the CycleDropdown, DateRangeDropdown, DateDropdown, EstimateDropdown, MemberDropdown, ModuleDropdown, PriorityDropdown, ProjectDropdown, and StateDropdown components all involve the addition of a disabled property, which is related to the overall enhancement of dropdown functionality and user interaction control, similar to the introduction of the renderToolTipByDefault property in the main PR.

Suggested labels

🧹chore

Suggested reviewers

  • SatishGandham
  • rahulramesha

Poem

🐇 In the meadow where dropdowns play,
Tooltips now dance, come what may.
With a flick of a switch, they appear with delight,
Guiding our users, making things right.
So hop along, let the changes unfold,
A world of new options, bright and bold! 🌼


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 generate interesting stats about this repository and render them as a table.
    -- @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.

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
Collaborator

@SatishGandham SatishGandham left a comment

Choose a reason for hiding this comment

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

What are the cases where we need to render it by default?

@rahulramesha
Copy link
Collaborator Author

What are the cases where we need to render it by default?

@SatishGandham for now the ones that are rendering on hover are the ones in issue layouts. everywhere it is rendering by default. All the cases needs to tested individually and fix indentation issues before enabling it in them

@rahulramesha rahulramesha marked this pull request as draft September 18, 2024 12:15
@rahulramesha rahulramesha marked this pull request as ready for review September 18, 2024 12:54
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f85b39f and eafa8b2.

Files selected for processing (1)
  • packages/ui/src/tooltip/tooltip.tsx (1 hunks)

@@ -43,7 +43,7 @@ export const Tooltip: React.FC<ITooltipProps> = ({
openDelay = 200,
closeDelay,
isMobile = false,
renderByDefault = true,
renderByDefault = true, //FIXME: tooltip should always render on hover and not by default, this is a temporary fix
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the renderByDefault prop value to align with the intended behavior.

The updated comment suggests that the tooltip should always render on hover, not by default. However, the renderByDefault prop is still set to true, which contradicts the comment.

To avoid confusion and ensure consistency between the code and the comment, consider updating the prop value to match the intended behavior:

- renderByDefault = true, //FIXME: tooltip should always render on hover and not by default, this is a temporary fix
+ renderByDefault = false, // Tooltip should always render on hover and not by default

Alternatively, if the current behavior is indeed a temporary fix, provide a clear timeline or reference to the planned changes to address this discrepancy.

If you need any assistance in implementing the intended behavior or have any questions, feel free to reach out. I'm happy to help!

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
renderByDefault = true, //FIXME: tooltip should always render on hover and not by default, this is a temporary fix
renderByDefault = false, // Tooltip should always render on hover and not by default

@SatishGandham SatishGandham merged commit 604ddad into preview Sep 20, 2024
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants