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

Fixed call-to-action card in storybook #1448

Merged
merged 1 commit into from
Feb 17, 2025
Merged

Fixed call-to-action card in storybook #1448

merged 1 commit into from
Feb 17, 2025

Conversation

sanne-san
Copy link
Member

Ref https://linear.app/ghost/issue/PLG-351/standardise-naming-convention-for-call-to-action-components

  • Import was broken due to file name change
  • Editable sponsor label broke the call-to-action card in storybook

Ref https://linear.app/ghost/issue/PLG-351/standardise-naming-convention-for-call-to-action-components
- Import was broken due to file name change
- Editable sponsor label broke the call-to-action card in storybook
Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The changes update the story configuration for a card component by renaming it from CtaCard to CallToActionCard and modifying the story title to match the new name. The refactor introduces conditional logic in the Template function to handle the sponsor label, where a new editor instance is conditionally initialized with a default string when the hasSponsorLabel argument is true. Additionally, the component is now passed new props related to sponsor labeling (sponsorLabelHtmlEditor and sponsorLabelHtmlEditorInitialState). The update also includes the removal of legacy commented-out code, streamlining the JSX structure while aligning the component’s declaration and usage with the new naming convention and feature set.

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/CallToActionCard.stories.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.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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 (3)
packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx (3)

69-72: Consider making the sponsor label text configurable.

The sponsor label text is currently hardcoded as 'Sponsored'. Consider making it configurable through story args to support different use cases and localization.

-            initialHtml: 'Sponsored'
+            initialHtml: args.sponsorLabelText || 'Sponsored'

Don't forget to add the new arg to the story configuration:

argTypes: {
    // ... existing args
    sponsorLabelText: {
        control: 'text',
        description: 'Text to display in the sponsor label'
    }
}

63-73: Consider extracting editor initialization logic.

The editor initialization logic could be extracted to a helper function to improve code organization and reusability.

const initializeEditor = (nodes, initialHtml) => {
    const editor = createEditor({nodes});
    return {
        editor,
        editorState: populateEditor({
            editor,
            initialHtml
        })
    };
};

Then use it like this:

-    let sponsorLabelHtmlEditor = null;
-    let sponsorLabelHtmlEditorInitialState = null;
-    
-    if (args.hasSponsorLabel) {
-        sponsorLabelHtmlEditor = createEditor({nodes: BASIC_NODES});
-        sponsorLabelHtmlEditorInitialState = populateEditor({
-            editor: sponsorLabelHtmlEditor, 
-            initialHtml: 'Sponsored'
-        });
-    }
+    const {
+        editor: sponsorLabelHtmlEditor,
+        editorState: sponsorLabelHtmlEditorInitialState
+    } = args.hasSponsorLabel
+        ? initializeEditor(BASIC_NODES, args.sponsorLabelText || 'Sponsored')
+        : { editor: null, editorState: null };

99-127: Consider adding more story variations.

While the current stories cover basic empty and populated states, consider adding stories that test edge cases:

  1. Very long sponsor labels
  2. Different button colors with various background colors
  3. Different layouts with and without sponsor labels

Example additional story:

export const LongSponsorLabel = Template.bind({});
LongSponsorLabel.args = {
    ...Populated.args,
    sponsorLabelText: 'This is a very long sponsor label that tests text wrapping'
};
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 03fd5d7 and bd16bfd.

📒 Files selected for processing (1)
  • packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1
🔇 Additional comments (2)
packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx (2)

5-6: LGTM! Component renaming aligns with standardization goals.

The renaming from CtaCard to CallToActionCard follows a more descriptive naming convention, making the code more maintainable and self-documenting.


21-22: LGTM! Story configuration updated consistently.

The story title and component reference have been updated to match the new component name, maintaining consistency throughout the codebase.

@sanne-san sanne-san merged commit bffca2d into main Feb 17, 2025
2 checks passed
@sanne-san sanne-san deleted the ctacard-storybook branch February 17, 2025 11:13
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