Improved visibility indicator handling

[ronaldlangeveld]

ref https://linear.app/ghost/issue/PLG-373/open-visibility-tab-when-clicking-icon

Previously, clicking the visibility indicator icon left of the CTA card opened the settings panel on the design tab. This refactor ensures it correctly opens the visibility tab instead.

• Refactored visibility settings toggle logic from useVisibilitySettingsToggle hook into KoenigBehaviourPlugin
• Added TOGGLE_CARD_VISIBILITY_COMMAND to handle visibility indicator clicks
• Simplified KoenigCardWrapper by removing direct toggle logic and using command dispatch
• Updated CallToActionCard and HtmlNodeComponent to use new visibility toggle approach
• Removed redundant useVisibilitySettingsToggle hook file
• Enhanced test coverage for visibility indicator interactions
• Fixed visibility settings persistence across card switches

[coderabbitai]

Walkthrough

This pull request refactors and enhances the visibility handling logic within several card components. The custom hook useVisibilitySettingsToggle has been removed, and its functionality is now replaced with a direct command dispatch through a newly added SHOW_CARD_VISIBILITY_SETTINGS_COMMAND in the KoenigBehaviourPlugin. In both the KoenigCardWrapper and HtmlNodeComponent, a new callback function using React.useCallback handles the toggle action by dispatching the command with the current node key. Additionally, the CallToActionCard component now accepts a new showVisibilitySettings prop to determine the default settings tab, and the CallToActionNodeComponent has been updated to pass the visibility state from context. The PR also includes updates and new test cases in the end-to-end test suites, including edge case scenarios to verify proper visibility resetting when switching between different card types.

Possibly related PRs

• Added visibility toggle to html card toolbar #1491: This PR involves modifications to the visibility settings management for card components, specifically through the introduction of new functions and context hooks that handle visibility toggling.
• Moved HTML card web visibility settings to beta #1435: This PR focuses on visibility settings, specifically altering the logic for checking visibility features in the KoenigCardWrapper component, which is relevant to the changes made in this PR.
• Extracted HTML card visibility rendering to utility function #1433: This PR focuses on visibility handling for HTML nodes, specifically through the renderHtmlNode function and the new renderWithVisibility utility, which aligns with the changes in this PR.

Suggested reviewers

• kevinansfield

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/content-visibility.test.js

Oops! Something went wrong! :(

ESLint: 8.57.1

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.

---

📜 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 277e111 and 70934d0.

📒 Files selected for processing (1)

• packages/koenig-lexical/test/e2e/content-visibility.test.js (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/koenig-lexical/test/e2e/content-visibility.test.js

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Node 22.13.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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[Copilot]

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.