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 layout toggle to CTA Card #1422

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Added layout toggle to CTA Card #1422

merged 4 commits into from
Jan 27, 2025

Conversation

ronaldlangeveld
Copy link
Member

@ronaldlangeveld ronaldlangeveld commented Jan 27, 2025

ref https://linear.app/ghost/issue/PLG-315/added-layout-handling-on-cta-card

  • Added layout toggle to CTA Card

Summary by CodeRabbit

  • New Features

    • Updated Call To Action (CTA) card with a new default layout of "minimal"
    • Added ability to toggle between "minimal" and "immersive" layouts
    • Enhanced CTA card with new data attributes for layout and testing
  • Tests

    • Added comprehensive end-to-end tests for CTA card layout functionality
    • Verified default and toggle behaviors for card layouts

Copy link

coderabbitai bot commented Jan 27, 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/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js

Oops! Something went wrong! :(

ESLint: 8.57.0

Error: Failed to load parser '@babel/eslint-parser' declared in 'packages/kg-default-nodes/.eslintrc.js': Cannot find module '@babel/eslint-parser'
Require stack:

  • /packages/kg-default-nodes/.eslintrc.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Function.resolve (node:internal/modules/helpers:145:19)
    at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
    at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
    at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
    at _normalizeObjectConfigDataBody.next ()
    at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
    at _normalizeObjectConfigData.next ()
    at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
    at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

Walkthrough

The pull request introduces modifications to the Call To Action (CTA) node and card components across multiple packages. The primary change is updating the default layout of the CTA from 'immersive' to 'minimal'. This involves adjusting the node class, test cases, and related components to reflect the new default layout. The changes enhance the flexibility of the CTA card by adding new handler functions for layout and background color updates, and introducing comprehensive e2e tests to validate the layout toggling functionality.

Changes

File Change Summary
packages/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js Default layout property changed from 'immersive' to 'minimal'
packages/kg-default-nodes/test/nodes/call-to-action.test.js Updated test dataset and assertions to reflect new 'minimal' layout
packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx Added data-cta-layout attribute and dataTestId prop
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx Added handleBackgroundColorChange and handleUpdatingLayout methods
packages/koenig-lexical/test/e2e/cards/cta-card.test.js Added three new tests for layout functionality

Sequence Diagram

sequenceDiagram
    participant User
    participant CtaCard
    participant CallToActionNode
    
    User->>CtaCard: Select/Change Layout
    CtaCard->>CallToActionNode: handleUpdatingLayout()
    CallToActionNode-->>CtaCard: Update Layout Property
    CtaCard->>CtaCard: Update UI Based on Layout
Loading

Possibly related PRs

Poem

🐰 A rabbit's tale of layout's grace,
From immersive to minimal's embrace
Our CTA card now stands so neat
With changes subtle, clean, and sweet
A toggle here, a class just right
Our design now shines so bright! 🎨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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 changed the title PLG 315 Added layout toggle to CTA Card Jan 27, 2025
@ronaldlangeveld ronaldlangeveld marked this pull request as ready for review January 27, 2025 09:51
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/kg-default-nodes/test/nodes/call-to-action.test.js (1)

75-77: Consider adding more layout transition test cases

While the basic layout setter test is good, consider adding test cases for:

  • Invalid layout values
  • Layout transitions with other property changes
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5329fa2 and 3605d4d.

📒 Files selected for processing (5)
  • packages/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js (2 hunks)
  • packages/kg-default-nodes/test/nodes/call-to-action.test.js (2 hunks)
  • packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx (2 hunks)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1
🔇 Additional comments (3)
packages/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js (1)

6-6: Breaking Change: Default layout changed from 'immersive' to 'minimal'

This change modifies the default behavior of the CTA card. Existing code that relies on the default 'immersive' layout may need to be updated.

Let's verify the impact on existing CTA cards:

Also applies to: 36-36

✅ Verification successful

✓ Default layout change is safe and verified

The change from 'immersive' to 'minimal' default layout is properly tested and doesn't impact existing code:

  • Test suite explicitly verifies 'minimal' as the default layout
  • No instances found of CTA cards being created without explicit layout specification
  • Change is consistently applied across the codebase
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for CTA card usage without explicit layout specification
ast-grep --pattern 'new CallToActionNode({$$$})'

Length of output: 50


Script:

#!/bin/bash
# Search for any references to CallToActionNode
rg "CallToActionNode" -B 2 -A 2

# Also search for test files specifically
fd "test|spec" -e js -x cat {} \; | rg "CallToActionNode" -B 2 -A 2

Length of output: 15653

packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

73-85: LGTM! Clean implementation of handler functions

The new handlers follow consistent patterns and properly integrate with Lexical's editor update cycle.

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

209-241: LGTM! Comprehensive e2e test coverage for layout functionality

The new tests thoroughly verify:

  • Default layout behavior
  • Layout toggle functionality
  • Associated UI changes (text alignment)

@ronaldlangeveld ronaldlangeveld merged commit adb08b8 into main Jan 27, 2025
2 checks passed
@ronaldlangeveld ronaldlangeveld deleted the plg-315 branch January 27, 2025 10:03
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