Skip to content

fix(b-form-checkbox-group): only emit input when value loosely changes #5432

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
merged 3 commits into from
May 25, 2020
Merged

fix(b-form-checkbox-group): only emit input when value loosely changes #5432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf2b9fa
fix(b-form-checkbox-group, b-form-radio-group): only emit `input` whe…
tmorehouse May 25, 2020
156ba3b
Update loose-equal.js
tmorehouse May 25, 2020
daafacd
Update form-checkbox-group.spec.js
tmorehouse May 25, 2020
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
48 changes: 48 additions & 0 deletions src/components/form-checkbox/form-checkbox-group.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,54 @@ describe('form-checkbox-group', () => {
wrapper.destroy()
})

it('does not emit "input" event when value loosely changes', async () => {
const value = ['one', 'two', 'three']
const wrapper = mount(BFormCheckboxGroup, {
attachTo: createContainer(),
propsData: {
options: value.slice(),
checked: value.slice()
}
})
expect(wrapper.classes()).toBeDefined()
const checks = wrapper.findAll('input')
expect(checks.length).toBe(3)
expect(wrapper.vm.localChecked).toEqual(value)
expect(checks.wrappers.every(c => c.find('input[type=checkbox]').exists())).toBe(true)
expect(checks.at(0).element.checked).toBe(true)
expect(checks.at(1).element.checked).toBe(true)
expect(checks.at(2).element.checked).toBe(true)

expect(wrapper.emitted('input')).not.toBeDefined()

// Set internal value to new array reference
wrapper.vm.localChecked = value.slice()
await waitNT(wrapper.vm)

expect(wrapper.vm.localChecked).toEqual(value)
expect(checks.wrappers.every(c => c.find('input[type=checkbox]').exists())).toBe(true)
expect(checks.at(0).element.checked).toBe(true)
expect(checks.at(1).element.checked).toBe(true)
expect(checks.at(2).element.checked).toBe(true)

expect(wrapper.emitted('input')).not.toBeDefined()

// Set internal value to new array (reversed order)
wrapper.vm.localChecked = value.slice().reverse()
await waitNT(wrapper.vm)

expect(wrapper.vm.localChecked).toEqual(value.slice().reverse())
expect(checks.wrappers.every(c => c.find('input[type=checkbox]').exists())).toBe(true)
expect(checks.at(0).element.checked).toBe(true)
expect(checks.at(1).element.checked).toBe(true)
expect(checks.at(2).element.checked).toBe(true)
expect(wrapper.emitted('input')).toBeDefined()
expect(wrapper.emitted('input').length).toBe(1)
expect(wrapper.emitted('input')[0][0]).toEqual(value.slice().reverse())

wrapper.destroy()
})

it('checkboxes reflect group checked v-model', async () => {
const wrapper = mount(BFormCheckboxGroup, {
attachTo: createContainer(),
Expand Down
7 changes: 5 additions & 2 deletions src/mixins/form-radio-check-group.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { htmlOrText } from '../utils/html'
import looseEqual from '../utils/loose-equal'
import normalizeSlotMixin from './normalize-slot'
import { BFormCheckbox } from '../components/form-checkbox/form-checkbox'
import { BFormRadio } from '../components/form-radio/form-radio'
Expand Down Expand Up @@ -70,8 +71,10 @@ export default {
checked(newVal) {
this.localChecked = newVal
},
localChecked(newVal) {
this.$emit('input', newVal)
localChecked(newVal, oldVal) {
if (!looseEqual(newVal, oldVal)) {
this.$emit('input', newVal)
}
}
},
render(h) {
Expand Down
8 changes: 3 additions & 5 deletions src/utils/loose-equal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { keys } from './object'
import { hasOwnProperty, keys } from './object'
import { isArray, isDate, isObject } from './inspect'

// Assumes both a and b are arrays!
Expand Down Expand Up @@ -46,10 +46,8 @@ const looseEqual = (a, b) => {
return false
}
for (const key in a) {
// eslint-disable-next-line no-prototype-builtins
const aHasKey = a.hasOwnProperty(key)
// eslint-disable-next-line no-prototype-builtins
const bHasKey = b.hasOwnProperty(key)
const aHasKey = hasOwnProperty(a, key)
const bHasKey = hasOwnProperty(b, key)
if ((aHasKey && !bHasKey) || (!aHasKey && bHasKey) || !looseEqual(a[key], b[key])) {
return false
}
Expand Down