|
| 1 | +--- |
| 2 | +title: Client-Side Storage |
| 3 | +type: cookbook |
| 4 | +order: 11 |
| 5 | +--- |
| 6 | + |
| 7 | +## Base Example |
| 8 | + |
| 9 | +Client-side storage is an excellent way to quickly add performance gains to an application. By storing data on the browser itself, you can skip fetching information from the server every time the user needs it. While especially useful when offline, even online users will benefit from using data locally versus a remote server. Client-side storage can be done with [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies), [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API) (technically "Web Storage"), [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API), and [WebSQL](https://www.w3.org/TR/webdatabase/) (a deprecated method that should not be used in new projects). |
| 10 | + |
| 11 | +In this cookbook entry we'll focus on Local Storage, the simplest of the storage mechanisms. Local Storage uses a key/value system for storing data. It is limited to storing only simple values but complex data can be stored if you are willing to encode and decode the values with JSON. In general, Local Storage is appropriate for smaller sets of data you would want to persist, things like user preferences or form data. Larger data with more complex storage needs would be better stored typically in IndexedDB. |
| 12 | + |
| 13 | +Let's begin with a simple form based example: |
| 14 | + |
| 15 | +``` html |
| 16 | +<div id="app"> |
| 17 | + My name is <input v-model="name"> |
| 18 | +</div> |
| 19 | +``` |
| 20 | + |
| 21 | +This example has one form field bound to a Vue value called `name`. Here's the JavaScript: |
| 22 | + |
| 23 | +``` js |
| 24 | +const app = new Vue({ |
| 25 | + el:'#app', |
| 26 | + data: { |
| 27 | + name:'' |
| 28 | + }, |
| 29 | + mounted() { |
| 30 | + if(localStorage.name) this.name = localStorage.name; |
| 31 | + }, |
| 32 | + watch: { |
| 33 | + name(newName) { |
| 34 | + localStorage.name = newName; |
| 35 | + } |
| 36 | + } |
| 37 | +}); |
| 38 | +``` |
| 39 | + |
| 40 | +Focus on the `mounted` and `watch` parts. We use `mounted` to handle loading the value from localStorage. To handle writing the data base, we watch the `name` value and on change, immediately write it. |
| 41 | + |
| 42 | +You can run this yourself here: |
| 43 | + |
| 44 | +<p data-height="265" data-theme-id="0" data-slug-hash="KodaKb" data-default-tab="js,result" data-user="cfjedimaster" data-embed-version="2" data-pen-title="testing localstorage" class="codepen">See the Pen <a href="https://codepen.io/cfjedimaster/pen/KodaKb/">testing localstorage</a> by Raymond Camden (<a href="https://codepen.io/cfjedimaster">@cfjedimaster</a>) on <a href="https://codepen.io">CodePen</a>.</p> |
| 45 | +<script async src="https://static.codepen.io/assets/embed/ei.js"></script> |
| 46 | + |
| 47 | +Type something in the form and then reload this page. You'll note that the value you typed previously will show up automatically. Don't forget that your browser provides excellent developer tools for inspecting client-side storage. Here's an example in Firefox: |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +And here it is in Chrome: |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +And then finally, an example in Microsoft Edge. Note that you can find application storage values under the Debugger tab. |
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | +<p class="tip">As a quick aside, these dev tools also offer you a way to remove storage values. This can be very useful when testing.</p> |
| 60 | + |
| 61 | +Immediately writing the value may not advisable. Let's consider a slightly more advanced example. First, the updated form. |
| 62 | + |
| 63 | +``` html |
| 64 | +<div id="app"> |
| 65 | + My name is <input v-model="name"> |
| 66 | + and I am <input v-model="age"> years old. |
| 67 | + <p/> |
| 68 | + <button @click="persist">Save</button> |
| 69 | +</div> |
| 70 | +``` |
| 71 | + |
| 72 | +Now we've got two fields (again, bound to a Vue instance) but now there is the addition of a button that runs a `persist` method. Let's look at the JavaScript. |
| 73 | + |
| 74 | +``` js |
| 75 | +const app = new Vue({ |
| 76 | + el:'#app', |
| 77 | + data: { |
| 78 | + name:'', |
| 79 | + age:0 |
| 80 | + }, |
| 81 | + mounted() { |
| 82 | + if(localStorage.name) this.name = localStorage.name; |
| 83 | + if(localStorage.age) this.age = localStorage.age; |
| 84 | + }, |
| 85 | + methods: { |
| 86 | + persist() { |
| 87 | + localStorage.name = this.name; |
| 88 | + localStorage.age = this.age; |
| 89 | + console.log('now pretend I did more stuff...'); |
| 90 | + } |
| 91 | + } |
| 92 | +}) |
| 93 | +``` |
| 94 | + |
| 95 | +As before, `mounted` is used to load persisted data, if it exists. This time, though, data is only persisted when the button is clicked. We could also do any validations or transformations here before storing the value. You could also store a date representing when the values were stored. With that metadata, the `mounted` method could make a logical call on whether or not to store the values again, such as in this version below. You can try this version below. |
| 96 | + |
| 97 | +<p data-height="265" data-theme-id="0" data-slug-hash="rdOjLN" data-default-tab="js,result" data-user="cfjedimaster" data-embed-version="2" data-pen-title="testing localstorage 2" class="codepen">See the Pen <a href="https://codepen.io/cfjedimaster/pen/rdOjLN/">testing localstorage 2</a> by Raymond Camden (<a href="https://codepen.io/cfjedimaster">@cfjedimaster</a>) on <a href="https://codepen.io">CodePen</a>.</p> |
| 98 | +<script async src="https://static.codepen.io/assets/embed/ei.js"></script> |
| 99 | + |
| 100 | +## Working with Complex Values |
| 101 | + |
| 102 | +As mentioned above, Local Storage only works with simple values. To store more complex values, like objects or arrays, you must serialize and deserialize the values with JSON. Here is a more advanced example that persists an array of cats (the best kind of array possible). |
| 103 | + |
| 104 | +``` html |
| 105 | +<div id="app"> |
| 106 | + <h2>Cats</h2> |
| 107 | + <div v-for="(cat,n) in cats"> |
| 108 | + <p> |
| 109 | + <span class="cat">{{cat}}</span> <button @click="removeCat(n)">Remove</button> |
| 110 | + </p> |
| 111 | + </div> |
| 112 | + |
| 113 | + <p> |
| 114 | + <input v-model="newCat"> |
| 115 | + <button @click="addCat">Add Cat</button> |
| 116 | + </p> |
| 117 | + |
| 118 | +</div> |
| 119 | +``` |
| 120 | + |
| 121 | +This "app" consists of a simple list on top (with a button to remove a cat) and a small form at the bottom to add a new cat. Now let's look at the JavaScript. |
| 122 | + |
| 123 | +``` js |
| 124 | +const app = new Vue({ |
| 125 | + el:'#app', |
| 126 | + data: { |
| 127 | + cats:[], |
| 128 | + newCat:null |
| 129 | + }, |
| 130 | + mounted() { |
| 131 | + |
| 132 | + if(localStorage.getItem('cats')) { |
| 133 | + try { |
| 134 | + this.cats = JSON.parse(localStorage.getItem('cats')); |
| 135 | + } catch(e) { |
| 136 | + localStorage.removeItem('cats'); |
| 137 | + } |
| 138 | + } |
| 139 | + }, |
| 140 | + methods: { |
| 141 | + addCat() { |
| 142 | + // ensure they actually typed something |
| 143 | + if(!this.newCat) return; |
| 144 | + this.cats.push(this.newCat); |
| 145 | + this.newCat = ''; |
| 146 | + this.saveCats(); |
| 147 | + }, |
| 148 | + removeCat(x) { |
| 149 | + this.cats.splice(x,1); |
| 150 | + this.saveCats(); |
| 151 | + }, |
| 152 | + saveCats() { |
| 153 | + let parsed = JSON.stringify(this.cats); |
| 154 | + localStorage.setItem('cats', parsed); |
| 155 | + } |
| 156 | + } |
| 157 | +}) |
| 158 | +``` |
| 159 | + |
| 160 | +In this application, we've switched to use the Local Storage APIs versus "direct" access. Both work but the API method is generally preferred. `mounted` now has to grab the value and parse the JSON value. If anything goes wrong here we assume the data is corrupt and delete it. (Remember, any time your web application uses client-side storage, the user has access to it and can modify it at will.) |
| 161 | + |
| 162 | +We have three methods now to handle working with cat. Both `addCat` and `removeCat` handle updating the "live" Vue data stored in `this.cats`. They then run `saveCats` which handles serializing and persisting the data. You can play with this version below: |
| 163 | + |
| 164 | +<p data-height="265" data-theme-id="0" data-slug-hash="qoYbyW" data-default-tab="js,result" data-user="cfjedimaster" data-embed-version="2" data-pen-title="localstorage, complex" class="codepen">See the Pen <a href="https://codepen.io/cfjedimaster/pen/qoYbyW/">localstorage, complex</a> by Raymond Camden (<a href="https://codepen.io/cfjedimaster">@cfjedimaster</a>) on <a href="https://codepen.io">CodePen</a>.</p> |
| 165 | +<script async src="https://static.codepen.io/assets/embed/ei.js"></script> |
| 166 | + |
| 167 | +## Alternative Patterns |
| 168 | + |
| 169 | +While the Local Storage API is relatively simple, it is missing some basic features that would be useful in many applications. The following plugins wrap Local Storage access and make it easier to use, while also adding functionality like default values. |
| 170 | + |
| 171 | +* [vue-local-storage](https://github.com/pinguinjkeke/vue-local-storage) |
| 172 | +* [vue-reactive-storage](https://github.com/ropbla9/vue-reactive-storage) |
| 173 | + |
| 174 | +## Wrapping Up |
| 175 | + |
| 176 | +While the browser will never replace a server persistence system, having multiple ways to cache data locally can be a huge performance boost for your application, and working with it in Vue.js makes it even more powerful. |
0 commit comments