Preserve selected items by default in clearChoices

Author: Xon

README.md

@@ -1168,11 +1168,13 @@ example.setChoices(
 );
 ```
 
-### clearChoices();
+### clearChoices(clearOptions: boolean = true, clearItems: boolean = false);
 
 **Input types affected:** `select-one`, `select-multiple`
 
 **Usage:** Clear all choices from select including any selected items. Does **not** reset the search state.
+- `clearOptions` If true, clears the backing options from the `<select>` element
+- `clearItems` If false, preserves selected items instead of clearing them
 
 ### getValue(valueOnly?: boolean): string[] | EventChoice[] | EventChoice | string;
 

src/scripts/choices.ts

@@ -727,15 +727,9 @@ class Choices {
       if (clearSearchFlag) {
         this._isSearching = false;
       }
-      const items = {};
-      if (!replaceItems) {
-        this._store.items.forEach((item) => {
-          items[item.value] = item;
-        });
-      }
       // Clear choices if needed
       if (replaceChoices) {
-        this.clearChoices();
+        this.clearChoices(true, replaceItems);
       }
       const isDefaultValue = value === 'value';
       const isDefaultLabel = label === 'label';
@@ -761,9 +755,6 @@ class Choices {
             } as InputChoice;
           }
           const choiceFull = mapInputToChoice<InputChoice>(choice, false);
-          if (!replaceItems && choiceFull.value in items) {
-            choiceFull.selected = true;
-          }
           this._addChoice(choiceFull);
           if (choiceFull.placeholder && !this._hasNonChoicePlaceholder) {
             this._placeholderValue = unwrapStringForEscaped(choiceFull.label);
@@ -863,23 +854,35 @@ class Choices {
     return this;
   }
 
-  clearChoices(clearOptions: boolean = true): this {
+  clearChoices(clearOptions: boolean = true, clearItems: boolean = false): this {
     if (clearOptions) {
-      this.passedElement.element.replaceChildren('');
+      if (clearItems) {
+        this.passedElement.element.replaceChildren('');
+      } else {
+        this.passedElement.element.querySelectorAll(':not([selected])').forEach((el): void => {
+          el.remove();
+        });
+      }
     }
     this.itemList.element.replaceChildren('');
     this.choiceList.element.replaceChildren('');
     this._clearNotice();
-    this._store.reset();
-
+    this._store.withTxn(() => {
+      const items = clearItems ? [] : this._store.items;
+      this._store.reset();
+      items.forEach((item: ChoiceFull): void => {
+        this._store.dispatch(addChoice(item));
+        this._store.dispatch(addItem(item));
+      });
+    });
     // @todo integrate with Store
     this._searcher.reset();
 
     return this;
   }
 
   clearStore(clearOptions: boolean = true): this {
-    this.clearChoices(clearOptions);
+    this.clearChoices(clearOptions, true);
     this._stopSearch();
     this._lastAddedChoiceId = 0;
     this._lastAddedGroupId = 0;