Content Helper: Fix non-dismissible Notices

[acicovic]

Description

In the PCH, we had a couple of Notices that could not be dismissed (clicking on the x wouldn't close them). This PR fixes this.

Motivation and context

Make dismissible Notices dismissible, avoid quirky/unexpected behavior.

How has this been tested?

Manual testing.

Summary by CodeRabbit

• Enhancements
  • Improved error handling with a new removal feature in the title suggestions panel.
  • Enhanced user experience in the excerpt generator by adding a removal option for error messages.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates involve restructuring the Notice component within the TitleSuggestionsPanel and ExcerptPanel. Specifically, an onRemove event handler was added to both instances to clear the error state, and the order of the props within the Notice component was adjusted for clarity and maintainability. These changes enhance the error handling capabilities of the respective panels.

Changes

File Path	Change Summary
src/.../editor-sidebar/title-suggestions/...	Added onRemove handler to clear the error state and reordered props in the Notice component.
src/.../excerpt-generator/components/...	Added onRemove handler to the Notice component and adjusted the order of the props for clarity.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 58a1d92 and a999b14.

Files ignored due to path filters (4)

• build/content-helper/editor-sidebar.asset.php is excluded by !build/**
• build/content-helper/editor-sidebar.js is excluded by !build/**
• build/content-helper/excerpt-generator.asset.php is excluded by !build/**
• build/content-helper/excerpt-generator.js is excluded by !build/**

Files selected for processing (2)

• src/content-helper/editor-sidebar/title-suggestions/component.tsx (1 hunks)
• src/content-helper/excerpt-generator/components/excerpt-panel.tsx (1 hunks)

Additional context used

Path-based instructions (2)

src/content-helper/editor-sidebar/title-suggestions/component.tsx (1)

Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:

• Review the code to ensure it is well-structured and adheres to best practices.
• Verify compliance with WordPress coding standards.
• Ensure the code is well-documented.
• Check for security vulnerabilities and confirm the code is secure.
• Optimize the code for performance, removing any unnecessary elements.
• Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
• Ensure each line comment concludes with a period.
• Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
• Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."

src/content-helper/excerpt-generator/components/excerpt-panel.tsx (1)

Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:

• Review the code to ensure it is well-structured and adheres to best practices.
• Verify compliance with WordPress coding standards.
• Ensure the code is well-documented.
• Check for security vulnerabilities and confirm the code is secure.
• Optimize the code for performance, removing any unnecessary elements.
• Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
• Ensure each line comment concludes with a period.
• Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
• Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."

Additional comments not posted (2)

src/content-helper/editor-sidebar/title-suggestions/component.tsx (1)

249-253: Ensure consistent error handling and user feedback.

The Notice component has been modified to include an onRemove handler which resets the error state when the notice is dismissed. This is a good practice as it enhances user experience by allowing them to clear errors actively. However, ensure that this change is reflected in all error handling components to maintain consistency across the application.

src/content-helper/excerpt-generator/components/excerpt-panel.tsx (1)

240-241: Good addition of error dismissal functionality.

Adding an onRemove handler to the Notice component allows users to dismiss error messages, which can improve the user interface by not forcing users to reload the page or navigate away to clear errors. This aligns with the PR's objective to fix non-dismissible notices.

[vaurdan]

Looks good!