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

Wired up button toggle to CTA Card #1415

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Wired up button toggle to CTA Card #1415

merged 1 commit into from
Jan 23, 2025

Conversation

ronaldlangeveld
Copy link
Member

@ronaldlangeveld ronaldlangeveld commented Jan 23, 2025

ref https://linear.app/ghost/issue/PLG-318/implement-button-toggle

  • Wired up a function to toggle the visibility of the button on the CTA card.
  • Ensures the Button settings expand and collapse when toggling it.
  • Added tests

Summary by CodeRabbit

Release Notes

  • New Features

    • Added ability to toggle CTA card button visibility
    • Enhanced CTA card button settings interaction
  • Tests

    • Added new end-to-end tests for CTA card button functionality
    • Improved test coverage for button settings expansion and collapse
  • Improvements

    • Refined component parameter formatting
    • Updated import statements for better context management

ref https://linear.app/ghost/issue/PLG-318/implement-button-toggle

- Wired up a function to toggle the visibility of the button on the CTA
  card.
- Ensures the Button settings expand and collapse when toggling it.
- Added tests
Copy link

coderabbitai bot commented Jan 23, 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/src/components/ui/cards/CtaCard.jsx

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 changes to the Call To Action (CTA) card functionality in the Koenig-Lexical editor. The modifications focus on enhancing the interactivity of the CTA card by adding a method to toggle the button's visibility dynamically. The changes span across three files: a UI component, a node component, and an end-to-end test file. The updates include refactoring function parameters, implementing a new toggle function, and adding corresponding test cases to verify the new behavior.

Changes

File Change Summary
packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx Removed comments from function parameters
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx Added toggleShowButton method and updated updateShowButton prop
packages/koenig-lexical/test/e2e/cards/cta-card.test.js Added expect import and two new test cases for button visibility and settings

Sequence Diagram

sequenceDiagram
    participant User
    participant CtaCard
    participant CallToActionNode
    
    User->>CtaCard: Click toggle button
    CtaCard->>CallToActionNode: toggleShowButton()
    CallToActionNode-->>CtaCard: Update button visibility
    CtaCard-->>User: Reflect button visibility change
Loading

Possibly related PRs

Poem

🐰 A button's dance, now light, now shy
Toggled with a rabbit's keen eye
In Lexical's magical domain
Where cards and nodes their secrets explain
A toggle's tale, both swift and 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.

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

43-57: Fix typo in comment.

The test is well-structured and comprehensive, but there's a typo in the comment.

-        // determine if settings are open byy looking for cta-button-color, button-text & button-url
+        // determine if settings are open by looking for cta-button-color, button-text & button-url
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

36-41: Add error handling to the toggle function.

While the implementation works, it could benefit from proper error handling and validation.

 const toggleShowButton = (event) => {
     editor.update(() => {
         const node = $getNodeByKey(nodeKey);
+        if (!node) {
+            console.error('Failed to find node with key:', nodeKey);
+            return;
+        }
         node.showButton = !node.showButton;
     });
 };

Also applies to: 67-67

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 31ad767 and 795b81f.

📒 Files selected for processing (3)
  • packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx (1 hunks)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (4 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (2 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/koenig-lexical/test/e2e/cards/cta-card.test.js (2)

2-2: LGTM!

The addition of the expect import is necessary for the new test assertions.


32-41: LGTM! Well-structured test case.

The test effectively verifies the button toggle functionality, checking both show and hide states.

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

4-4: LGTM!

The new imports are necessary for implementing the button toggle functionality.

Also applies to: 9-9

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