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

Added changing background colour handling to CTA Card #1419

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Conversation

ronaldlangeveld
Copy link
Member

@ronaldlangeveld ronaldlangeveld commented Jan 26, 2025

ref https://linear.app/ghost/issue/PLG-317/implement-background-colour-handling-to-cta-card

  • Adds a background colour changing handler that would update the node and UI when the user toggles different colours.

Summary by CodeRabbit

  • New Features

    • Enhanced Call To Action (CTA) card with dynamic background color selection.
    • Added ability to change CTA card background colors (transparent, white, grey, green, blue, yellow, red).
  • Tests

    • Added comprehensive test coverage for CTA card background color functionality, including various color options.

Copy link

coderabbitai bot commented Jan 26, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/koenig-lexical/test/e2e/cards/cta-card.test.js

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces a new function handleBackgroundColorChange in the CallToActionNodeComponent to dynamically update the background color of a CTA (Call To Action) card. This change enables users to modify the card's background color through a color picker. A corresponding end-to-end test is added to verify that the background color can be changed to various predefined colors, ensuring the functionality works as expected.

Changes

File Change Summary
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx - Added handleBackgroundColorChange function to update node's background color
- Updated handleColorChange prop in CtaCard to use new function
packages/koenig-lexical/test/e2e/cards/cta-card.test.js - Added new test case can change background colours
- Verifies background color changes across multiple color options

Possibly related PRs

  • Added button text editing to CTA Card #1416: The addition of the handleButtonTextChange function in the CallToActionNodeComponent directly relates to the main PR's changes, which also involve updating the CtaCard component to handle button text dynamically.
  • Added URL input handling on CTA Card #1417: The introduction of the handleButtonUrlChange function in the CallToActionNodeComponent aligns with the main PR's focus on enhancing the CtaCard component's interactivity by allowing dynamic updates to the button URL.
  • Added Button Colour Handling to CTA card #1418: The changes in the CallToActionNodeComponent to handle buttonTextColor and buttonColor are directly related to the main PR's updates to manage the backgroundColor property, indicating a broader enhancement of color handling in the CTA card.

Poem

🐰 A rabbit's tale of color's might,
Where CTA cards now shine so bright!
With background hues that smoothly blend,
Our code's creativity knows no end.
Click, change, and watch the magic start! 🎨


📜 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 c93e6a0 and 0da37ec.

📒 Files selected for processing (1)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1

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

@ronaldlangeveld ronaldlangeveld marked this pull request as ready for review January 26, 2025 23:49
Copy link

@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)
packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1)

178-194: Enhance test robustness and consistency.

While the test covers the basic functionality, consider these improvements:

  1. Use consistent attribute naming:
-await page.click(`[data-test-id="${color.testId}"]`);
+await page.click(`[data-testid="${color.testId}"]`);
  1. Add verification of initial state:
 await insertCard(page, {cardName: 'call-to-action'});
 const firstChildSelector = '[data-kg-card="call-to-action"] > :first-child';
+
+// Verify initial state
+await expect(page.locator(firstChildSelector)).not.toHaveClass(/bg-(grey|green|blue|yellow|red)/);
  1. Consider verifying computed styles for more thorough testing:
for (const color of colors) {
    await page.click(`[data-testid="${color.testId}"]`);
    await expect(page.locator(firstChildSelector)).toHaveClass(new RegExp(color.expectedClass));
    
    // Verify actual computed background color
    const computedStyle = await page.evaluate((selector) => {
        const element = document.querySelector(selector);
        return window.getComputedStyle(element).backgroundColor;
    }, firstChildSelector);
    expect(computedStyle).toBe(color.expectedRgb); // Add expectedRgb to color objects
}
  1. Add a test for default background color:
test('default background is transparent', async function () {
    await focusEditor(page);
    await insertCard(page, {cardName: 'call-to-action'});
    const firstChildSelector = '[data-kg-card="call-to-action"] > :first-child';
    await expect(page.locator(firstChildSelector)).not.toHaveClass(/bg-/);
});
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e3d763e and c93e6a0.

📒 Files selected for processing (2)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1 hunks)
🔇 Additional comments (2)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2)

66-71: LGTM! Clean implementation of background color handler.

The function follows the established pattern in the codebase and correctly uses lexical's editor.update() for state management.


82-82: LGTM! Proper integration of background color handler.

The handleColorChange prop is correctly wired to the new background color handler.

@ronaldlangeveld ronaldlangeveld merged commit 52a7224 into main Jan 27, 2025
2 checks passed
@ronaldlangeveld ronaldlangeveld deleted the plg-317 branch January 27, 2025 00:40
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.

1 participant