Skip to content

Comments

[WEB-3045] fix: sticky placeholder, gray color value#6436

Merged
pushya22 merged 2 commits intopreviewfrom
fix/sticky-placeholder
Jan 21, 2025
Merged

[WEB-3045] fix: sticky placeholder, gray color value#6436
pushya22 merged 2 commits intopreviewfrom
fix/sticky-placeholder

Conversation

@aaryan610
Copy link
Member

@aaryan610 aaryan610 commented Jan 21, 2025

Description

This PR improves on the following things-

  1. Enhanced the gray background color.
  2. Removed the placeholder from sticky if content is already added.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

Summary by CodeRabbit

  • UI Changes

    • Removed default placeholder text from sticky editor
    • Updated color palette for gray background color
  • Utility Updates

    • Added new utility function to dynamically check comment emptiness

The changes subtly modify the visual and interactive aspects of the sticky editor and color palette, focusing on improving the user interface and content handling.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request introduces changes to three files related to the sticky editor and color palette components. The modifications include updating the background color for the gray color in the color palette, removing the placeholder prop from the StickyEditor component, and implementing a dynamic placeholder text generation mechanism based on content emptiness. These changes subtly modify the visual and interactive aspects of the sticky editor interface.

Changes

File Change Summary
web/core/components/editor/sticky-editor/color-palette.tsx Updated "gray" color's backgroundColor from CSS variable to RGBA function
web/core/components/editor/sticky-editor/editor.tsx Removed placeholder prop from StickyEditor component
web/core/components/stickies/sticky/inputs.tsx Imported isCommentEmpty utility and implemented dynamic placeholder text logic

Possibly related PRs

Suggested labels

✍️editor

Suggested reviewers

  • rahulramesha
  • sriramveeraghanta

Poem

🐰 A rabbit's tale of code so bright,
Colors shift and placeholders take flight,
Gray turns RGBA with grace,
Editors dance with newfound space,
Coding magic, pure delight! 🎨


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.

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.

@aaryan610 aaryan610 changed the title [WEB-3045] fix: sticky placeholder [WEB-3045] fix: sticky placeholder, gray color value Jan 21, 2025
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 (1)
web/core/components/editor/sticky-editor/color-palette.tsx (1)

11-11: LGTM! Consider standardizing color variables.

The change to use rgba(var(--color-background-90)) for the gray background aligns with the PR objective. However, consider standardizing all colors to use the same variable pattern for better maintainability.

Consider updating other colors to follow the same pattern:

-    backgroundColor: "var(--editor-colors-peach-background)",
+    backgroundColor: "rgba(var(--color-peach-90))",
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 58a4b45 and 8539e6e.

📒 Files selected for processing (3)
  • web/core/components/editor/sticky-editor/color-palette.tsx (1 hunks)
  • web/core/components/editor/sticky-editor/editor.tsx (0 hunks)
  • web/core/components/stickies/sticky/inputs.tsx (2 hunks)
💤 Files with no reviewable changes (1)
  • web/core/components/editor/sticky-editor/editor.tsx
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
web/core/components/stickies/sticky/inputs.tsx (2)

7-8: LGTM! Clean import addition.

The import of isCommentEmpty from @plane/utils is properly organized in the imports section.


72-76: LGTM! Clean implementation of dynamic placeholder.

The placeholder function effectively implements the requirement to show/hide placeholder based on content state.

Let's verify the reliability of the isCommentEmpty utility:

✅ Verification successful

Implementation of isCommentEmpty is reliable and correctly used.

The utility function has a robust implementation that properly handles all edge cases (undefined, empty strings, empty HTML paragraphs) and is consistently implemented across the codebase. Its usage in the placeholder logic is correct and follows the expected behavior.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for the implementation and tests of isCommentEmpty utility
echo "Searching for isCommentEmpty implementation:"
rg -p "export.*isCommentEmpty" -t typescript

echo "\nSearching for isCommentEmpty tests:"
rg -p "test.*isCommentEmpty" -t typescript

Length of output: 345


Script:

#!/bin/bash
# Search for isCommentEmpty implementation with correct flags and context
echo "Searching for isCommentEmpty implementation:"
rg -p "isCommentEmpty" -g "*.{ts,tsx}" -B 2 -A 5

echo -e "\nSearching specifically for exports of isCommentEmpty:"
rg "export.*(function|const) isCommentEmpty" -g "*.{ts,tsx}"

echo -e "\nSearching for test files containing isCommentEmpty:"
rg "isCommentEmpty" -g "*{test,spec}.{ts,tsx}"

Length of output: 8557


Script:

#!/bin/bash
# Search for tests with various patterns and locations
echo "Searching for tests in common test locations:"
rg "isCommentEmpty" -g "**/__tests__/**" -g "**/*.test.*" -g "**/*.spec.*" -g "**/tests/**"

echo -e "\nSearching for the complete implementation to verify edge cases:"
rg -A 5 "export const isCommentEmpty" -g "*.{ts,tsx}"

Length of output: 1573

@pushya22 pushya22 merged commit 3a86fff into preview Jan 21, 2025
12 of 14 checks passed
@pushya22 pushya22 deleted the fix/sticky-placeholder branch January 21, 2025 15:02
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.

2 participants