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: Wrapper #16

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
287af80
contains.md: traduction
Yaty Oct 20, 2017
b3b1555
contains.md: corrections
Yaty Oct 20, 2017
5b7e811
contains.md: corrections
Yaty Oct 20, 2017
b8b6748
emitted.md: traductions
Yaty Oct 20, 2017
13fcebf
emittedByOrder.md: traductions
Yaty Oct 20, 2017
921efde
exists.md: traductions
Yaty Oct 20, 2017
0b137e0
find.md: traductions
Yaty Oct 20, 2017
ea49999
findAll.md: traductions
Yaty Oct 20, 2017
049ac67
hasAttribute.md: traductions
Yaty Oct 20, 2017
a7045e6
hasClass.md: traductions
Yaty Oct 20, 2017
94ca766
hasProp.md: traductions
Yaty Oct 20, 2017
cad62fe
hasStyle.md: traductions
Yaty Oct 20, 2017
0db6ff1
html.md: traductions
Yaty Oct 20, 2017
1378a92
is.md: traduction
Yaty Oct 20, 2017
7498d06
isEmpty.md: traduction
Yaty Oct 20, 2017
9ea31d5
isVueInstance.md: traduction
Yaty Oct 20, 2017
ef5a3eb
isVueInstance.md: traduction
Yaty Oct 20, 2017
4bdb2e4
name.md: traduction
Yaty Oct 20, 2017
bd9a38e
README.md: traduction
Yaty Oct 20, 2017
00adb1a
setData.md: traduction
Yaty Oct 20, 2017
bc6ebcf
setMethods.md: traduction
Yaty Oct 20, 2017
0d0e280
setData.md: correction
Yaty Oct 20, 2017
41801f0
setProps.md: traduction
Yaty Oct 20, 2017
6403b88
text.md: traduction
Yaty Oct 20, 2017
ddad883
trigger.md: traduction
Yaty Oct 20, 2017
ef8ced7
update.md: traduction
Yaty Oct 20, 2017
81ac9dc
contains.md: correction
Yaty Oct 20, 2017
db1e594
contains.md: correction
Yaty Oct 20, 2017
b8aaba5
find.md: correction
Yaty Oct 20, 2017
2caa4a1
find.md: correction
Yaty Oct 20, 2017
644a46b
corrections
Yaty Oct 20, 2017
709dc31
corrections
Yaty Oct 20, 2017
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
18 changes: 9 additions & 9 deletions docs/en/api/wrapper/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Wrapper

vue-test-utils is a wrapper based API.
`vue-test-utils` est une API basée sur un `wrapper`.

A `Wrapper` is an object that contains a mounted component or vnode and methods to test the component or vnode.
Un `Wrapper` est un objet qui contient un composant monté, un nœud virtuel et des méthodes pour les tester.

- **Properties:**
- **Propriétés :**

