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 button text editing to CTA Card #1416

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Added button text editing to CTA Card #1416

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-312/implement-button-text-update

  • Added ability to update the text of a button
  • added test

Summary by CodeRabbit

  • New Features

    • Enhanced Call To Action (CTA) card with dynamic button text editing
    • Users can now customize button text directly within the CTA card settings
  • Tests

    • Added end-to-end test to verify button text modification functionality

ref https://linear.app/ghost/issue/PLG-312/implement-button-text-update

- Added ability to update the text of a button
- added test
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/nodes/CallToActionNodeComponent.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 a new function handleButtonTextChange in the CallToActionNodeComponent to enable dynamic button text updates. This enhancement allows users to modify the button text directly within the CTA card interface. A corresponding end-to-end test case has been added to verify the new functionality, ensuring that the button text can be successfully changed and reflected in the component.

Changes

File Change Summary
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx Added handleButtonTextChange function to update button text dynamically
packages/koenig-lexical/test/e2e/cards/cta-card.test.js Added new test case can set button text to validate button text modification

Sequence Diagram

sequenceDiagram
    participant User
    participant CtaCard
    participant Editor
    participant Node

    User->>CtaCard: Input button text
    CtaCard->>Editor: Call handleButtonTextChange
    Editor->>Node: Update buttonText property
    Node-->>CtaCard: Text updated
    CtaCard-->>User: Display updated button text
Loading

Possibly related PRs

Poem

🐰 A rabbit's tale of buttons bright,
Code that dances with pure delight!
Text can change with just a click,
Lexical magic, oh so slick!
Hop along, innovation's might! 🚀

✨ 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 (1)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

43-48: Consider adding input validation and error handling.

While the implementation is functionally correct, consider these improvements:

  1. Add input validation for the button text
  2. Handle potential errors when retrieving the node
 const handleButtonTextChange = (event) => {
+    const newText = event.target.value;
+    // Optional: Add validation
+    if (newText.length > 100) {
+        return;
+    }
     editor.update(() => {
         const node = $getNodeByKey(nodeKey);
+        if (!node) {
+            console.warn(`Node with key ${nodeKey} not found`);
+            return;
+        }
         node.buttonText = event.target.value;
     });
 };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e9268a and 3464d24.

📒 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)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1
🔇 Additional comments (2)
packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1)

59-65: Well-structured test case!

The test effectively verifies the button text editing functionality with clear setup, action, and assertion steps. It follows the established testing patterns in the file.

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

70-70: LGTM!

The prop update correctly connects the new handler to the CtaCard component.

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