|
@@ -8,20 +8,21 @@ import Vuex from 'vuex'
|
|
const store = new Vuex.Store({ ...options })
|
|
const store = new Vuex.Store({ ...options })
|
|
```
|
|
```
|
|
|
|
|
|
-### Vuex.Store Opções do construtor
|
|
|
|
|
|
+### Vuex.Store Opções do Construtor
|
|
|
|
|
|
- **state**
|
|
- **state**
|
|
|
|
|
|
- type: `Object | Function`
|
|
- type: `Object | Function`
|
|
|
|
|
|
-O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
- Se você passar uma função que retorna um objeto, o objeto retornado é usado como o estado da raiz. Isso é útil quando você deseja reutilizar o objeto de estado, especialmente para reutilização de módulos. [Detalhes](modules.md#módulo-reutilização)
|
|
|
|
|
|
+ O objeto raiz de estado para o _store_ Vuex. [Detalhes](state.md)
|
|
|
|
+
|
|
|
|
+ Se você passar uma função que retorna um objeto, o objeto retornado é usado como o estado da raiz. Isso é útil quando você deseja reutilizar o objeto de estado, especialmente para reutilização de módulos. [Detalhes](modules.md#reutilização-do-módulo)
|
|
|
|
|
|
- **mutações**
|
|
- **mutações**
|
|
|
|
|
|
- type: `{ [type: string]: Function }`
|
|
- type: `{ [type: string]: Function }`
|
|
|
|
|
|
- Registra mutações na _store_ . A função do manipulador sempre recebe `estado` como o primeiro argumento (será o estado local do módulo se definido em um módulo) e receberá um segundo argumento `payload` se houver um.
|
|
|
|
|
|
+ Registra mutações no _store_. A função do manipulador sempre recebe `estado` como o 1º argumento (será o estado local do módulo se definido em um módulo) e receberá um 2º argumento `payload` se houver um.
|
|
|
|
|
|
[Detalhes](mutations.md)
|
|
[Detalhes](mutations.md)
|
|
|
|
|
|
@@ -29,7 +30,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
- type: `{ [type: string]: Function }`
|
|
- type: `{ [type: string]: Function }`
|
|
|
|
|
|
- Registra ações na _store_ . A função do manipulador recebe um objeto `context` que expõe as seguintes propriedades:
|
|
|
|
|
|
+ Registra ações no _store_. A função do manipulador recebe um objeto `context` que expõe as seguintes propriedades:
|
|
``` js
|
|
``` js
|
|
{
|
|
{
|
|
state, // o mesmo que `store.state`, ou estado local se estiver em módulos
|
|
state, // o mesmo que `store.state`, ou estado local se estiver em módulos
|
|
@@ -43,14 +44,14 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
[Detalhes](actions.md)
|
|
[Detalhes](actions.md)
|
|
|
|
|
|
-- **getters**
|
|
|
|
|
|
+- **_getters_**
|
|
|
|
|
|
- type: `{ [key: string]: Function }`
|
|
- type: `{ [key: string]: Function }`
|
|
|
|
|
|
- Registra getters na _store_ . A função getter recebe os seguintes argumentos:
|
|
|
|
|
|
+ Registra _getters_ no _store_. A função _getter_ recebe os seguintes argumentos:
|
|
```
|
|
```
|
|
state, // será o estado local do módulo, se definido em um módulo.
|
|
state, // será o estado local do módulo, se definido em um módulo.
|
|
- getters // o mesmo que store.getters
|
|
|
|
|
|
+ getters // o mesmo que `store.getters`
|
|
```
|
|
```
|
|
|
|
|
|
Especifique quando definido em um módulo
|
|
Especifique quando definido em um módulo
|
|
@@ -63,7 +64,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
rootGetters // todos os getters
|
|
rootGetters // todos os getters
|
|
```
|
|
```
|
|
|
|
|
|
- Os getters registrados estão expostos em `store.getters`.
|
|
|
|
|
|
+ Os _getters_ registrados estão expostos em `store.getters`.
|
|
|
|
|
|
[Detalhes](getters.md)
|
|
[Detalhes](getters.md)
|
|
|
|
|
|
@@ -71,7 +72,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
- type: `Object`
|
|
- type: `Object`
|
|
|
|
|
|
- Um objeto contendo sub módulos a serem incorporados na _store_ , de forma que:
|
|
|
|
|
|
+ Um objeto contendo sub módulos a serem incorporados no _store_, de forma que:
|
|
``` js
|
|
``` js
|
|
{
|
|
{
|
|
key: {
|
|
key: {
|
|
@@ -86,7 +87,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
}
|
|
}
|
|
```
|
|
```
|
|
|
|
|
|
- Cada módulo pode conter "estado" e "mutações" semelhantes às opções raiz. O estado de um módulo será anexado ao estado da raiz da _store_ usando a chave do módulo. As mutações e getters de um módulo receberão apenas o estado local do módulo como o primeiro argumento em vez do estado da raiz e as ações do módulo 'context.state` também apontarão para o estado local.
|
|
|
|
|
|
+ Cada módulo pode conter "estado" e "mutações" semelhantes às opções raiz. O estado de um módulo será anexado ao estado da raiz do _store_ usando a chave do módulo. As mutações e _getters_ de um módulo receberão apenas o estado local do módulo como o 1º argumento em vez do estado da raiz e as ações do módulo `context.state` também apontarão para o estado local.
|
|
|
|
|
|
[Detalhes](modules.md)
|
|
[Detalhes](modules.md)
|
|
|
|
|
|
@@ -94,7 +95,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
- type: `Array<Function>`
|
|
- type: `Array<Function>`
|
|
|
|
|
|
- Um array de funções de plugin a serem aplicadas na _store_ . O plugin simplesmente recebe a _store_ como o único argumento e pode ouvir mutações (para persistência de dados de saída, log ou depuração) ou mutações de despacho (para dados de entrada, por exemplo, websockets ou observáveis).
|
|
|
|
|
|
+ Um array de funções de plugin a serem aplicadas no _store_. O plugin simplesmente recebe o _store_ como o único argumento e pode ouvir mutações (para persistência de dados de saída, log ou depuração) ou mutações de despacho (para dados de entrada, por exemplo, websockets ou observáveis).
|
|
|
|
|
|
[Detalhes](plugins.md)
|
|
[Detalhes](plugins.md)
|
|
|
|
|
|
@@ -103,47 +104,47 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
- type: `Boolean`
|
|
- type: `Boolean`
|
|
- default: `false`
|
|
- default: `false`
|
|
|
|
|
|
- Força a _store_ Vuex em modo estrito. No modo estrito, qualquer mutação ao estado do Vuex fora dos manipuladores de mutação acusará um erro.
|
|
|
|
|
|
+ Força o _store_ Vuex em modo estrito. No modo estrito, qualquer mutação ao estado do Vuex fora dos manipuladores de mutação acusará um erro.
|
|
|
|
|
|
[Detalhes](strict.md)
|
|
[Detalhes](strict.md)
|
|
|
|
|
|
### Vuex.Store Propriedades da instância
|
|
### Vuex.Store Propriedades da instância
|
|
|
|
|
|
-- **state**
|
|
|
|
|
|
+- **_state_**
|
|
|
|
|
|
- type: `Object`
|
|
- type: `Object`
|
|
|
|
|
|
O estado raiz. Apenas leitura.
|
|
O estado raiz. Apenas leitura.
|
|
|
|
|
|
-- **getters**
|
|
|
|
|
|
+- **_getters_**
|
|
|
|
|
|
- type: `Object`
|
|
- type: `Object`
|
|
|
|
|
|
- Expõe os getters registrados. Apenas leitura.
|
|
|
|
|
|
+ Expõe os _getters_ registrados. Apenas leitura.
|
|
|
|
|
|
-### Vuex.Store Métodos da instância
|
|
|
|
|
|
+### Vuex.Store Métodos da Instância
|
|
|
|
|
|
- **`commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)`**
|
|
- **`commit(type: string, payload?: any, options?: Object) | commit(mutation: Object, options?: Object)`**
|
|
|
|
|
|
- Confirma uma mutação. `options` pode ter` root: true` que permite confirmar mutações da raiz em [namespaced modules](modules.md#namespacing). [Detalhes](mutations.md)
|
|
|
|
|
|
+ Confirma uma mutação. `options` pode ter `root: true` que permite confirmar mutações da raiz em [módulos namespaced](modules.md#namespacing). [Detalhes](mutations.md)
|
|
|
|
|
|
- **`dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`**
|
|
- **`dispatch(type: string, payload?: any, options?: Object) | dispatch(action: Object, options?: Object)`**
|
|
|
|
|
|
- Despacha uma ação. `options` pode ter `root: true` que permite enviar ações para raiz em [namespaced modules](modules.md#namespacing). Retorna Promise que resolve todos os manipuladores de ação acionados. [Detalhes](actions.md)
|
|
|
|
|
|
+ Despacha uma ação. `options` pode ter `root: true` que permite enviar ações para raiz em [módulos namespaced](modules.md#namespacing). Retorna Promise que resolve todos os manipuladores de ação acionados. [Detalhes](actions.md)
|
|
|
|
|
|
- **`replaceState(state: Object)`**
|
|
- **`replaceState(state: Object)`**
|
|
|
|
|
|
- Substitua o estado da raiz da _store_ . Use isso apenas para fins de hidratação / viagem no tempo.
|
|
|
|
|
|
+ Substitua o estado da raiz do _store_. Use isso apenas para fins de _hydration_ / _time-travel_.
|
|
|
|
|
|
- **`watch(getter: Function, cb: Function, options?: Object)`**
|
|
- **`watch(getter: Function, cb: Function, options?: Object)`**
|
|
|
|
|
|
- Visualiza de forma reativa um valor de retorno da função getter e chame o callback para o retorno de chamada quando o valor mudar. O getter recebe o estado da _store_ como o primeiro argumento e os getters como o segundo argumento. Aceita um objeto de opções opcional que leva as mesmas opções que o método `vm. $ Watch` do Vue.
|
|
|
|
|
|
+ Visualiza de forma reativa um valor de retorno da função _getter_ e chama o callback para o retorno de chamada quando o valor mudar. O _getter_ recebe o estado do _store_ como o 1º argumento e os _getters_ como o 2º argumento. Aceita um objeto de opções opcional que leva as mesmas opções que o método `vm. $ Watch` do Vue.
|
|
|
|
|
|
Para parar de visualizar, chame para a função do manipulador retornada.
|
|
Para parar de visualizar, chame para a função do manipulador retornada.
|
|
|
|
|
|
- **`subscribe(handler: Function)`**
|
|
- **`subscribe(handler: Function)`**
|
|
|
|
|
|
- Assina as mutações da _store_ . O `handler` é chamado após cada mutação e recebe o descritor de mutação e o estado pós-mutação como argumentos:
|
|
|
|
|
|
+ Assina as mutações do _store_. O `handler` é chamado após cada mutação e recebe o descritor de mutação e o estado pós-mutação como argumentos:
|
|
|
|
|
|
``` js
|
|
``` js
|
|
store.subscribe((mutation, state) => {
|
|
store.subscribe((mutation, state) => {
|
|
@@ -158,7 +159,7 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
> Novo em 2.5.0
|
|
> Novo em 2.5.0
|
|
|
|
|
|
- Assina as ações da _store_ . O `handler` é chamado para cada ação despachada e recebe o descritor de ação e o estado atual da _store_ como argumentos:
|
|
|
|
|
|
+ Assina as ações do _store_. O `handler` é chamado para cada ação despachada e recebe o descritor de ação e o estado atual do _store_ como argumentos:
|
|
|
|
|
|
``` js
|
|
``` js
|
|
store.subscribeAction((action, state) => {
|
|
store.subscribeAction((action, state) => {
|
|
@@ -171,48 +172,46 @@ O objeto do estado da raiz para a _store_ Vuex. [Detalhes](state.md)
|
|
|
|
|
|
- **`registerModule(path: string | Array<string>, module: Module, options?: Object)`**
|
|
- **`registerModule(path: string | Array<string>, module: Module, options?: Object)`**
|
|
|
|
|
|
- Registra um módulo dinâmico. [Detalhes](modules.md#dynamic-module-registration)
|
|
|
|
|
|
+ Registra um módulo dinâmico. [Detalhes](modules.md#registro-de-módulo-dinâmico)
|
|
|
|
|
|
`options` pode ter `preserveState: true` que permite preservar o estado anterior. Util para renderização server-side.
|
|
`options` pode ter `preserveState: true` que permite preservar o estado anterior. Util para renderização server-side.
|
|
|
|
|
|
- **`unregisterModule(path: string | Array<string>)`**
|
|
- **`unregisterModule(path: string | Array<string>)`**
|
|
|
|
|
|
- Cancela o registro de um módulo dinâmico. [Detalhes](modules.md#dynamic-module-registration)
|
|
|
|
|
|
+ Cancela o registro de um módulo dinâmico. [Detalhes](modules.md#registro-de-módulo-dinâmico)
|
|
|
|
|
|
- **`hotUpdate(newOptions: Object)`**
|
|
- **`hotUpdate(newOptions: Object)`**
|
|
|
|
|
|
Faz Hot swap de novas ações e mutações. [Detalhes](hot-reload.md)
|
|
Faz Hot swap de novas ações e mutações. [Detalhes](hot-reload.md)
|
|
|
|
|
|
-### Component Binding Helpers
|
|
|
|
|
|
+### Métodos Auxiliares dos Componentes
|
|
|
|
|
|
- **`mapState(namespace?: string, map: Array<string> | Object): Object`**
|
|
- **`mapState(namespace?: string, map: Array<string> | Object): Object`**
|
|
|
|
|
|
- Cria componentes computadas de opções que retornam a subárvore da _store_ Vuex. [Detalhes](state.md#the-mapstate-helper)
|
|
|
|
|
|
+ Cria componentes computadas de opções que retornam a subárvore do _store_ Vuex. [Detalhes](state.md#o-auxiliar-mapstate)
|
|
|
|
|
|
- O primeiro argumnto pode ser opcionalmente uma string com namespace. [Detalhes](modules.md#binding-helpers-with-namespace)
|
|
|
|
|
|
+ O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](modules.md#usando-métodos-auxiliares-com-namespace)
|
|
|
|
|
|
- **`mapGetters(namespace?: string, map: Array<string> | Object): Object`**
|
|
- **`mapGetters(namespace?: string, map: Array<string> | Object): Object`**
|
|
|
|
|
|
- Cria componentes computadas de opções que retornam valor avaliado deo getter. [Detalhes](getters.md#the-mapgetters-helper)
|
|
|
|
|
|
+ Criar opções computadas do componente que retornam o valor avaliado de um _getter_. [Detalhes](getters.md#o-auxiliar-mapgetters)
|
|
|
|
|
|
- O primeiro argumento pode ser opcionalmente uma string com namespace. [Detalhes](modules.md#binding-helpers-with-namespace)
|
|
|
|
|
|
+ O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](modules.md#usando-métodos-auxiliares-com-namespace)
|
|
|
|
|
|
- **`mapActions(namespace?: string, map: Array<string> | Object): Object`**
|
|
- **`mapActions(namespace?: string, map: Array<string> | Object): Object`**
|
|
|
|
|
|
Cria um componente com métodos e opções que despacham uma ação.
|
|
Cria um componente com métodos e opções que despacham uma ação.
|
|
|
|
|
|
-[Detalhes](actions.md#dispatching-actions-in-components)
|
|
|
|
|
|
+[Detalhes](actions.md#ações-de-despacho-em-componentes)
|
|
|
|
|
|
- O primeiro argumento pode ser opcionalmente uma string com namespace. [Detalhes](modules.md#binding-helpers-with-namespace)
|
|
|
|
|
|
+ O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](modules.md#usando-métodos-auxiliares-com-namespace)
|
|
|
|
|
|
- **`mapMutations(namespace?: string, map: Array<string> | Object): Object`**
|
|
- **`mapMutations(namespace?: string, map: Array<string> | Object): Object`**
|
|
|
|
|
|
- Cria um componente com métodos e opções que confirmam uma mutação. [Detalhes](mutations.md#committing-mutations-in-components)
|
|
|
|
|
|
+ Cria um componente com métodos e opções que confirmam uma mutação. [Detalhes](mutations.md#fazendo-commit-de-mutações-em-componente)
|
|
|
|
|
|
- O primeiro argumento pode ser opcionalmente uma string com namespace. [Detalhes](modules.md#binding-helpers-with-namespace)
|
|
|
|
|
|
+ O 1º argumento pode ser opcionalmente uma _String_ com _namespace_. [Detalhes](modules.md#usando-métodos-auxiliares-com-namespace)
|
|
|
|
|
|
- **`createNamespacedHelpers(namespace: string): Object`**
|
|
- **`createNamespacedHelpers(namespace: string): Object`**
|
|
|
|
|
|
- Cria um component namespaced ajudante de ligação . O objeto retornado possui `mapState`, `mapGetters`, `mapActions` e `mapMutations`, que estão conectados com o namespace dado. [Detalhes](modules.md#binding-helpers-with-namespace)
|
|
|
|
-
|
|
|
|
-
|
|
|
|
|
|
+ Cria um componente _namespaced_ dos métodos auxiliares. O objeto retornado possui _mapState_, _mapGetters_, _mapActions_ e _mapMutations_, que estão conectados com o dado _namespace_. [Detalhes](modules.md#usando-métodos-auxiliares-com-namespace)
|