`vm` `Component`: this is the vue instance. You can access all the [instance methods and properties of a vm](https://vuejs.org/v2/api/#Instance-Properties) with `wrapper.vm`. This only exists on Vue component wrappers
`element` `HTMLElement`: the root DOM node of the wrapper
`options` `Object`: Object containing vue-test-utils options passed to `mount` or `shallow`
`options.attachedToDom` `Boolean`: True if attachToDom was passed to `mount` or `shallow`
`vm` `Component`: c'est une instance de Vue. Vous pouvez accéder à toutes les [méthodes et propriétés de l'instance](https://vuejs.org/v2/api/#Instance-Properties) avec `wrapper.vm`. Cela existe uniquement sur les `wrappers` de composants Vue.
`element` `HTMLElement`: le nœud principal du DOM du `wrapper`.
`options` `Object`: objet contenant les options de `vue-test-utils` passées à `mount` ou `shallow`.
`options.attachedToDom` `Boolean`: `true` si `attachToDom` est passé à `mount` ou `shallow`.

- **Methods:**
- **Méthodes :**

There is a detailed list of methods in the wrapper section of the docs.
Il y a une liste détaillé des méthodes dans la section `wrapper` de la documentation.
12 changes: 6 additions & 6 deletions docs/en/api/wrapper/contains.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# contains(selector)

Assert `Wrapper` contains an element or component matching [selector](../selectors.md).
Asserte que `Wrapper` contient un élément ou un composant correspondant au [sélecteur](../selectors.md).

- **Arguments:**
- `{string|Component} selector`
- **Paramètres :**
- `{string|Component} selector : un sélecteur`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -20,4 +20,4 @@ expect(wrapper.contains('p')).toBe(true)
expect(wrapper.contains(Bar)).toBe(true)
```

- **See also:** [selectors](../selectors.md)
- **Voir aussi :** [sélecteurs](../selectors.md)
14 changes: 7 additions & 7 deletions docs/en/api/wrapper/emitted.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# emitted()

Return an object containing custom events emitted by the `Wrapper` `vm`.
Retourne un objet contenant des évènements émis par l'instance de Vue `vm` du `Wrapper`.

- **Returns:** `{ [name: string]: Array<Array<any>> }`
- **Retourne :** `{ [name: string]: Array<Array<any>> }`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -16,18 +16,18 @@ wrapper.vm.$emit('foo')
wrapper.vm.$emit('foo', 123)

/*
wrapper.emitted() returns the following object:
wrapper.emitted() retourne l'objet suivant :
{
foo: [[], [123]]
}
*/

// assert event has been emitted
// asserte que l'évènement est émis
expect(wrapper.emitted().foo).toBeTruthy()

// assert event count
// asserte que l'évènement est compté
expect(wrapper.emitted().foo.length).toBe(2)

// assert event payload
// asserte le contenu de l'évènement
expect(wrapper.emitted().foo[1]).toEqual([123])
```
10 changes: 5 additions & 5 deletions docs/en/api/wrapper/emittedByOrder.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# emittedByOrder()

Return an Array containing custom events emitted by the `Wrapper` `vm`.
Retourne un tableau contenant des évènements émis par l'instance de Vue `vm` de `Wrapper`.

- **Returns:** `Array<{ name: string, args: Array<any> }>`
- **Retourne :** `Array<{ name: string, args: Array<any> }>`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -16,13 +16,13 @@ wrapper.vm.$emit('foo')
wrapper.vm.$emit('bar', 123)

/*
wrapper.emittedByOrder() returns the following Array:
wrapper.emittedByOrder() retourne le tableau suivant :
[
{ name: 'foo', args: [] },
{ name: 'bar', args: [123] }
]
*/

// assert event emit order
// asserte l'ordre des émissions
expect(wrapper.emittedByOrder().map(e => e.name)).toEqual(['foo', 'bar'])
```
12 changes: 6 additions & 6 deletions docs/en/api/wrapper/exists.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# exists()

Assert `Wrapper` or `WrapperArray` exists.
Asserte que `Wrapper` ou `WrapperArray` existent.

Returns false if called on an empty `Wrapper` or `WrapperArray`.
Retourne `false` si appellé sur un `Wrapper` ou `WrapperArray` vide.

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -15,7 +15,7 @@ import Foo from './Foo.vue'

const wrapper = mount(Foo)
expect(wrapper.exists()).toBe(true)
expect(wrapper.find('does-not-exist').exists()).toBe(false)
expect(wrapper.find('existe-pas').exists()).toBe(false)
expect(wrapper.findAll('div').exists()).toBe(true)
expect(wrapper.findAll('does-not-exist').exists()).toBe(false)
expect(wrapper.findAll('existe-pas').exists()).toBe(false)
```
14 changes: 7 additions & 7 deletions docs/en/api/wrapper/find.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# find(selector)

Returns [`Wrapper`](README.md) of first DOM node or Vue component matching selector.
Retourne un [`Wrapper`](README.md) du premier nœud du DOM ou le composant Vue correspondant au sélecteur.

Use any valid [selector](../selectors.md).
Utilise n'importe quels [sélecteurs valides](../selectors.md).

- **Arguments:**
- `{string|Component} selector`
- **Paramètres **
- `{string|Component} selector : un sélecteur`

- **Returns:** `{Wrapper}`
- **Retourne :** `{Wrapper}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -24,4 +24,4 @@ const bar = wrapper.find(Bar)
expect(bar.is(Bar)).toBe(true)
```

- **See also:** [Wrapper](README.md)
- **Voir aussi :** [Wrapper](README.md)
14 changes: 7 additions & 7 deletions docs/en/api/wrapper/findAll.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# findAll(selector)

Returns a [`WrapperArray`](../wrapper-array/README.md) of [Wrappers](README.md).
Retourne un [`WrapperArray`](../wrapper-array/README.md) de [Wrappers](README.md).

Use any valid [selector](../selectors.md).
Utilise n'importe quels [sélecteurs valides](../selectors.md).

- **Arguments:**
- `{string|Component} selector`
- **Paramètres :**
- `{string|Component} selector : un sélecteur`

- **Returns:** `{WrapperArray}`
- **Retourne :** `{WrapperArray}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -24,4 +24,4 @@ const bar = wrapper.findAll(Bar).at(0)
expect(bar.is(Bar)).toBe(true)
```

- **See also:** [Wrapper](README.md)
- **Voir aussi :** [Wrapper](README.md)
16 changes: 8 additions & 8 deletions docs/en/api/wrapper/hasAttribute.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# hasAttribute(attribute, value)

Assert `Wrapper` DOM node has attribute matching value.
Asserte que le DOM du `Wrapper` a l'attribut avec la valeur correspondate.

Returns `true` if `Wrapper` DOM node contains attribute with matching value.
Retourne `true` si le nœud du DOM du `Wrapper` contient un attribut avec la bonne valeur.

- **Arguments:**
- **Paramètres :**
- `{string} attribute`
- `{string} value`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand All @@ -21,9 +21,9 @@ const wrapper = mount(Foo)
expect(wrapper.hasAttribute('id', 'foo')).toBe(true)
```

- **Alternative:**
- **Alternative :**

You could get the attribute from the `Wrapper.element` to have a value based assertion:
Vous pouvez récuperer l'attribut depuis `Wrapper.element` pour avoir une assertion basée sur une valeur.

```js
import { mount } from 'vue-test-utils'
Expand All @@ -34,4 +34,4 @@ const wrapper = mount(Foo)
expect(wrapper.element.getAttribute('id')).toBe('foo')
```

This makes for a more informative assertion error.
Cela produit une erreur d'assertion plus informative.
10 changes: 5 additions & 5 deletions docs/en/api/wrapper/hasClass.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# hasClass(className)

Assert `Wrapper` DOM node has class contains `className`.
Asserte que le DOM du `Wrapper` contient une classe nommé `className`.

Returns `true` if `Wrapper` DOM node contains class.
Retourne `true` si le nœud du DOM du `Wrapper` contient la classe.

- **Arguments:**
- **Paramètres :**
- `{string} className`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
12 changes: 6 additions & 6 deletions docs/en/api/wrapper/hasProp.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# hasProp(prop, value)

Assert `Wrapper` `vm` has `prop` matching `value`.
Asserte que l'instance de Vue `vm` du `Wrapper` contient une `prop` de valeur `value`.

Returns `true` if `Wrapper` `vm` has `prop` matching `value`.
Retourne `true` si l'instance de Vue `vm` du `Wrapper` contient une `prop` de valeur `value`.


**Note: the Wrapper must contain a Vue instance.**
**Note : le Wrapper doit posséder une instance de Vue.**

- **Arguments:**
- **Paramètres :**
- `{string} prop`
- `{any} value`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
12 changes: 6 additions & 6 deletions docs/en/api/wrapper/hasStyle.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# hasStyle(style, value)

Assert `Wrapper` DOM node has style matching value
Asserte que le DOM du `Wrapper` contient un style avec une certaine valeur.

Returns `true` if `Wrapper` DOM node has `style` matching `string`.
Retourne `true` si le nœud du DOM du `Wrapper` contient un `style` correspondant à `string`.

**Note will only detect inline styles when running in `jsdom`.**
**Note : cela va uniquement détecter les styles `inlines` quand ils fonctionnent avec `jsdom`.**

- **Arguments:**
- **Paramètres :**
- `{string} style`
- `{string} value`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
6 changes: 3 additions & 3 deletions docs/en/api/wrapper/html.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# html()

Returns HTML of `Wrapper` DOM node as a string.
Retourne l'HTML du DOM du `Wrapper` en string.

- **Returns:** `{string}`
- **Retourne :** `{string}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
10 changes: 5 additions & 5 deletions docs/en/api/wrapper/is.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# is(selector)

Assert `Wrapper` DOM node or `vm` matches [selector](../selectors.md).
Asserte que le DOM du `Wrapper` ou que l'instance de Vue `vm` correspond au [sélecteur](../selectors.md).

- **Arguments:**
- `{string|Component} selector`
- **Paramètres :**
- `{string|Component} selector : un sélecteur`

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
6 changes: 3 additions & 3 deletions docs/en/api/wrapper/isEmpty.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# isEmpty()

Assert `Wrapper` does not contain child node.
Asserte que le `Wrapper` ne contient pas de nœuds enfants.

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
6 changes: 3 additions & 3 deletions docs/en/api/wrapper/isVueInstance.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# isVueInstance()

Assert `Wrapper` is Vue instance.
Asserte que `Wrapper` contient une instance de Vue.

- **Returns:** `{boolean}`
- **Retourne :** `{boolean}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
6 changes: 3 additions & 3 deletions docs/en/api/wrapper/name.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# name()

Returns component name if `Wrapper` contains a Vue instance, or the tag name of `Wrapper` DOM node if `Wrapper` does not contain a Vue instance.
Retourne le nom du composant si le `Wrapper` contient une instance de Vue. Il retourne le nom de la balise du nœud du DOM du `Wrapper` si il ne contient pas une instance de Vue.

- **Returns:** `{string}`
- **Retourne :** `{string}`

- **Example:**
- **Exemple :**

```js
import { mount } from 'vue-test-utils'
Expand Down
Loading