feat(flowchart): Add the property configuration to display the hand-shaped mouse function

[zzcr]

feat(flowchart): 增加属性配置是否显示手型鼠标的功能，并修复sites添加"type": "module" 修改demo会导致lint-staged报错问题

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Added support for customizing cursor pointer behavior on flowchart nodes based on their state, allowing dynamic control over when the pointer cursor is shown.

• Style

  • Cursor styling on flowchart node icons now adapts according to node state, improving visual feedback for completed and non-completed nodes.

[coderabbitai]

Walkthrough

The changes introduce a customizable function, cursorPointerFn, to control the cursor style on flowchart nodes. The renderOuter function is updated to pass this function to the Node component, allowing dynamic determination of whether the cursor should appear as a pointer based on the node's state. The Node component is modified to accept this new prop and use its result to conditionally apply the cursor-pointer CSS class, replacing the previous static logic with a function-driven approach.

Changes

File(s)	Change Summary
examples/sites/demos/mobile-first/app/flowchart/dot-horizon.vue	Updated renderOuter to pass cursorPointerFn to Node, enabling dynamic cursor pointer logic.
packages/vue/src/flowchart/src/node.vue	Added cursorPointerFn prop; logic for cursor-pointer class now uses this function if provided.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Flowchart (dot-horizon.vue)
    participant Node Component

    User->>Flowchart (dot-horizon.vue): Interacts with flowchart
    Flowchart (dot-horizon.vue)->>Node Component: Passes node, config, cursorPointerFn
    Node Component->>Node Component: Calls cursorPointerFn(state)
    Node Component-->>User: Applies/removes cursor-pointer class based on function result

Loading

Poem

In fields of charts where nodes align,
A clever rabbit tweaks the sign—
The cursor now, with custom flair,
Points only when it should be there.
With function passed from code above,
The flowchart hops with logic love!
🐇✨

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/vue/src/flowchart/src/node.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/mobile-first/app/flowchart/dot-horizon.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, 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 666bb0f and f4695fd.

📒 Files selected for processing (2)

• examples/sites/demos/mobile-first/app/flowchart/dot-horizon.vue (1 hunks)
• packages/vue/src/flowchart/src/node.vue (2 hunks)

🔇 Additional comments (3)

packages/vue/src/flowchart/src/node.vue (2)

19-19: Dynamic cursor control implemented correctly

The code now allows for conditional rendering of the pointer cursor by using the cursorPointerFn prop to determine whether the cursor-pointer class should be applied. The fallback to true ensures backward compatibility.

---

103-103: Prop definition added appropriately

The cursorPointerFn prop has been correctly added to the component's props list.

examples/sites/demos/mobile-first/app/flowchart/dot-horizon.vue (1)

92-104: Implementation example demonstrates the feature well

The implementation of cursorPointerFn in the demo provides a clear example of how to use this new property. The function correctly implements the business logic to not display the pointer cursor for completed nodes while showing it for all other node states.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 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 generate sequence diagram to generate a sequence diagram of the changes in this 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.