Skip to content

[Autocomplete] Avoid destroying on disconnect #1219

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.

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
merged 1 commit into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions src/Autocomplete/assets/dist/controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,28 @@ class default_1 extends Controller {
}
disconnect() {
this.stopMutationObserver();
let currentSelectedValues = [];
if (this.selectElement) {
if (this.selectElement.multiple) {
currentSelectedValues = Array.from(this.selectElement.options)
.filter((option) => option.selected)
.map((option) => option.value);
}
else {
currentSelectedValues = [this.selectElement.value];
}
}
this.tomSelect.destroy();
if (this.selectElement) {
if (this.selectElement.multiple) {
Array.from(this.selectElement.options).forEach((option) => {
option.selected = currentSelectedValues.includes(option.value);
});
}
else {
this.selectElement.value = currentSelectedValues[0];
}
}
}
getMaxOptions() {
return this.selectElement ? this.selectElement.options.length : 50;
Expand Down
28 changes: 28 additions & 0 deletions src/Autocomplete/assets/src/controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,35 @@ export default class extends Controller {

disconnect() {
this.stopMutationObserver();

// TomSelect.destroy() resets the element to its original HTML. This
// causes the selected value to be lost. We store it.
let currentSelectedValues: string[] = [];
if (this.selectElement) {
if (this.selectElement.multiple) {
// For multiple selects, store the array of selected values
currentSelectedValues = Array.from(this.selectElement.options)
.filter((option) => option.selected)
.map((option) => option.value);
} else {
// For single select, store the single value
currentSelectedValues = [this.selectElement.value];
}
}

this.tomSelect.destroy();

if (this.selectElement) {
if (this.selectElement.multiple) {
// Restore selections for multiple selects
Array.from(this.selectElement.options).forEach((option) => {
option.selected = currentSelectedValues.includes(option.value);
});
} else {
// Restore selection for single select
this.selectElement.value = currentSelectedValues[0];
}
}
}

#getCommonConfig(): Partial<TomSettings> {
Expand Down
49 changes: 49 additions & 0 deletions src/Autocomplete/assets/test/controller.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -726,4 +726,53 @@ describe('AutocompleteController', () => {
expect(fetchMock.requests()[0].url).toEqual('/path/to/autocomplete?query=');
expect(fetchMock.requests()[1].url).toEqual('/path/to/autocomplete?query=foo');
});

it('preserves the selected value and HTML with disconnect on single select', async () => {
const { container, tomSelect } = await startAutocompleteTest(`
<select data-testid="main-element" data-controller="autocomplete">
<option value="">Select a dog</option>
<option value="1">dog1</option>
<option value="2">dog2</option>
<option value="3">dog3</option>
</select>
`);

tomSelect.addItem('2');

const selectElement = getByTestId(container, 'main-element') as HTMLSelectElement;
// trigger the disconnect
selectElement.removeAttribute('data-controller');
await waitFor(() => {
expect(selectElement.className).not.toContain('tomselected');
});
expect(selectElement.value).toBe('2');
});

it('preserves the selected value and HTML with disconnect on multiple select', async () => {
const { container, tomSelect } = await startAutocompleteTest(`
<select multiple data-testid="main-element" data-controller="autocomplete">
<option value="">Select a dog</option>
<option value="1">dog1</option>
<option value="2">dog2</option>
<option value="3">dog3</option>
</select>
`);

tomSelect.addItem('2');
tomSelect.addItem('3');

const getSelectedValues = () => {
return Array.from(selectElement.selectedOptions).map((option) => option.value).sort();
}

const selectElement = getByTestId(container, 'main-element') as HTMLSelectElement;
expect(getSelectedValues()).toEqual(['2', '3']);

// trigger the disconnect
selectElement.removeAttribute('data-controller');
await waitFor(() => {
expect(selectElement.className).not.toContain('tomselected');
});
expect(getSelectedValues()).toEqual(['2', '3']);
});
});