fix(cascader): Fixes the issue where cascader components use asynchronous data in hover mode, but cannot accurately locate the selected item when binding value updates #3374
Conversation
WalkthroughThe update modifies the renderless cascader node logic to introduce reactive expansion behavior. The Changes
Poem
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
packages/renderless/src/cascader-node/vue.tsOops! 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: 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 detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
chenxi-20
force-pushed
the
fix/cascader-20250429
branch
from
aa77b53 to
3333e18
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🛑 Comments failed to post (1)
packages/renderless/src/cascader-node/vue.ts (1)
55-62: 💡 Verification agent
🧩 Analysis chain
Nice implementation of automatic expansion.
This watcher elegantly solves the issue where cascader components in hover mode with asynchronous data couldn't accurately locate selected items when binding value updates. By watching for changes to
checkedValueand triggering expansion when the current node's value is included, the component can now properly track selected items.A few considerations:
- Have you verified this works with both single-selection and multi-selection modes?
- Does this approach handle deeply nested cascader structures efficiently?
🏁 Script executed:
#!/bin/bash # Check if the component handles both single and multi selection modes grep -r "multi" --include="*.ts" --include="*.vue" packages/renderless/src/cascader*Length of output: 3427
🏁 Script executed:
#!/bin/bash # Locate and display relevant parts of cascader-node/vue.ts to inspect `checkedValue` grep -R "checkedValue" -n packages/renderless/src/cascader-node/vue.ts sed -n '1,200p' packages/renderless/src/cascader-node/vue.tsLength of output: 2896
🏁 Script executed:
#!/bin/bash # Display the initial state declaration in cascader-panel grep -R "const state = reactive" -n packages/renderless/src/cascader-panel/index.ts sed -n '1,200p' packages/renderless/src/cascader-panel/index.tsLength of output: 6197
🏁 Script executed:
#!/bin/bash # Inspect handleExpand implementation in cascader-node grep -R "export const handleExpand" -n packages/renderless/src/cascader-node/index.ts sed -n '1,200p' packages/renderless/src/cascader-node/index.tsLength of output: 2860
Watcher Behavior Verified for Single- and Multi-Select, Deep Nesting
I’ve confirmed that the cascader supports both modes via
state.config.multiplethroughout the codebase (e.g. incascader/index.ts,cascader-node/index.ts,cascader-panel/index.ts). Deeply nested trees are expanded byhandleExpand→parent.handleExpand→expandNodes, which recursively traverses path nodes.To make the watcher bullet-proof and performant at scale, consider normalizing
checkedValueonce per change and guarding against non-array values:• File:
packages/renderless/src/cascader-node/vue.ts
Update the watcher as follows:watch( - () => state.checkedValue, - (checkedValue) => { - if (checkedValue.includes(props.node.value)) { - api.handleExpand() - } - } + () => state.checkedValue, + (checkedValue) => { + // Normalize to array so includes() always works (handles single value, array, or other types) + const values = Array.isArray(checkedValue) ? checkedValue : [checkedValue] + if (values.includes(props.node.value)) { + api.handleExpand() + } + } )• Performance tip: if your app frequently handles large node trees or very long
checkedValuearrays, you could convertvaluesto aSetoutside the per-node watchers to achieve O(1) lookups.With these tweaks, the auto-expand logic remains correct in both selection modes and will scale more efficiently.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.watch( () => state.checkedValue, (checkedValue) => { // Normalize to array so includes() always works (handles single value, array, or other types) const values = Array.isArray(checkedValue) ? checkedValue : [checkedValue] if (values.includes(props.node.value)) { api.handleExpand() } } )
chenxi-20
changed the title
chenxi-20
changed the title
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit