Skip to content
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

docs(v-model): add v-model section #1839

Merged
merged 1 commit into from Oct 27, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/config.ts
Expand Up @@ -86,6 +86,7 @@ export default defineConfig({
text: 'Reusability and Composition',
link: '/guide/advanced/reusability-composition'
},
{ text: 'Testing v-model', link: '/guide/advanced/v-model' },
{ text: 'Testing Vuex', link: '/guide/advanced/vuex' },
{ text: 'Testing Vue Router', link: '/guide/advanced/vue-router' },
{ text: 'Testing Teleport', link: '/guide/advanced/teleport' },
Expand Down
96 changes: 96 additions & 0 deletions docs/guide/advanced/v-model.md
@@ -0,0 +1,96 @@
# Testing `v-model`

When writing components that rely on `v-model` interaction (`update:modelValue` event), you need to handle the `event` and `props`.

Check ["vmodel integration" Discussion](https://github.com/vuejs/test-utils/discussions/279) for some community solutions.

Check [VueJS VModel event documentation](https://vuejs.org/guide/components/events.html#usage-with-v-model).

## A Simple Example

Here a simple Editor component:

```js
const Editor = {
props: {
label: String,
modelValue: String
},
template: `<div>
<label>{{label}}</label>
<input :value="modelValue" @input="$emit('update:modelValue', $event.target.value)">
</div>`
}
```

This component will just behave as an input component:

```js
const App {
components: {
Editor
},
template: `<editor v-model="text" label="test" />`
data(){
return {
text: 'test'
}
}
}
```

Now when we type on the input, it will update `text` on our component.

To test this behavior:

```js
test('modelValue should be updated', async () => {
const wrapper = mount(Editor, {
props: {
modelValue: 'initialText',
'onUpdate:modelValue': (e) => wrapper.setProps({ modelValue: e })
}
})

await wrapper.find('input').setValue('test')
expect(wrapper.props('modelValue')).toBe('test')
})
```

# Multiple `v-model`

In some situations we can have multiple `v-model` targeting specific properties.

Example an Money Editor, we can have `currency` and `modelValue` properties.

```js
const MoneyEditor = {
template: `<div>
<input :value="currency" @input="$emit('update:currency', $event.target.value)"/>
<input :value="modelValue" type="number" @input="$emit('update:modelValue', $event.target.value)"/>
</div>`,
props: ['currency', 'modelValue']
}
```

We can test both by:

```js
test('modelValue and currency should be updated', async () => {
const wrapper = mount(MoneyEditor, {
props: {
modelValue: 'initialText',
'onUpdate:modelValue': (e) => wrapper.setProps({ modelValue: e }),
currency: '$',
'onUpdate:currency': (e) => wrapper.setProps({ currency: e })
}
})

const [currencyInput, modelValueInput] = wrapper.findAll('input')
await modelValueInput.setValue('test')
await currencyInput.setValue('£')

expect(wrapper.props('modelValue')).toBe('test')
expect(wrapper.props('currency')).toBe('£')
})
```