From 64f9d885952859fe079cdb243195e73f0129eb03 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Thu, 12 Oct 2017 14:03:05 +0200 Subject: [PATCH 1/3] Traduction de context.md Signed-off-by: Bruno Lesieur --- en/api/context.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/en/api/context.md b/en/api/context.md index f9b75441d..3993bdd14 100644 --- a/en/api/context.md +++ b/en/api/context.md @@ -1,28 +1,28 @@ --- -title: "API: The Context" -description: The `context` provides additional objects/params from Nuxt not traditionally available to Vue components. The `context` is available in special nuxt lifecycle areas like `asyncData`, `plugins`, 'middlewares', 'modules', and 'store/nuxtServerInit`. +title: "API : le contexte" +description: L'objet `context` fournit des objets et paramètres additionnels en provenance de Nuxt qui ne sont pas disponibles dans les composants Vue natifs. Le `context` est disponible dans des aires de cycle de vie spécifique à Nuxt. On y retrouve, par exemple, `asyncData`, `plugins`, 'middlewares', 'modules', et 'store/nuxtServerInit`. --- -## Context (En) +## Contexte -

⚠Cette page est actuellement en cours de traduction française. Vous pouvez repasser plus tard ou participer à la traduction de celle-ci dès maintenant !

List of all the available keys in `context`:

