Restore select to initial value

[pieecia]

hey,

I checked the live preview in the documentation, the button to reset the form (button type="reset") causes select not to keep the default value, select is empty

this feature works fine in version 9.0.1, the bug has appeared since version 9.1.0

how to reproduce the issue:

• visit https://choices-js.github.io/Choices/
• change select to a random value
• click the "reset" button

[marcelaerts]

Is there a solution for this issue?

[yanmorinokamca]

We experienced the same problem. We call form.reset() between each page load.
Seems like form.reset() call Choices._onFormReset -> resetTo with _initialState.
_initialState doesn't contains the preset values from constructor.
And the rootReducer will clone the action state in "RESET_TO".

My guess is that _initialState should contains the data of _preset* at line 297 (before the bind calls)

[masiorama]

I am experiencing the same issue. Did anybody find a solution?

[masiorama]

No feedback on this? There is at least another one issue about this problem, with no answer #1053

[masiorama]

@yanmorinokamca I followed you analysis looking at the code and I guess you got it right... did you find any solution?

[masiorama]

As a temporary workaround in my application I managed to intercept reset event on the form and then repopulate all the options by hand:

document.getElementById('formId').select.addEventListener('reset', (ev) => {
    choices.setChoices(async () => {
        return this.options.map(({ value, label }) => ({
            value,
            label,
            selected: false,
        }));
    });
})

This should be unnecessary but at least my app does work. I hope this will be fixed at some point.

[yanmorinokamca]

@yanmorinokamca I followed you analysis looking at the code and I guess you got it right... did you find any solution?

Hi, we didn't have time to debug the library, so we replaced the form.reset() with a custom reset of each field.

[masiorama]

@yanmorinokamca I followed you analysis looking at the code and I guess you got it right... did you find any solution?

Hi, we didn't have time to debug the library, so we replaced the form.reset() with a custom reset of each field.

I see. Unfortunately I cannot explicitly reset each field because it is a component that has to handle different forms, with many different fields. Thanks for your reply.

[Sogl]

@masiorama I tried your code and saw that the event is not triggered:

const choicesTagsObj = new Choices('#choices-tags', {
            maxItemCount: 4,
            removeItemButton: true,
            allowHTML: false,
            position: 'bottom',
            itemSelectText: 'Push',
            maxItemText: (maxItemCount) => {
                return `Only ${maxItemCount} can be selected`;
            },
        });

document.getElementById('choices-tags').addEventListener('reset', (ev) => {
     console.log('reset');
})

what's the problem?

After some minutes

Some points:

1. Reset event works only for a form, not for a select element.
2. Choices deletes options structure from a select, so you need to copy it into var before create new Choices element.

Working code:

let choicesTags = document.getElementById("choices-tags");
//copy full select node with values
let choicesTagsBefore = choicesTags.cloneNode(true);
//convert to array
choicesTagsBefore = Array.from(choicesTagsBefore.options); 

const choicesTagsObj = new Choices(choicesTags, {
    maxItemCount: 4,
    removeItemButton: true,
    allowHTML: false,
    position: 'bottom',
    itemSelectText: 'Push',
    maxItemText: (maxItemCount) => {
        return `Only ${maxItemCount} can be selected`;
    },
});

//fill again after form reset (Choices.js bug workaround)
document.getElementById('therapy-form').addEventListener('reset', (ev) => {
    // console.log('reset');
    choicesTagsObj.setChoices(async () => {
        return choicesTagsBefore.map(({ value, label }) => ({
            value,
            label,
            selected: false,
        }));
    });
})

[tagliala]

this feature works fine in version 9.0.1, the bug has appeared since version 9.1.0

Bisected to: 68313da

(which is the conversion to TypeScript 🥲)

---

Tracked down to

-    // Set initial state (We need to clone the state because some reducers
-    // modify the inner objects properties in the state) 🤢
-    this._initialState = cloneObject(this._store.state);

after

Choices/src/scripts/choices.ts

Line 343 in 5dbea28

this._createStructure();

[Mopster]

I've encountered this issue now and hoping to see this fixed soon.
I tried the above temporary solution, but I lose my option groups.

[Xon]

Implemented as part of #1166