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

API: options.md #13

Open
wants to merge 1 commit into
base: working
Choose a base branch
from
Open
Changes from all commits
Commits
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
88 changes: 44 additions & 44 deletions docs/en/api/options.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Mounting Options
# Options de montage

Options for `mount` and `shallow`. The options object can contain both `vue-test-utils` mounting options and raw Vue options.
Options pour `mount` et `shallow`. L'objet options peut contenir deux options de montage de `vue-test-utils` et des options propres à Vue.

Vue options are passed to the component when a new instance is created. , e.g. `store`, `propsData`. For a full list, see the [Vue API docs](https://vuejs.org/v2/api/).
Les options de Vue sont passées dans le composant quand la nouvelle instance est créée (c.à.d `store`, `propsData`). Pour une liste complète, regardez la [documentation de l'API Vue](https://vuejs.org/v2/api/).

## `vue-test-utils` Specific Mounting Options
## `vue-test-utils` Options de montage spécifiques

- [context](#context)
- [slots](#slots)
Expand All @@ -18,39 +18,39 @@ Vue options are passed to the component when a new instance is created. , e.g. `

### `context`

- type: `Object`
- type : `Objet`

Passes context to functional component. Can only be used with functional components.
Passe le contexte à un composant fonctionnel. Peut uniquement être utilisé avec des composants fonctionnels.

Example:
Exemple :

```js
const wrapper = mount(Component, {
const wrapper = mount(Composant, {
context: {
props: { show: true }
}
})

expect(wrapper.is(Component)).toBe(true)
expect(wrapper.is(Composant)).toBe(true)
```

### `slots`

- type: `{ [name: string]: Array<Component>|Component|string }`
- type : `{ [name: string]: Array<Composant>|Composant|string }`

Provide an object of slot contents to the component. The key corresponds to the slot name. The value can be either a component, an array of components, or a template string.
Procure un objet pouvant contenir des slots à passer au composant. La clé correspond au nom du slot. La valeur peut être soit un composant, soit un tableau de composants ou un template en chaîne de caractères.

Example:
Exemple :

```js
import { expect } from 'chai'
import Foo from './Foo.vue'
import Bar from './Bar.vue'

const wrapper = shallow(Component, {
const wrapper = shallow(Composant, {
slots: {
default: [Foo, Bar],
fooBar: Foo, // Will match <slot name="FooBar" />,
fooBar: Foo, // Va correspondre à <slot name="FooBar" />,
foo: '<div />'
}
})
Expand All @@ -59,42 +59,42 @@ expect(wrapper.find('div')).toBe(true)

### `stubs`

- type: `{ [name: string]: Component | boolean } | Array<string>`
- type : `{ [name: string]: Composant | booléen } | Array<string>`

Stubs child components. Can be an Array of component names to stub, or an object.
Imiter des composants enfants. Peut être un tableau de noms de composants à imiter, ou un objet.

Example:
Exemple :

```js
import Foo from './Foo.vue'

mount(Component, {
stubs: ['registered-component']
mount(Composant, {
stubs: ['composant-enregistre']
})

shallow(Component, {
shallow(Composant, {
stubs: {
// stub with a specific implementation
'registered-component': Foo,
// create default stub
'another-component': true
// imiter avec une implémentation spécifique
'composant-enregistre': Foo,
// créer une imitation par défaut
'un-autre-composant': true
}
})
```

### `mocks`

- type: `Object`
- type : `Objet`

Add additional properties to the instance. Useful for mocking global injections.
Ajoute des propriétés additionnelles à l'instance. Utile pour simuler des injections globales.

Example:
Exemple :

```js
import { expect } from 'chai'

const $route = { path: 'http://www.example-path.com' }
const wrapper = shallow(Component, {
const wrapper = shallow(Composant, {
mocks: {
$route
}
Expand All @@ -104,11 +104,11 @@ expect(wrapper.vm.$route.path).toBe($route.path)

### `localVue`

- type: `Vue`
- type : `Vue`

A local copy of Vue created by [createLocalVue](./createLocalVue.md) to use when mounting the component. Installing plugins on this copy of Vue prevents polluting the original `Vue` copy.
Une copie local de Vue créée par [createLocalVue](./createLocalVue.md) à utiliser pour monter le composant. Installer des plugins sur cette copie de Vue empêche de polluer la copie original de `Vue`.

Example:
Exemple :

```js
import { createLocalVue, mount } from 'vue-test-utils'
Expand All @@ -127,7 +127,7 @@ const router = new VueRouter({
routes
})

const wrapper = mount(Component, {
const wrapper = mount(Composant, {
localVue,
router
})
Expand All @@ -136,30 +136,30 @@ expect(wrapper.vm.$route).toBeInstanceOf(Object)

### `attachToDocument`

- type: `boolean`
- default: `false`
- type : `booléen`
- défaut : `false`

Component will be attach to DOM when rendered if set to `true`. This can be used with [`hasStyle`](wrapper/hasStyle.md) to check multi element CSS selectors.
Le composant va être attaché au DOM quand celui-ci sera rendu si c'est à `true`. Cela peut être utilisé avec [`hasStyle`](wrapper/hasStyle.md) pour vérifier des sélecteurs multi-éléments CSS.

### `attrs`

- type: `Object`
- type : `Objet`

Set the component instance's `$attrs` object.
Fixe l'objet `$attrs` à l'instance du composant.

### `listeners`

- type: `Object`
- type : `Objet`

Set the component instance's `$listeners` object.
Fixe l'objet `$listeners` à l'instance du composant.

### `clone`

- type: `boolean`
- default: `true`
- type : `booléen`
- défaut : `true`

Clones component before mounting if `true`, which avoids mutating the original component definition.
Clone le composant avant montage si `true`, cela évitera de muter la définition du composant original.

`options.mocks` (`Object`): Add globals to Vue instance.
`options.mocks` (`Objet`): Ajouter des propriétés simulées à l'instance de Vue.

`options.localVue` (`Object`): vue class to use in `mount`. See [createLocalVue](createLocalVue.md)
`options.localVue` (`Objet`): Constructeur de Vue à utiliser dans `mount`. Voir [createLocalVue](createLocalVue.md)