fix(icon): [icon] The icon search algorithm is optimized. #2563
Conversation
WalkthroughThe changes in this pull request primarily involve modifications to two Vue components: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 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 (
|
github-actions
bot
added
bug
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (3)
examples/sites/demos/pc/app/icon/list.vue (3)
7-15: LGTM! Good choice using v-show for conditional rendering.The template changes look good. Using
v-showinstead ofv-ifis a good choice here as it's more performant for frequently toggled elements during search operations.Consider adding virtual scrolling for better performance with large icon sets:
- <div class="svgs-wrapper"> + <tiny-virtual-list + class="svgs-wrapper" + :data-source="Object.entries(iconGroupsMap)" + :item-height="80" + >
45-46: LGTM! Consider adding JSDoc for better type documentation.The data properties are properly initialized. The reactive state setup looks good.
Add type documentation for better maintainability:
+/** + * @typedef {Object.<string, string[]>} IconGroupsMap + */ return { - searchName: '', - iconGroupsMap: iconGroups + /** @type {string} Search input value */ + searchName: '', + /** @type {IconGroupsMap} Mapping of group names to icon names */ + iconGroupsMap: iconGroups }
12-15: Enhance accessibility for icon selection.The icon selection functionality should be more accessible to keyboard users and screen readers.
Add proper ARIA attributes and keyboard navigation:
- <div class="svgs-item" @click="click(name)"> + <div + class="svgs-item" + @click="click(name)" + @keydown.enter="click(name)" + role="button" + tabindex="0" + :aria-label="'Copy icon name: ' + name" + >
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
examples/sites/demos/pc/app/icon/list-composition-api.vue(4 hunks)examples/sites/demos/pc/app/icon/list.vue(3 hunks)
🔇 Additional comments (1)
examples/sites/demos/pc/app/icon/list-composition-api.vue (1)
7-12: LGTM! Template optimizations look good.
The changes improve performance by:
- Using v-show for conditional rendering of group names
- Proper key binding on template v-for
- Correct reactive binding with iconGroupsMap
| @@ -41,6 +36,7 @@ Object.keys(iconGroups).forEach((k) => { | |||
| }) | |||
|
|
|||
| const searchName = ref('') | |||
| let iconGroupsMap = reactive(iconGroups) | |||
There was a problem hiding this comment.
Critical: Fix reactive state management
The current implementation has a reactivity issue. Direct reassignment to a reactive object (lines 52, 67) will break Vue's reactivity system.
Refactor the reactive state management:
-let iconGroupsMap = reactive(iconGroups)
+const iconGroupsMap = ref(iconGroups)
// In watch handler
-iconGroupsMap = iconGroups
+iconGroupsMap.value = iconGroups
-iconGroupsMap = result
+iconGroupsMap.value = resultAlso applies to: 52-52, 67-67
| watch(searchName, (newVal) => { | ||
| const keyWord = (newVal || '').trim().toLowerCase() | ||
| if (keyWord === '') { | ||
| iconGroupsMap = iconGroups | ||
| } else { | ||
| const result = {} | ||
| for (let groupName in iconGroups) { | ||
| const nameList = iconGroups[groupName] | ||
| nameList.forEach((name) => { | ||
| if (name.toLowerCase().includes(keyWord)) { | ||
| if (!result[groupName]) { | ||
| result[groupName] = [name] | ||
| } else { | ||
| result[groupName] = [...result[groupName], name] | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| iconGroupsMap = result | ||
| } | ||
| }) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Optimize search algorithm performance
The current search implementation can be optimized:
- Unnecessary array spread operations
- Multiple iterations through groups
- Memory allocation for each search
Here's an optimized version:
watch(searchName, (newVal) => {
const keyWord = (newVal || '').trim().toLowerCase()
if (keyWord === '') {
- iconGroupsMap = iconGroups
+ iconGroupsMap.value = iconGroups
} else {
const result = {}
for (let groupName in iconGroups) {
- const nameList = iconGroups[groupName]
- nameList.forEach((name) => {
- if (name.toLowerCase().includes(keyWord)) {
- if (!result[groupName]) {
- result[groupName] = [name]
- } else {
- result[groupName] = [...result[groupName], name]
- }
- }
- })
+ const filteredList = iconGroups[groupName].filter(name =>
+ name.toLowerCase().includes(keyWord)
+ )
+ if (filteredList.length) {
+ result[groupName] = filteredList
+ }
}
- iconGroupsMap = result
+ iconGroupsMap.value = result
}
})This optimization:
- Uses filter() for cleaner array operations
- Reduces memory allocations
- Maintains the same functionality with better performance
📝 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(searchName, (newVal) => { | |
| const keyWord = (newVal || '').trim().toLowerCase() | |
| if (keyWord === '') { | |
| iconGroupsMap = iconGroups | |
| } else { | |
| const result = {} | |
| for (let groupName in iconGroups) { | |
| const nameList = iconGroups[groupName] | |
| nameList.forEach((name) => { | |
| if (name.toLowerCase().includes(keyWord)) { | |
| if (!result[groupName]) { | |
| result[groupName] = [name] | |
| } else { | |
| result[groupName] = [...result[groupName], name] | |
| } | |
| } | |
| }) | |
| } | |
| iconGroupsMap = result | |
| } | |
| }) | |
| watch(searchName, (newVal) => { | |
| const keyWord = (newVal || '').trim().toLowerCase() | |
| if (keyWord === '') { | |
| iconGroupsMap.value = iconGroups | |
| } else { | |
| const result = {} | |
| for (let groupName in iconGroups) { | |
| const filteredList = iconGroups[groupName].filter(name => | |
| name.toLowerCase().includes(keyWord) | |
| ) | |
| if (filteredList.length) { | |
| result[groupName] = filteredList | |
| } | |
| } | |
| iconGroupsMap.value = result | |
| } | |
| }) |
| watch: { | ||
| searchName(newVal) { | ||
| const keyWord = (newVal || '').trim().toLowerCase() | ||
| if (keyWord === '') { | ||
| this.iconGroupsMap = iconGroups | ||
| } else { | ||
| const result = {} | ||
| for (let groupName in iconGroups) { | ||
| const nameList = iconGroups[groupName] | ||
| nameList.forEach((name) => { | ||
| if (name.toLowerCase().includes(keyWord)) { | ||
| if (!result[groupName]) { | ||
| result[groupName] = [name] | ||
| } else { | ||
| result[groupName] = [...result[groupName], name] | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| this.iconGroupsMap = result | ||
| } | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Optimize search performance and memory usage.
While the search implementation is functional, there are several opportunities for optimization:
- The current implementation creates new arrays on each search
- The filtering logic could be more efficient
Consider these optimizations:
watch: {
searchName(newVal) {
const keyWord = (newVal || '').trim().toLowerCase()
if (keyWord === '') {
this.iconGroupsMap = iconGroups
} else {
const result = {}
- for (let groupName in iconGroups) {
- const nameList = iconGroups[groupName]
- nameList.forEach((name) => {
- if (name.toLowerCase().includes(keyWord)) {
- if (!result[groupName]) {
- result[groupName] = [name]
- } else {
- result[groupName] = [...result[groupName], name]
- }
- }
- })
+ for (const [groupName, nameList] of Object.entries(iconGroups)) {
+ const filteredNames = nameList.filter(name =>
+ name.toLowerCase().includes(keyWord)
+ )
+ if (filteredNames.length) {
+ result[groupName] = filteredNames
+ }
}
this.iconGroupsMap = result
}
}
}This optimization:
- Reduces memory allocations
- Uses more efficient array operations
- Maintains the same functionality with better performance
📝 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: { | |
| searchName(newVal) { | |
| const keyWord = (newVal || '').trim().toLowerCase() | |
| if (keyWord === '') { | |
| this.iconGroupsMap = iconGroups | |
| } else { | |
| const result = {} | |
| for (let groupName in iconGroups) { | |
| const nameList = iconGroups[groupName] | |
| nameList.forEach((name) => { | |
| if (name.toLowerCase().includes(keyWord)) { | |
| if (!result[groupName]) { | |
| result[groupName] = [name] | |
| } else { | |
| result[groupName] = [...result[groupName], name] | |
| } | |
| } | |
| }) | |
| } | |
| this.iconGroupsMap = result | |
| } | |
| } | |
| watch: { | |
| searchName(newVal) { | |
| const keyWord = (newVal || '').trim().toLowerCase() | |
| if (keyWord === '') { | |
| this.iconGroupsMap = iconGroups | |
| } else { | |
| const result = {} | |
| for (const [groupName, nameList] of Object.entries(iconGroups)) { | |
| const filteredNames = nameList.filter(name => | |
| name.toLowerCase().includes(keyWord) | |
| ) | |
| if (filteredNames.length) { | |
| result[groupName] = filteredNames | |
| } | |
| } | |
| this.iconGroupsMap = result | |
| } | |
| } |
chenxi-20
changed the title
| watch(searchName, (newVal) => { | ||
| const keyWord = (newVal || '').trim().toLowerCase() | ||
| if (keyWord === '') { | ||
| iconGroupsMap = iconGroups |
| @@ -49,6 +45,28 @@ function click(name) { | |||
| status: 'info' | |||
| }) | |||
| } | |||
|
|
|||
| watch(searchName, (newVal) => { | |||
There was a problem hiding this comment.
watch 必要性不大， 还没有模板中直接过滤显得直接。
| class="svgs-item" | ||
| @click="click(name)" | ||
| > | ||
| <template v-for="name in nameList" :key="name"> |
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
New Features
Improvements