allow array for multiselect .setValue() method (#1554)

bugy · afontcu · web-flow · commit 4d4a5f33c1d5 · 2020-05-22T21:57:10.000+10:00
* feat(wrapper.setvalue): allow array for multiselect .setValue() method enables Wrapper.setValue() method to accept array value for select elements (requires select to have an attribute 'multiple' or 'multiple="true"') fix #1505 * fix "missing property" error * Update test/specs/wrapper/setValue.spec.js Co-authored-by: Adrià Fontcuberta <afontcu@gmail.com> * Update test/specs/wrapper/setValue.spec.js Co-authored-by: Adrià Fontcuberta <afontcu@gmail.com> Co-authored-by: Adrià Fontcuberta <afontcu@gmail.com>
diff --git a/docs/api/wrapper/setValue.md b/docs/api/wrapper/setValue.md
@@ -19,6 +19,10 @@ textInput.setValue('some value')
 
 const select = wrapper.find('select')
 select.setValue('option value')
+
+// requires <select multiple>
+const multiselect = wrapper.find('select')
+multiselect.setValue(['value1', 'value3'])
 ```
 
 - **Note:**
diff --git a/docs/ja/api/wrapper/setValue.md b/docs/ja/api/wrapper/setValue.md
@@ -19,6 +19,10 @@ textInput.setValue('some value')
 
 const select = wrapper.find('select')
 select.setValue('option value')
+
+// requires <select multiple>
+const multiselect = wrapper.find('select')
+multiselect.setValue(['value1', 'value3'])
 ```
 
 - **&#27880;:**
diff --git a/docs/ru/api/wrapper/setValue.md b/docs/ru/api/wrapper/setValue.md
@@ -19,6 +19,10 @@ textInput.setValue('some value')
 
 const select = wrapper.find('select')
 select.setValue('option value')
+
+// &#1090;&#1088;&#1077;&#1073;&#1091;&#1077;&#1090; <select multiple>
+const multiselect = wrapper.find('select')
+multiselect.setValue(['value1', 'value3'])
 ```
 
 - **&#1055;&#1088;&#1080;&#1084;&#1077;&#1095;&#1072;&#1085;&#1080;&#1077;:**
diff --git a/docs/zh/api/wrapper/setValue.md b/docs/zh/api/wrapper/setValue.md
@@ -19,6 +19,10 @@ textInput.setValue('some value')
 
 const select = wrapper.find('select')
 select.setValue('option value')
+
+// requires <select multiple>
+const multiselect = wrapper.find('select')
+multiselect.setValue(['value1', 'value3'])
 ```
 
 - **&#27880;&#24847;&#65306;**
diff --git a/packages/test-utils/src/wrapper.js b/packages/test-utils/src/wrapper.js
@@ -744,27 +744,30 @@ export default class Wrapper implements BaseWrapper {
         `wrapper.setValue() cannot be called on a <input type="radio" /> ` +
           `element. Use wrapper.setChecked() instead`
       )
-    } else if (
-      tagName === 'INPUT' ||
-      tagName === 'TEXTAREA' ||
-      tagName === 'SELECT'
-    ) {
+    } else if (tagName === 'SELECT') {
+      if (Array.isArray(value)) {
+        // $FlowIgnore
+        const options = this.element.options
+        for (let i = 0; i < options.length; i++) {
+          const option = options[i]
+          option.selected = value.indexOf(option.value) >= 0
+        }
+      } else {
+        // $FlowIgnore
+        this.element.value = value
+      }
+
+      this.trigger('change')
+      return nextTick()
+    } else if (tagName === 'INPUT' || tagName === 'TEXTAREA') {
       // $FlowIgnore
       this.element.value = value
 
-      if (tagName === 'SELECT') {
-        this.trigger('change')
-      } else {
-        this.trigger('input')
-      }
+      this.trigger('input')
 
       // for v-model.lazy, we need to trigger a change event, too.
       // $FlowIgnore
-      if (
-        (tagName === 'INPUT' || tagName === 'TEXTAREA') &&
-        this.element._vModifiers &&
-        this.element._vModifiers.lazy
-      ) {
+      if (this.element._vModifiers && this.element._vModifiers.lazy) {
         this.trigger('change')
       }
       return nextTick()
diff --git a/test/resources/components/component-with-input.vue b/test/resources/components/component-with-input.vue
@@ -20,6 +20,11 @@
       <option value="selectB"></option>
       <option value="selectC"></option>
     </select>
+    <select v-model="multiselectVal" class="multiselect" multiple>
+      <option value="selectA"></option>
+      <option value="selectB"></option>
+      <option value="selectC"></option>
+    </select>
     <select v-model="selectVal" class="with-optgroups">
       <optgroup label="Group1">
         <option value="selectA"></option>
@@ -35,6 +40,7 @@
     <span class="counter">{{ counter }}</span>
     {{ textVal }}
     {{ selectVal }}
+    {{ JSON.stringify(multiselectVal) }}
     {{ radioVal }}
     <input id="lazy" type="text" v-model.lazy="lazy" />
     {{ lazy }}
@@ -52,6 +58,7 @@ export default {
       textareaVal: undefined,
       radioVal: undefined,
       selectVal: undefined,
+      multiselectVal: [],
       counter: 0
     }
   },
diff --git a/test/specs/wrapper/setValue.spec.js b/test/specs/wrapper/setValue.spec.js
@@ -65,6 +65,37 @@ describeWithShallowAndMount('setValue', mountingMethod => {
     expect(wrapper.text()).to.contain('selectB')
   })
 
+  it('sets element of multiselect value', () => {
+    const wrapper = mountingMethod(ComponentWithInput)
+    const select = wrapper.find('select.multiselect')
+    select.setValue(['selectA', 'selectC'])
+
+    const selectedOptions = Array.from(select.element.selectedOptions).map(
+      o => o.value
+    )
+    expect(selectedOptions).to.deep.equal(['selectA', 'selectC'])
+  })
+
+  it('overrides elements of multiselect', () => {
+    const wrapper = mountingMethod(ComponentWithInput)
+    const select = wrapper.find('select.multiselect')
+    select.setValue(['selectA', 'selectC'])
+    select.setValue(['selectB'])
+
+    const selectedOptions = Array.from(select.element.selectedOptions).map(
+      o => o.value
+    )
+    expect(selectedOptions).to.deep.equal(['selectB'])
+  })
+
+  it('updates dom with multiselect v-model when array', async () => {
+    const wrapper = mountingMethod(ComponentWithInput)
+    const select = wrapper.find('select.multiselect')
+    await select.setValue(['selectA', 'selectC'])
+
+    expect(wrapper.text()).to.contain('["selectA","selectC"]')
+  })
+
   it('throws error if element is option', () => {
     const message =
       'wrapper.setValue() cannot be called on an <option> element. Use wrapper.setSelected() instead'
