fix: the onOpenChange event for the modal component does not work as expected

[anncwb]

Description

fixed #4413

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Enhanced CSS processing with a modern compiler for improved compatibility and performance.
  • Improved responsiveness of the drawer and modal components by reintroducing event handling for state changes.

• Bug Fixes

  • Restored functionality for handling open state changes in both drawer and modal components, ensuring that relevant callbacks are executed correctly.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c81c179

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The pull request introduces significant updates in the configuration and functionality of the useVbenModal and useVbenDrawer components. A new api property is added to the CSS options configuration, enhancing the build process. Additionally, the event handling for the onOpenChange method in both modal and drawer components has been reactivated, ensuring that external handlers are triggered appropriately when the state changes.

Changes

File Path	Change Summary
internal/vite-config/src/config/application.ts	Added api: 'modern-compiler' to the configuration object in createCssOptions function.
packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts	Reactivated the onOpenChange event handler in useVbenDrawer, ensuring external handlers are called.
packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts	Reactivated the onOpenChange event handler in useVbenModal, ensuring external handlers are called.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure external onOpenChange methods are triggered (#[4413])	✅

Possibly related PRs

• fix: when the form is opened repeatedly, the state is unexpectedly stroyed #4406: Modifies the onOpenChange method of the modal to ensure form submission logic is re-initialized when the modal is displayed.

Suggested reviewers

• vince292007
• anncwb

Poem

In the code where rabbits play,
New features hop in, bright as day.
Drawers open, modals too,
With handlers ready, all in view.
Modern tools, we cheer and sway! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c22825 and c81c179.

Files selected for processing (3)

• internal/vite-config/src/config/application.ts (1 hunks)
• packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (1 hunks)
• packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (1 hunks)

Additional comments not posted (3)

packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (1)

57-60: LGTM! The code changes effectively address the bug fix.

The updated code segment assigns a new function to mergedOptions.onOpenChange, which calls the onOpenChange handlers from both options and injectData.options when the drawer's open state changes. This ensures that both the internal and external onOpenChange events are triggered, fixing the bug where the external method was not being called when both internal and external settings were applied simultaneously.

The changes are focused, follow the existing coding style, and improve the responsiveness and consistency of the UI component by properly communicating the drawer's open state changes to all relevant handlers.

packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (1)

61-64: LGTM!

The changes correctly reinstate the onOpenChange event handling logic, ensuring that both internal and external callbacks are invoked when the modal's open state changes. This fixes the bug described in issue #4413, where the external method fails to trigger when both internal and external settings for the onOpenChange event are configured.

The code segment now correctly invokes the onOpenChange callbacks from both the options and injectData.options objects, passing the isOpen boolean parameter to them. This ensures that any external listeners are notified when the modal opens or closes.

The changes align with the PR objectives and do not introduce any new issues or side effects.

internal/vite-config/src/config/application.ts (1)

115-115: LGTM! The addition of the api property with the value 'modern-compiler' is a good enhancement.

Using a modern compiler for processing SCSS can offer several benefits:

• Improved compatibility with newer SCSS features and syntax.
• Better performance during the compilation process.
• Enhanced error reporting and debugging capabilities.

This change aligns with the best practices of leveraging contemporary tooling in the build process to optimize the development workflow and the resulting application.

---

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>, 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 generate interesting stats about this repository and render them as a table.
  -- @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 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.