+Liste de toutes les propriétés disponibles dans `context` : -| Key | Type | Available | Description | -|-----|------|--------------|-------------| -| `app` | Root Vue Instance | Client & Server | The root vue instance that includes all your plugins. For example, when using `axios`, you can get access to `$axios` through `context.app.$axios` -| `isClient` | Boolean | Client & Server | Boolean to let you know if you're actually renderer from the client-side | -| `isServer` | Boolean | Client & Server | Boolean to let you know if you're actually renderer from the server-side | -| `isStatic` | Boolean | Client & Server | Boolean to let you know if you're actually inside a generated app (via `nuxt generate`) | -| `isDev` | Boolean | Client & Server | Boolean to let you know if you're in dev mode, can be useful for caching some data in production | -| `isHMR` | Boolean | Client & Server | Boolean to let you know if you're the method/middleware is called from webpack hot module replacement (*only on client-side in dev mode*) | -| `route` | [vue-router route](https://router.vuejs.org/en/api/route-object.html) | Client & Server | `vue-router` route instance. | -| `store` | [vuex store](http://vuex.vuejs.org/en/api.html#vuexstore-instance-properties) | Client & Server | `Vuex.Store` instance. **Available only if the [vuex store](/guide/vuex-store) is set** | -| `env` | Object | Client & Server | Environment variables set in `nuxt.config.js`, see [env api](/api/configuration-env) | -| `params` | Object | Client & Server | Alias of route.params | -| `query` | Object | Client & Server | Alias of route.query | -| `req` | [http.Request](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Server | Request from the node.js server. If nuxt is used as a middleware, the req object might be different depending of the framework you're using.
**Not available via `nuxt generate`** | -| `res` | [http.Response](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Server | Response from the node.js server. If nuxt is used as a middleware, the res object might be different depending of the framework you're using.
**Not available via `nuxt generate`** | -| `redirect` | Function | Client & Server | Use this method to redirect the user to another route, the status code is used on the server-side, default to 302. `redirect([status,] path [, query])` | -| `error` | Function | Client & Server | Use this method to show the error page: `error(params)`. The `params` should have the fields `statusCode` and `message` | -| `nuxtState` | Object | Client | Nuxt state, useful for plugins which uses `beforeNuxtRender` to get the nuxt state on client-side before hydration. **Available only in `universal` mode.** -| `beforeNuxtRender(fn)` | Function | Server | Use this method to update `__NUXT__` variable rendered on client-side, the `fn` (can be asynchronous) is called with `{ Components, nuxtState }`, see [example](https://github.com/nuxt/nuxt.js/blob/cf6b0df45f678c5ac35535d49710c606ab34787d/test/fixtures/basic/pages/special-state.vue). | +| Propriété | Type | Disponibilité | Description | +|------------------------|------------------------------------------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `app` | Instance racine de Vue | Client et serveur | L'instance racine de Vue qui inclue tous vos plugins. Par exemple, en utilisant `axios`, vous avez accès à `$axios` à travers `context.app.$axios`. | +| `isClient` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si le rendu est effectué côté client. | +| `isServer` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si le rendu est effectué côté serveur. | +| `isStatic` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si l'application est générée (via `nuxt generate`). | +| `isDev` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si vous êtes en mode développement, peut-être utile pour mettre des données en cache en production. | +| `isHMR` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir les méthodes et middlewares sont appelées depuis le système de rechargement à chaud de modules webpack (*seule sur la partie cliente en mode développement*) | +| `route` | [Route Vue Router](https://router.vuejs.org/fr/api/route-object.html) | Client et serveur | L'instance route Vue Router. | +| `store` | [Store Vuex](https://vuex.vuejs.org/fr/api.html#propriétés-dinstance-de-vuexstore) | Client et serveur | L'instance du store Vuex. **Disponible uniquement si le [store Vuex](/guide/vuex-store) est défini**. | +| `env` | `Object` | Client et serveur | Environment variables set in `nuxt.config.js`, see [env api](/api/configuration-env). | +| `params` | `Object` | Client et serveur | Alias de `route.params`. | +| `query` | `Object` | Client et serveur | Alias de `route.query`. | +| `req` | [`http.Request`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Serveur | Requête faites au serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `req` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `res` | [`http.Response`](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Serveur | Réponse faites par le serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `res` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `redirect` | `Function` | Client et serveur | Cette methode redirige l'utilisateur vers une autre route, un code de statut est utilisé côté serveur, par défaut c'est le `302`. `redirect([status,] path [, query])`. | +| `error` | `Function` | Client et serveur | Cette methode montre la page d'erreur : `error(params)`. L'objet `params` devrait avoir la propriété `statusCode` et `message`. | +| `nuxtState` | `Object` | Client | L'état de Nuxt, utile pour les plugins qui utilisent `beforeNuxtRender` pour connaître l'état de Nuxt côté client avant l'hydratation. **Disponible seulement en mode `universal`**. | +| `beforeNuxtRender(fn)` | `Function` | Serveur | Cette methode met à jour la variable `__NUXT__` rendue côté client, la fonction `fn` (pouvant être asynchrone) est appelée avec `{ Components, nuxtState }`, voir cet [exemple](https://github.com/nuxt/nuxt.js/blob/cf6b0df45f678c5ac35535d49710c606ab34787d/test/fixtures/basic/pages/special-state.vue). | From c2bced4fae9b4d39050c5b57039dee4332908279 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Thu, 12 Oct 2017 16:32:36 +0200 Subject: [PATCH 2/3] Review de @rspt Signed-off-by: Bruno Lesieur --- en/api/context.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/en/api/context.md b/en/api/context.md index 3993bdd14..84d4f8c84 100644 --- a/en/api/context.md +++ b/en/api/context.md @@ -14,15 +14,15 @@ Liste de toutes les propriétés disponibles dans `context` : | `isServer` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si le rendu est effectué côté serveur. | | `isStatic` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si l'application est générée (via `nuxt generate`). | | `isDev` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si vous êtes en mode développement, peut-être utile pour mettre des données en cache en production. | -| `isHMR` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir les méthodes et middlewares sont appelées depuis le système de rechargement à chaud de modules webpack (*seule sur la partie cliente en mode développement*) | +| `isHMR` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir les méthodes et middlewares sont appelés depuis le système de rechargement à chaud des modules webpack (*seule sur la partie cliente en mode développement*) | | `route` | [Route Vue Router](https://router.vuejs.org/fr/api/route-object.html) | Client et serveur | L'instance route Vue Router. | | `store` | [Store Vuex](https://vuex.vuejs.org/fr/api.html#propriétés-dinstance-de-vuexstore) | Client et serveur | L'instance du store Vuex. **Disponible uniquement si le [store Vuex](/guide/vuex-store) est défini**. | | `env` | `Object` | Client et serveur | Environment variables set in `nuxt.config.js`, see [env api](/api/configuration-env). | | `params` | `Object` | Client et serveur | Alias de `route.params`. | | `query` | `Object` | Client et serveur | Alias de `route.query`. | -| `req` | [`http.Request`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Serveur | Requête faites au serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `req` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | -| `res` | [`http.Response`](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Serveur | Réponse faites par le serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `res` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | -| `redirect` | `Function` | Client et serveur | Cette methode redirige l'utilisateur vers une autre route, un code de statut est utilisé côté serveur, par défaut c'est le `302`. `redirect([status,] path [, query])`. | -| `error` | `Function` | Client et serveur | Cette methode montre la page d'erreur : `error(params)`. L'objet `params` devrait avoir la propriété `statusCode` et `message`. | -| `nuxtState` | `Object` | Client | L'état de Nuxt, utile pour les plugins qui utilisent `beforeNuxtRender` pour connaître l'état de Nuxt côté client avant l'hydratation. **Disponible seulement en mode `universal`**. | -| `beforeNuxtRender(fn)` | `Function` | Serveur | Cette methode met à jour la variable `__NUXT__` rendue côté client, la fonction `fn` (pouvant être asynchrone) est appelée avec `{ Components, nuxtState }`, voir cet [exemple](https://github.com/nuxt/nuxt.js/blob/cf6b0df45f678c5ac35535d49710c606ab34787d/test/fixtures/basic/pages/special-state.vue). | +| `req` | [`http.Request`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Serveur | Requête faite au serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `req` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `res` | [`http.Response`](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Serveur | Réponse faite par le serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `res` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `redirect` | `Function` | Client et serveur | Cette méthode redirige l'utilisateur vers une autre route, un code de statut est utilisé côté serveur, par défaut c'est le `302`. `redirect([status,] path [, query])`. | +| `error` | `Function` | Client et serveur | Cette méthode montre la page d'erreur : `error(params)`. L'objet `params` devrait avoir la propriété `statusCode` et `message`. | +| `nuxtState` | `Object` | Client | L'état de Nuxt, utile pour les plugins qui utilisent `beforeNuxtRender` pour connaitre l'état de Nuxt côté client avant l'hydratation. **Disponible seulement en mode `universal`**. | +| `beforeNuxtRender(fn)` | `Function` | Serveur | Cette méthode met à jour la variable `__NUXT__` rendue côté client, la fonction `fn` (pouvant être asynchrone) est appelée avec `{ Components, nuxtState }`, voir cet [exemple](https://github.com/nuxt/nuxt.js/blob/cf6b0df45f678c5ac35535d49710c606ab34787d/test/fixtures/basic/pages/special-state.vue). | From 39b0b13ae30980b34ddc930bedf71cc6e7deaf85 Mon Sep 17 00:00:00 2001 From: Bruno Lesieur Date: Thu, 12 Oct 2017 17:17:28 +0200 Subject: [PATCH 3/3] @forresst review Signed-off-by: Bruno Lesieur --- en/api/context.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/en/api/context.md b/en/api/context.md index 84d4f8c84..e664eeed2 100644 --- a/en/api/context.md +++ b/en/api/context.md @@ -1,6 +1,6 @@ --- title: "API : le contexte" -description: L'objet `context` fournit des objets et paramètres additionnels en provenance de Nuxt qui ne sont pas disponibles dans les composants Vue natifs. Le `context` est disponible dans des aires de cycle de vie spécifique à Nuxt. On y retrouve, par exemple, `asyncData`, `plugins`, 'middlewares', 'modules', et 'store/nuxtServerInit`. +description: L'objet `context` fournit des objets et paramètres additionnels en provenance de Nuxt qui ne sont pas traditionnellement disponibles dans les composants Vue. Le `context` est disponible dans des aires de cycle de vie spécifique à Nuxt. On y retrouve, par exemple, `asyncData`, `plugins`, 'middlewares', 'modules', et 'store/nuxtServerInit`. --- ## Contexte @@ -13,16 +13,16 @@ Liste de toutes les propriétés disponibles dans `context` : | `isClient` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si le rendu est effectué côté client. | | `isServer` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si le rendu est effectué côté serveur. | | `isStatic` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si l'application est générée (via `nuxt generate`). | -| `isDev` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si vous êtes en mode développement, peut-être utile pour mettre des données en cache en production. | -| `isHMR` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir les méthodes et middlewares sont appelés depuis le système de rechargement à chaud des modules webpack (*seule sur la partie cliente en mode développement*) | +| `isDev` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si vous êtes en mode développement, ceci peut-être utile pour mettre des données en cache en production. | +| `isHMR` | `Boolean` | Client et serveur | Valeur booléenne vous permettant de savoir si les méthodes et middlewares sont appelés depuis le système de rechargement à chaud des modules webpack (*seule sur la partie cliente en mode développement*) | | `route` | [Route Vue Router](https://router.vuejs.org/fr/api/route-object.html) | Client et serveur | L'instance route Vue Router. | | `store` | [Store Vuex](https://vuex.vuejs.org/fr/api.html#propriétés-dinstance-de-vuexstore) | Client et serveur | L'instance du store Vuex. **Disponible uniquement si le [store Vuex](/guide/vuex-store) est défini**. | -| `env` | `Object` | Client et serveur | Environment variables set in `nuxt.config.js`, see [env api](/api/configuration-env). | +| `env` | `Object` | Client et serveur | Variables d'environnement définies dans `nuxt.config.js`, consulter [env](/api/configuration-env) dans l'API. | | `params` | `Object` | Client et serveur | Alias de `route.params`. | | `query` | `Object` | Client et serveur | Alias de `route.query`. | -| `req` | [`http.Request`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Serveur | Requête faite au serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `req` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | -| `res` | [`http.Response`](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Serveur | Réponse faite par le serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `res` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `req` | [`http.Request`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) | Serveur | Requête faite au serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `req` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | +| `res` | [`http.Response`](https://nodejs.org/api/http.html#http_class_http_serverresponse) | Serveur | Réponse faite par le serveur Node.js. Si Nuxt est utilisé en tant que middleware, l'objet `res` peut être différent en fonction du framework utilisé.
**Non disponible avec `nuxt generate`**. | | `redirect` | `Function` | Client et serveur | Cette méthode redirige l'utilisateur vers une autre route, un code de statut est utilisé côté serveur, par défaut c'est le `302`. `redirect([status,] path [, query])`. | -| `error` | `Function` | Client et serveur | Cette méthode montre la page d'erreur : `error(params)`. L'objet `params` devrait avoir la propriété `statusCode` et `message`. | +| `error` | `Function` | Client et serveur | Cette méthode montre la page d'erreur : `error(params)`. L'objet `params` devrait avoir les propriétés `statusCode` et `message`. | | `nuxtState` | `Object` | Client | L'état de Nuxt, utile pour les plugins qui utilisent `beforeNuxtRender` pour connaitre l'état de Nuxt côté client avant l'hydratation. **Disponible seulement en mode `universal`**. | | `beforeNuxtRender(fn)` | `Function` | Serveur | Cette méthode met à jour la variable `__NUXT__` rendue côté client, la fonction `fn` (pouvant être asynchrone) est appelée avec `{ Components, nuxtState }`, voir cet [exemple](https://github.com/nuxt/nuxt.js/blob/cf6b0df45f678c5ac35535d49710c606ab34787d/test/fixtures/basic/pages/special-state.vue). |