Skip to content

[6.x] Improve Combobox performance #12499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonvarga merged 7 commits into from
Sep 19, 2025
Merged

[6.x] Improve Combobox performance #12499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b6d9f5
Add `overflow-y-scroll` to combobox contents
duncanmcclean Sep 18, 2025
7f092b4
Merge branch 'master' into combobox-scrolling
duncanmcclean Sep 19, 2025
68c68a4
Implement ComboboxVirtualizer
duncanmcclean Sep 19, 2025
1971548
Prevent options from jiggling about when icon loads in
duncanmcclean Sep 19, 2025
98ca31d
Mock the ComboboxVirtualizer in tests
duncanmcclean Sep 19, 2025
15a8ff2
simplify
duncanmcclean Sep 19, 2025
6319d79
imports
duncanmcclean Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 40 additions & 20 deletions packages/ui/src/Combobox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
<script setup>
import { cva } from 'cva';
import { ComboboxAnchor, ComboboxContent, ComboboxEmpty, ComboboxInput, ComboboxItem, ComboboxRoot, ComboboxTrigger, ComboboxPortal, ComboboxViewport, FocusScope } from 'reka-ui';
import {
ComboboxAnchor,
ComboboxContent,
ComboboxEmpty,
ComboboxInput,
ComboboxItem,
ComboboxRoot,
ComboboxTrigger,
ComboboxPortal,
ComboboxViewport,
ComboboxVirtualizer,
FocusScope
} from 'reka-ui';
import { computed, nextTick, ref, useAttrs, useTemplateRef, watch } from 'vue';
import Button from './Button/Button.vue';
import Icon from './Icon/Icon.vue';
Expand Down Expand Up @@ -319,7 +331,7 @@ defineExpose({
:class="[
'shadow-ui-sm z-100 rounded-lg border border-gray-200 bg-white p-2 dark:border-white/10 dark:bg-gray-800',
'max-h-[var(--reka-combobox-content-available-height)] w-[var(--reka-combobox-trigger-width)] min-w-fit',
'[&_[data-reka-combobox-viewport]]:grid [&_[data-reka-combobox-viewport]]:gap-1'
'overflow-hidden'
]"
@escape-key-down="nextTick(() => $refs.trigger.$el.focus())"
data-ui-combobox-content
Expand All @@ -333,34 +345,42 @@ defineExpose({
event.preventDefault();
}"
>
<ComboboxViewport>
<ComboboxViewport class="max-h-[700px] overflow-y-auto">
<ComboboxEmpty class="p-2 text-sm" data-ui-combobox-empty>
<slot name="no-options" v-bind="{ searchQuery }">
{{ __('No options available.') }}
</slot>
</ComboboxEmpty>

<ComboboxItem
<ComboboxVirtualizer
v-if="filteredOptions"
v-for="(option, index) in filteredOptions"
:key="index + JSON.stringify(modelValue)"
:value="getOptionValue(option)"
:text-value="getOptionLabel(option)"
:disabled="isOptionDisabled(option)"
:class="itemClasses({ size: size, selected: isSelected(option) })"
as="button"
:data-ui-combobox-item="getOptionValue(option)"
@select="() => {
v-slot="{ option, virtualItem }"
:options="filteredOptions"
:estimate-size="37"
:text-content="(opt) => getOptionLabel(opt)"
>
<div class="py-1 w-full">
<ComboboxItem
:key="virtualItem.index + JSON.stringify(modelValue)"
:value="getOptionValue(option)"
:text-value="getOptionLabel(option)"
:disabled="isOptionDisabled(option)"
:class="itemClasses({ size: size, selected: isSelected(option) })"
as="button"
:data-ui-combobox-item="getOptionValue(option)"
@select="() => {
dropdownOpen = !closeOnSelect;
if (closeOnSelect) $refs.trigger.$el.focus();
}"
>
<slot name="option" v-bind="option">
<img v-if="option.image" :src="option.image" class="size-5 rounded-full" />
<span v-if="labelHtml" v-html="getOptionLabel(option)" />
<span v-else>{{ __(getOptionLabel(option)) }}</span>
</slot>
</ComboboxItem>
>
<slot name="option" v-bind="option">
<img v-if="option.image" :src="option.image" class="size-5 rounded-full" />
<span v-if="labelHtml" v-html="getOptionLabel(option)" />
<span v-else>{{ __(getOptionLabel(option)) }}</span>
</slot>
</ComboboxItem>
</div>
</ComboboxVirtualizer>
</ComboboxViewport>
</FocusScope>
</ComboboxContent>
Expand Down
6 changes: 4 additions & 2 deletions resources/js/components/fieldtypes/IconFieldtype.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,10 @@ request();
>
<template #option="option">
<div class="flex items-center">
<Icon v-if="!option.html" :name="option.label" class="size-4" />
<div v-if="option.html" v-html="option.html" class="size-4" />
<div class="size-4">
<Icon v-if="!option.html" :name="option.label" class="size-4" />
<div v-if="option.html" v-html="option.html" class="size-4" />
</div>
<span class="ms-3 truncate">
{{ __(option.label) }}
</span>
Expand Down
31 changes: 27 additions & 4 deletions resources/js/tests/components/ui/Combobox.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,39 @@ import { expect, test, beforeEach, vi, describe } from 'vitest';
import { mount } from '@vue/test-utils';
import { Combobox } from '@/components/ui';

// Mock the ComboboxVirtualizer to render options without virtualization.
// This is necessary because virtualization relies on browser APIs which aren't available in our tests.
vi.mock('reka-ui', async () => {
const actual = await vi.importActual('reka-ui');
return {
...actual,
ComboboxVirtualizer: {
name: 'ComboboxVirtualizer',
props: ['options', 'overscan', 'estimateSize', 'textContent'],
setup(props, { slots }) {
// Instead of virtualization, render all items directly
return () => {
const items = props.options.map((option, index) => {
return slots.default({
option,
virtualItem: { index, key: index, start: index * 37 },
virtualizer: { scrollToIndex: () => {} }
});
});
return items;
};
}
}
};
});

beforeEach(() => {
Element.prototype.scrollIntoView = vi.fn();

global.__ = (key) => key;

global.CSS = {
escape: (str) => {
// Simple implementation that handles most cases
return str.replace(/[!"#$%&'()*+,.\/:;<=>?@[\\\]^`{|}~]/g, '\\$&');
}
escape: (str) => str.replace(/[!"#$%&'()*+,.\/:;<=>?@[\\\]^`{|}~]/g, '\\$&')
};

document.body.innerHTML = '';
Expand Down
Loading