-
Notifications
You must be signed in to change notification settings - Fork 48
/
Copy pathindex.html
382 lines (362 loc) · 25.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>@rehooks/local-storage</title>
<meta name="description" content="Documentation for @rehooks/local-storage">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">@rehooks/local-storage</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>@rehooks/local-storage</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#rehookslocal-storage" id="rehookslocal-storage" style="color: inherit; text-decoration: none;">
<h1>@rehooks/local-storage</h1>
</a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<p><a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square" alt="All Contributors"></a></p>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<blockquote>
<p>React hook for enabling synchronization with local-storage.</p>
</blockquote>
<p><a href="https://www.npmjs.com/package/@rehooks/local-storage"><img src="https://badge.fury.io/js/%40rehooks%2Flocal-storage.svg" alt="npm version"></a>
<a href="https://www.npmjs.com/package/@rehooks/local-storage"><img src="https://img.shields.io/npm/dw/@rehooks/local-storage" alt="npm downloads"></a></p>
<p>API Docs can be found <a href="https://rehooks.github.io/local-storage">here</a>.</p>
<a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;">
<h2>Table of Contents</h2>
</a>
<ul>
<li><a href="#rehookslocal-storage">@rehooks/local-storage</a><ul>
<li><a href="#table-of-contents">Table of Contents</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#install">Install</a><ul>
<li><a href="#with-yarn">With Yarn</a></li>
<li><a href="#with-npm">With NPM</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a><ul>
<li><a href="#write-to-storage">Write to Storage</a></li>
<li><a href="#read-from-storage">Read From Storage</a><ul>
<li><a href="#optionally-use-a-default-value">Optionally use a default value</a></li>
</ul>
</li>
<li><a href="#delete-from-storage">Delete From Storage</a></li>
<li><a href="#using-with-context">Using With Context</a></li>
</ul>
</li>
<li><a href="#full-example">Full Example</a></li>
<li><a href="#contributors-">Contributors ✨</a></li>
</ul>
</li>
</ul>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h2>Features</h2>
</a>
<ul>
<li>Automatic JSON serialization</li>
<li>Synchronization across multiple tabs</li>
<li>Provides functions for updating the localStorage and triggering a state update outside of the component</li>
<li>Type hinting via TypeScript</li>
</ul>
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
<h2>Install</h2>
</a>
<a href="#with-yarn" id="with-yarn" style="color: inherit; text-decoration: none;">
<h3>With Yarn</h3>
</a>
<pre><code class="language-sh">yarn add @rehooks/<span class="hljs-built_in">local</span>-storage</code></pre>
<a href="#with-npm" id="with-npm" style="color: inherit; text-decoration: none;">
<h3>With NPM</h3>
</a>
<pre><code class="language-sh">npm i @rehooks/<span class="hljs-built_in">local</span>-storage --save</code></pre>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<a href="#write-to-storage" id="write-to-storage" style="color: inherit; text-decoration: none;">
<h3>Write to Storage</h3>
</a>
<p>This can be anywhere from within your application.</p>
<blockquote>
<p>Note: Objects that are passed to writeStorage are automatically stringified.
This will not work for circular structures.</p>
</blockquote>
<pre><code class="language-jsx"><span class="hljs-keyword">import</span> React <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> { writeStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
<span class="hljs-keyword">let</span> counter = <span class="hljs-number">0</span>;
<span class="hljs-keyword">const</span> MyButton = <span class="hljs-function">() =></span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">button</span> <span class="hljs-attr">onClick</span>=<span class="hljs-string">{_</span> =></span> writeStorage('i', ++counter)}>
Click Me
<span class="hljs-tag"></<span class="hljs-name">button</span>></span></span>
);
</code></pre>
<a href="#read-from-storage" id="read-from-storage" style="color: inherit; text-decoration: none;">
<h3>Read From Storage</h3>
</a>
<p>This component will receive updates to itself from local storage.</p>
<p><strong>Javascript</strong>:</p>
<pre><code class="language-jsx"><span class="hljs-keyword">import</span> React <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> { useLocalStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">MyComponent</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">const</span> [counterValue] = useLocalStorage(<span class="hljs-string">'i'</span>); <span class="hljs-comment">// send the key to be tracked.</span>
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">div</span>></span>
<span class="hljs-tag"><<span class="hljs-name">h1</span>></span>{counterValue}<span class="hljs-tag"></<span class="hljs-name">h1</span>></span>
<span class="hljs-tag"></<span class="hljs-name">div</span>></span></span>
);
}</code></pre>
<p><strong>Typescript</strong>:</p>
<pre><code class="language-tsx">import React from 'react';
import { useLocalStorage } from '@rehooks/local-storage';
function MyComponent() {
const [counterValue] = useLocalStorage<number>('i'); // specify a type argument for your type
// Note: Since there was no default value provided, this is potentially null.
return (
<div>
<h1>{counterValue}</h1>
</div>
);
}</code></pre>
<a href="#optionally-use-a-default-value" id="optionally-use-a-default-value" style="color: inherit; text-decoration: none;">
<h4>Optionally use a default value</h4>
</a>
<blockquote>
<p>Note: Objects that are passed to useLocalStorage's default parameter will be automatically
stringified. This will not work for circular structures.</p>
</blockquote>
<pre><code class="language-jsx"><span class="hljs-keyword">import</span> React <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> { useLocalStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">MyComponent</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-comment">// Note: The type of user can be inferred from the default value type</span>
<span class="hljs-keyword">const</span> [user] = useLocalStorage(<span class="hljs-string">'user'</span>, { <span class="hljs-attr">name</span>: <span class="hljs-string">'Anakin Skywalker'</span> });
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">div</span>></span>
<span class="hljs-tag"><<span class="hljs-name">h1</span>></span>{user.name}<span class="hljs-tag"></<span class="hljs-name">h1</span>></span>
<span class="hljs-tag"></<span class="hljs-name">div</span>></span></span>
);
}</code></pre>
<a href="#delete-from-storage" id="delete-from-storage" style="color: inherit; text-decoration: none;">
<h3>Delete From Storage</h3>
</a>
<p>You may also delete items from the local storage as well.</p>
<pre><code class="language-js"><span class="hljs-keyword">import</span> { writeStorage, deleteFromStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
writeStorage(<span class="hljs-string">'name'</span>, <span class="hljs-string">'Homer Simpson'</span>); <span class="hljs-comment">// Add an item first</span>
deleteFromStorage(<span class="hljs-string">'name'</span>); <span class="hljs-comment">// Deletes the item</span>
<span class="hljs-keyword">const</span> thisIsNull = <span class="hljs-built_in">localStorage</span>.getItem(<span class="hljs-string">'name'</span>); <span class="hljs-comment">// This is indeed null</span></code></pre>
<a href="#using-with-context" id="using-with-context" style="color: inherit; text-decoration: none;">
<h3>Using With Context</h3>
</a>
<p>It is advisable to use this hook with context if you want to have a properly
synchronized default value. Using <code>useLocalStorage</code> in two different components
with the same key but different default values can lead to unexpected behaviour.</p>
<p>Using Context will also prevent components from rendering and setting
default values to the localStorage when you just want them to be deleted from localStorage
(assuming the context provider also does not re-render).</p>
<pre><code class="language-jsx"><span class="hljs-keyword">import</span> React, { createContext, useContext } <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> { useLocalStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
<span class="hljs-keyword">const</span> defaultProfile = { <span class="hljs-attr">name</span>: <span class="hljs-string">'Spongekebob'</span> };
<span class="hljs-keyword">const</span> defaultContextValue = [defaultProfile, <span class="hljs-function">() =></span> {}, <span class="hljs-function">() =></span> {}];
<span class="hljs-keyword">const</span> ProfileContext = createContext(defaultContextValue);
<span class="hljs-keyword">export</span> <span class="hljs-keyword">const</span> ProfileProvider = <span class="hljs-function">(<span class="hljs-params">{ children }</span>) =></span> {
<span class="hljs-keyword">const</span> ctxValue = useLocalStorage(<span class="hljs-string">'profile'</span>, defaultProfile);
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">ProfileContext.Provider</span> <span class="hljs-attr">value</span>=<span class="hljs-string">{ctxValue}</span>></span>
{children}
<span class="hljs-tag"></<span class="hljs-name">ProfileContext.Provider</span>></span></span>
);
};
<span class="hljs-keyword">const</span> useProfile = <span class="hljs-function">() =></span> useContext(ProfileContext);
<span class="hljs-keyword">const</span> App = <span class="hljs-function">() =></span> {
<span class="hljs-keyword">const</span> [profile] = useProfile();
<span class="hljs-keyword">return</span> <span class="xml"><span class="hljs-tag"><<span class="hljs-name">h1</span>></span>{profile && profile.name}<span class="hljs-tag"></<span class="hljs-name">h1</span>></span></span>;
};
<span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> () => {
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">ProfileProvider</span>></span>
<span class="hljs-tag"><<span class="hljs-name">App</span> /></span>
<span class="hljs-tag"></<span class="hljs-name">ProfileProvider</span>></span></span>
);
};</code></pre>
<a href="#full-example" id="full-example" style="color: inherit; text-decoration: none;">
<h2>Full Example</h2>
</a>
<p>You may view this example <a href="https://stackblitz.com/edit/react-vbrkjb?embed=1&file=index.js">here on StackBlitz.</a></p>
<blockquote>
<p>Note: The writeStorage and deleteFromStorage functions are provided from useLocalStorage as well,
and do not require you to specify the key when using them.</p>
</blockquote>
<pre><code class="language-jsx"><span class="hljs-keyword">import</span> React, { Fragment } <span class="hljs-keyword">from</span> <span class="hljs-string">'react'</span>;
<span class="hljs-keyword">import</span> { render } <span class="hljs-keyword">from</span> <span class="hljs-string">'react-dom'</span>;
<span class="hljs-keyword">import</span> { writeStorage, deleteFromStorage, useLocalStorage } <span class="hljs-keyword">from</span> <span class="hljs-string">'@rehooks/local-storage'</span>;
<span class="hljs-keyword">const</span> startingNum = <span class="hljs-number">0</span>;
<span class="hljs-keyword">const</span> Clicker = <span class="hljs-function">() =></span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">Fragment</span>></span>
<span class="hljs-tag"><<span class="hljs-name">h4</span>></span>Clicker<span class="hljs-tag"></<span class="hljs-name">h4</span>></span>
<span class="hljs-tag"><<span class="hljs-name">button</span> <span class="hljs-attr">onClick</span>=<span class="hljs-string">{_</span> =></span> {
writeStorage('num', localStorage.getItem('num')
? +(localStorage.getItem('num')) + 1
: startingNum
)
}}>
Increment From Outside
<span class="hljs-tag"></<span class="hljs-name">button</span>></span>
<span class="hljs-tag"><<span class="hljs-name">button</span> <span class="hljs-attr">onClick</span>=<span class="hljs-string">{_</span> =></span> deleteFromStorage('num')}>
Delete From Outside
<span class="hljs-tag"></<span class="hljs-name">button</span>></span>
<span class="hljs-tag"></<span class="hljs-name">Fragment</span>></span></span>
);
<span class="hljs-keyword">const</span> IncrememterWithButtons = <span class="hljs-function">() =></span> {
<span class="hljs-keyword">const</span> [number, setNum, deleteNum] = useLocalStorage(<span class="hljs-string">'num'</span>);
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">Fragment</span>></span>
<span class="hljs-tag"><<span class="hljs-name">p</span>></span>{typeof(number) === 'number' ? number : 'Try incrementing the number!'}<span class="hljs-tag"></<span class="hljs-name">p</span>></span>
<span class="hljs-tag"><<span class="hljs-name">button</span> <span class="hljs-attr">onClick</span>=<span class="hljs-string">{_</span> =></span> setNum(number !== null ? +(number) + 1 : startingNum)}>Increment<span class="hljs-tag"></<span class="hljs-name">button</span>></span>
<span class="hljs-tag"><<span class="hljs-name">button</span> <span class="hljs-attr">onClick</span>=<span class="hljs-string">{deleteNum}</span>></span>Delete<span class="hljs-tag"></<span class="hljs-name">button</span>></span>
<span class="hljs-tag"></<span class="hljs-name">Fragment</span>></span></span>
);
};
<span class="hljs-keyword">const</span> App = <span class="hljs-function">() =></span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">Fragment</span>></span>
<span class="hljs-tag"><<span class="hljs-name">h1</span>></span> Demo <span class="hljs-tag"></<span class="hljs-name">h1</span>></span>
<span class="hljs-tag"><<span class="hljs-name">IncrememterWithButtons</span> /></span>
<span class="hljs-tag"><<span class="hljs-name">Clicker</span> /></span>
<span class="hljs-tag"></<span class="hljs-name">Fragment</span>></span></span>
);
<span class="hljs-comment">// Assuming there is a div in index.html with an ID of 'root'</span>
render(<span class="xml"><span class="hljs-tag"><<span class="hljs-name">App</span> /></span></span>, <span class="hljs-built_in">document</span>.getElementById(<span class="hljs-string">'root'</span>));</code></pre>
<a href="#contributors-✨" id="contributors-✨" style="color: inherit; text-decoration: none;">
<h2>Contributors ✨</h2>
</a>
<p>Thanks goes to these wonderful people (<a href="https://allcontributors.org/docs/en/emoji-key">emoji key</a>):</p>
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="http://solankiamit.com"><img src="https://avatars3.githubusercontent.com/u/3483526?v=4" width="100px;" alt=""/><br /><sub><b>Amit Solanki</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=iamsolankiamit" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/commits?author=iamsolankiamit" title="Documentation">📖</a> <a href="#ideas-iamsolankiamit" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/rehooks/local-storage/pulls?q=is%3Apr+reviewed-by%3Aiamsolankiamit" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://jharrilim.github.io/"><img src="https://avatars1.githubusercontent.com/u/19535809?v=4" width="100px;" alt=""/><br /><sub><b>Joe</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=jharrilim" title="Code">💻</a> <a href="#example-jharrilim" title="Examples">💡</a> <a href="#ideas-jharrilim" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-jharrilim" title="Maintenance">🚧</a> <a href="https://github.com/rehooks/local-storage/pulls?q=is%3Apr+reviewed-by%3Ajharrilim" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/rehooks/local-storage/commits?author=jharrilim" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/fatihky"><img src="https://avatars0.githubusercontent.com/u/4169772?v=4" width="100px;" alt=""/><br /><sub><b>Fatih Kaya</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=fatihky" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/commits?author=fatihky" title="Tests">⚠️</a> <a href="https://github.com/rehooks/local-storage/issues?q=author%3Afatihky" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://hübenthal.no"><img src="https://avatars3.githubusercontent.com/u/404102?v=4" width="100px;" alt=""/><br /><sub><b>Jarl André Hübenthal</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=jarlah" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/commits?author=jarlah" title="Tests">⚠️</a> <a href="https://github.com/rehooks/local-storage/issues?q=author%3Ajarlah" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://jamie.build/"><img src="https://avatars0.githubusercontent.com/u/952783?v=4" width="100px;" alt=""/><br /><sub><b>Jamie Kyle</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=jamiebuilds" title="Code">💻</a></td>
<td align="center"><a href="http://devalbo.blogspot.com/"><img src="https://avatars3.githubusercontent.com/u/1653890?v=4" width="100px;" alt=""/><br /><sub><b>Albert Boehmler</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=devalbo" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/issues?q=author%3Adevalbo" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/gmdayley"><img src="https://avatars3.githubusercontent.com/u/647130?v=4" width="100px;" alt=""/><br /><sub><b>Gabriel Dayley</b></sub></a><br /><a href="https://github.com/rehooks/local-storage/commits?author=gmdayley" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/issues?q=author%3Agmdayley" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/mayteio"><img src="https://avatars1.githubusercontent.com/u/43975092?v=4" width="100px;" alt=""/><br /><sub><b>Harley Alexander</b></sub></a><br /><a href="#maintenance-mayteio" title="Maintenance">🚧</a> <a href="https://github.com/rehooks/local-storage/commits?author=mayteio" title="Code">💻</a> <a href="https://github.com/rehooks/local-storage/issues?q=author%3Amayteio" title="Bug reports">🐛</a> <a href="https://github.com/rehooks/local-storage/commits?author=mayteio" title="Tests">⚠️</a></td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<p>This project follows the <a href="https://github.com/all-contributors/all-contributors">all-contributors</a> specification. Contributions of any kind welcome!</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_local_storage_events_.html">"local-<wbr>storage-<wbr>events"</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_storage_.html">"storage"</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/_use_localstorage_.html">"use-<wbr>localstorage"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>