getters.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556
  1. <!DOCTYPE HTML>
  2. <html lang="pt-br" >
  3. <head>
  4. <meta charset="UTF-8">
  5. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  6. <title>Getters · Vuex</title>
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  8. <meta name="description" content="">
  9. <meta name="generator" content="GitBook 3.2.2">
  10. <link rel="stylesheet" href="../gitbook/style.css">
  11. <link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
  12. <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
  13. <link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-vuejs/vue.css">
  14. <meta name="HandheldFriendly" content="true"/>
  15. <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
  16. <meta name="apple-mobile-web-app-capable" content="yes">
  17. <meta name="apple-mobile-web-app-status-bar-style" content="black">
  18. <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
  19. <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
  20. <link rel="next" href="mutations.html" />
  21. <link rel="prev" href="state.html" />
  22. </head>
  23. <body>
  24. <div class="book">
  25. <div class="book-summary">
  26. <div id="book-search-input" role="search">
  27. <input type="text" placeholder="Escreva para pesquisar" />
  28. </div>
  29. <nav role="navigation">
  30. <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=vuejs" id="_carbonads_js"></script>
  31. <ul class="summary">
  32. <li class="chapter " data-level="1.1" data-path="./">
  33. <a href="./">
  34. Introduction
  35. </a>
  36. </li>
  37. <li class="chapter " data-level="1.2" >
  38. <a target="_blank" href="https://github.com/vuejs/vuex/releases">
  39. Notas de versão
  40. </a>
  41. </li>
  42. <li class="chapter " data-level="1.3" data-path="installation.html">
  43. <a href="installation.html">
  44. Instalação
  45. </a>
  46. </li>
  47. <li class="chapter " data-level="1.4" data-path="intro.html">
  48. <a href="intro.html">
  49. O que é Vuex?
  50. </a>
  51. </li>
  52. <li class="chapter " data-level="1.5" data-path="getting-started.html">
  53. <a href="getting-started.html">
  54. Começando
  55. </a>
  56. </li>
  57. <li class="chapter " data-level="1.6" data-path="core-concepts.html">
  58. <a href="core-concepts.html">
  59. Conceitos do núcleo
  60. </a>
  61. <ul class="articles">
  62. <li class="chapter " data-level="1.6.1" data-path="state.html">
  63. <a href="state.html">
  64. Estado
  65. </a>
  66. </li>
  67. <li class="chapter active" data-level="1.6.2" data-path="getters.html">
  68. <a href="getters.html">
  69. Getters
  70. </a>
  71. </li>
  72. <li class="chapter " data-level="1.6.3" data-path="mutations.html">
  73. <a href="mutations.html">
  74. Mutações
  75. </a>
  76. </li>
  77. <li class="chapter " data-level="1.6.4" data-path="actions.html">
  78. <a href="actions.html">
  79. Ações
  80. </a>
  81. </li>
  82. <li class="chapter " data-level="1.6.5" data-path="modules.html">
  83. <a href="modules.html">
  84. Módulos
  85. </a>
  86. </li>
  87. </ul>
  88. </li>
  89. <li class="chapter " data-level="1.7" data-path="structure.html">
  90. <a href="structure.html">
  91. Estrutura da Aplicação
  92. </a>
  93. </li>
  94. <li class="chapter " data-level="1.8" data-path="plugins.html">
  95. <a href="plugins.html">
  96. Plugins
  97. </a>
  98. </li>
  99. <li class="chapter " data-level="1.9" data-path="strict.html">
  100. <a href="strict.html">
  101. Modo estrito
  102. </a>
  103. </li>
  104. <li class="chapter " data-level="1.10" data-path="forms.html">
  105. <a href="forms.html">
  106. Manipulação de formulários
  107. </a>
  108. </li>
  109. <li class="chapter " data-level="1.11" data-path="testing.html">
  110. <a href="testing.html">
  111. Teste
  112. </a>
  113. </li>
  114. <li class="chapter " data-level="1.12" data-path="hot-reload.html">
  115. <a href="hot-reload.html">
  116. Hot Reload
  117. </a>
  118. </li>
  119. <li class="chapter " data-level="1.13" data-path="api.html">
  120. <a href="api.html">
  121. Referência da API
  122. </a>
  123. </li>
  124. <li class="divider"></li>
  125. <li>
  126. <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
  127. Publicado com GitBook
  128. </a>
  129. </li>
  130. </ul>
  131. </nav>
  132. </div>
  133. <div class="book-body">
  134. <div class="body-inner">
  135. <div class="book-header" role="navigation">
  136. <!-- Title -->
  137. <h1>
  138. <i class="fa fa-circle-o-notch fa-spin"></i>
  139. <a href="." >Getters</a>
  140. </h1>
  141. </div>
  142. <div class="page-wrapper" tabindex="-1" role="main">
  143. <div class="page-inner">
  144. <div id="book-search-results">
  145. <div class="search-noresults">
  146. <section class="normal markdown-section">
  147. <h1 id="getters">Getters</h1>
  148. <p>&#xC0;s vezes, talvez precisemos calcular o estado derivado com base no estado da <em>store</em> , por exemplo, filtrar atrav&#xE9;s de uma lista de itens e cont&#xE1;-los:</p>
  149. <pre class="language-"><code class="lang-js">computed<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  150. doneTodosCount <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
  151. <span class="token keyword">return</span> <span class="token keyword">this</span><span class="token punctuation">.</span>$store<span class="token punctuation">.</span>state<span class="token punctuation">.</span>todos<span class="token punctuation">.</span><span class="token function">filter</span><span class="token punctuation">(</span>todo <span class="token operator">=</span><span class="token operator">&gt;</span> todo<span class="token punctuation">.</span>done<span class="token punctuation">)</span><span class="token punctuation">.</span>length
  152. <span class="token punctuation">}</span>
  153. <span class="token punctuation">}</span>
  154. </code></pre>
  155. <p>Se mais do que um componente precisa fazer uso disso, temos que duplicar a fun&#xE7;&#xE3;o, ou extra&#xED;-lo em um auxiliar compartilhado e import&#xE1;-lo em v&#xE1;rios lugares - ambos s&#xE3;o menos do que o ideal.
  156. O Vuex nos permite definir &quot;getters&quot; na <em>store</em> . Voc&#xEA; pode pensar neles como dados computados para <em>stores</em> . Como os dados computados, o resultado de um getter &#xE9; armazenado em cache com base em suas depend&#xEA;ncias e s&#xF3; ir&#xE1; avaliar novamente quando algumas de suas depend&#xEA;ncias mudarem.</p>
  157. <p>Getters receberam o estado como seu primeiro argumento:</p>
  158. <pre class="language-"><code class="lang-js"><span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
  159. state<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  160. todos<span class="token punctuation">:</span> <span class="token punctuation">[</span>
  161. <span class="token punctuation">{</span> id<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span> text<span class="token punctuation">:</span> <span class="token string">&apos;...&apos;</span><span class="token punctuation">,</span> done<span class="token punctuation">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
  162. <span class="token punctuation">{</span> id<span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span> text<span class="token punctuation">:</span> <span class="token string">&apos;...&apos;</span><span class="token punctuation">,</span> done<span class="token punctuation">:</span> <span class="token boolean">false</span> <span class="token punctuation">}</span>
  163. <span class="token punctuation">]</span>
  164. <span class="token punctuation">}</span><span class="token punctuation">,</span>
  165. getters<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  166. doneTodos<span class="token punctuation">:</span> state <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">{</span>
  167. <span class="token keyword">return</span> state<span class="token punctuation">.</span>todos<span class="token punctuation">.</span><span class="token function">filter</span><span class="token punctuation">(</span>todo <span class="token operator">=</span><span class="token operator">&gt;</span> todo<span class="token punctuation">.</span>done<span class="token punctuation">)</span>
  168. <span class="token punctuation">}</span>
  169. <span class="token punctuation">}</span>
  170. <span class="token punctuation">}</span><span class="token punctuation">)</span>
  171. </code></pre>
  172. <p>Os getters ser&#xE3;o descritos no objeto <code>store.getters</code>:</p>
  173. <pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span>getters<span class="token punctuation">.</span>doneTodos <span class="token comment" spellcheck="true">// -&gt; [{ id: 1, text: &apos;...&apos;, done: true }]</span>
  174. </code></pre>
  175. <p>Getters tamb&#xE9;m receber&#xE1; outros getters como o segundo argumento:</p>
  176. <pre class="language-"><code class="lang-js">getters<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  177. <span class="token comment" spellcheck="true">// ...</span>
  178. doneTodosCount<span class="token punctuation">:</span> <span class="token punctuation">(</span>state<span class="token punctuation">,</span> getters<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">{</span>
  179. <span class="token keyword">return</span> getters<span class="token punctuation">.</span>doneTodos<span class="token punctuation">.</span>length
  180. <span class="token punctuation">}</span>
  181. <span class="token punctuation">}</span>
  182. </code></pre>
  183. <pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span>getters<span class="token punctuation">.</span>doneTodosCount <span class="token comment" spellcheck="true">// -&gt; 1</span>
  184. </code></pre>
  185. <p>Agora podemos usar facilmente isso dentro de qualquer componente:</p>
  186. <pre class="language-"><code class="lang-js">computed<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  187. doneTodosCount <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
  188. <span class="token keyword">return</span> <span class="token keyword">this</span><span class="token punctuation">.</span>$store<span class="token punctuation">.</span>getters<span class="token punctuation">.</span>doneTodosCount
  189. <span class="token punctuation">}</span>
  190. <span class="token punctuation">}</span>
  191. </code></pre>
  192. <p>Voc&#xEA; tamb&#xE9;m pode passar argumentos para getters retornando uma fun&#xE7;&#xE3;o. Isso &#xE9; particularmente &#xFA;til quando voc&#xEA; deseja consultar um <em>array</em> na <em>store</em> :</p>
  193. <pre class="language-"><code class="lang-js">getters<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  194. <span class="token comment" spellcheck="true">// ...</span>
  195. getTodoById<span class="token punctuation">:</span> <span class="token punctuation">(</span>state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">(</span>id<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token punctuation">{</span>
  196. <span class="token keyword">return</span> state<span class="token punctuation">.</span>todos<span class="token punctuation">.</span><span class="token function">find</span><span class="token punctuation">(</span>todo <span class="token operator">=</span><span class="token operator">&gt;</span> todo<span class="token punctuation">.</span>id <span class="token operator">===</span> id<span class="token punctuation">)</span>
  197. <span class="token punctuation">}</span>
  198. <span class="token punctuation">}</span>
  199. </code></pre>
  200. <pre class="language-"><code class="lang-js">store<span class="token punctuation">.</span>getters<span class="token punctuation">.</span><span class="token function">getTodoById</span><span class="token punctuation">(</span><span class="token number">2</span><span class="token punctuation">)</span> <span class="token comment" spellcheck="true">// -&gt; { id: 2, text: &apos;...&apos;, done: false }</span>
  201. </code></pre>
  202. <h3 id="o-auxiliar-mapgetters">O auxiliar <code>mapGetters</code></h3>
  203. <p>O auxiliar <code>mapGetters</code> simplesmente mapeia os getters da <em>store</em> para os dados computados locais:</p>
  204. <pre class="language-"><code class="lang-js"><span class="token keyword">import</span> <span class="token punctuation">{</span> mapGetters <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">&apos;vuex&apos;</span>
  205. <span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token punctuation">{</span>
  206. <span class="token comment" spellcheck="true">// ...</span>
  207. computed<span class="token punctuation">:</span> <span class="token punctuation">{</span>
  208. <span class="token comment" spellcheck="true">// misturar os getters em dados computados com o spread operator</span>
  209. <span class="token operator">...</span><span class="token function">mapGetters</span><span class="token punctuation">(</span><span class="token punctuation">[</span>
  210. <span class="token string">&apos;doneTodosCount&apos;</span><span class="token punctuation">,</span>
  211. <span class="token string">&apos;anotherGetter&apos;</span><span class="token punctuation">,</span>
  212. <span class="token comment" spellcheck="true">// ...</span>
  213. <span class="token punctuation">]</span><span class="token punctuation">)</span>
  214. <span class="token punctuation">}</span>
  215. <span class="token punctuation">}</span>
  216. </code></pre>
  217. <p>Se voc&#xEA; deseja mapear um getter para um nome diferente, use um objeto:</p>
  218. <pre class="language-"><code class="lang-js"><span class="token operator">...</span><span class="token function">mapGetters</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
  219. <span class="token comment" spellcheck="true">// mapeia `this.doneCount` para `store.getters.doneTodosCount`</span>
  220. doneCount<span class="token punctuation">:</span> <span class="token string">&apos;doneTodosCount&apos;</span>
  221. <span class="token punctuation">}</span><span class="token punctuation">)</span>
  222. </code></pre>
  223. </section>
  224. </div>
  225. <div class="search-results">
  226. <div class="has-results">
  227. <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
  228. <ul class="search-results-list"></ul>
  229. </div>
  230. <div class="no-results">
  231. <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
  232. </div>
  233. </div>
  234. </div>
  235. </div>
  236. </div>
  237. <script src="//m.servedby-buysellads.com/monetization.js" type="text/javascript"></script>
  238. <div class="bsa-cpc"></div>
  239. <script>
  240. (function(){
  241. if(typeof _bsa !== 'undefined' && _bsa) {
  242. _bsa.init('default', 'CKYD62QM', 'placement:vuejsorg', {
  243. target: '.bsa-cpc',
  244. align: 'horizontal',
  245. disable_css: 'true'
  246. });
  247. }
  248. })();
  249. </script>
  250. </div>
  251. <a href="state.html" class="navigation navigation-prev " aria-label="Previous page: Estado">
  252. <i class="fa fa-angle-left"></i>
  253. </a>
  254. <a href="mutations.html" class="navigation navigation-next " aria-label="Next page: Mutações">
  255. <i class="fa fa-angle-right"></i>
  256. </a>
  257. </div>
  258. <script>
  259. var gitbook = gitbook || [];
  260. gitbook.push(function() {
  261. gitbook.page.hasChanged({"page":{"title":"Getters","level":"1.6.2","depth":2,"next":{"title":"Mutações","level":"1.6.3","depth":2,"path":"mutations.md","ref":"mutations.md","articles":[]},"previous":{"title":"Estado","level":"1.6.1","depth":2,"path":"state.md","ref":"state.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","prism","-highlight","github","-highlight","github"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"edit-link":{"label":"Edite esta página","base":"https://github.com/vuejs/vuex/tree/dev/docs"},"github":{"url":"https://github.com/vuejs/vuex/"},"prism":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-vuejs":{},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Vuex","language":"pt-br","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"2.x.x"},"file":{"path":"getters.md","mtime":"2018-04-20T00:44:03.877Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-04-20T00:47:55.633Z"},"basePath":".","book":{"language":"pt-br"}});
  262. });
  263. </script>
  264. </div>
  265. <script src="../gitbook/gitbook.js"></script>
  266. <script src="../gitbook/theme.js"></script>
  267. <script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script>
  268. <script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
  269. <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
  270. <script src="../gitbook/gitbook-plugin-search/search.js"></script>
  271. <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
  272. <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
  273. <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
  274. </body>
  275. </html>