-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!DOCTYPE html> | ||
<html lang="en-US"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta name="viewport" content="width=device-width,initial-scale=1"> | ||
<title>Undo/Redo Vuex</title> | ||
<meta name="description" content="A Vuex plugin for module namespaced undo and redo functionality."> | ||
<meta name="generator" content="VuePress 1.3.0"> | ||
|
||
|
||
<link rel="preload" href="/undo-redo-vuex/assets/css/0.styles.8e7686e1.css" as="style"><link rel="preload" href="/undo-redo-vuex/assets/js/app.b60afada.js" as="script"><link rel="preload" href="/undo-redo-vuex/assets/js/4.f343b94f.js" as="script"><link rel="prefetch" href="/undo-redo-vuex/assets/js/10.b4513535.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/11.1a2a9884.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/2.509406fa.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/3.7f3a2956.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/5.adf0f287.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/6.7014b330.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/7.5968826c.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/8.e0908114.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/9.c43d2b17.js"> | ||
<link rel="stylesheet" href="/undo-redo-vuex/assets/css/0.styles.8e7686e1.css"> | ||
</head> | ||
<body> | ||
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="theme-default-content"><h1>404</h1> <blockquote>Looks like we've got some broken links.</blockquote> <a href="/undo-redo-vuex/" class="router-link-active"> | ||
Take me home. | ||
</a></div></div><div class="global-ui"></div></div> | ||
<script src="/undo-redo-vuex/assets/js/app.b60afada.js" defer></script><script src="/undo-redo-vuex/assets/js/4.f343b94f.js" defer></script> | ||
</body> | ||
</html> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
<!DOCTYPE html> | ||
<html lang="en-US"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta name="viewport" content="width=device-width,initial-scale=1"> | ||
<title>API documentation and reference | Undo/Redo Vuex</title> | ||
<meta name="description" content="A Vuex plugin for module namespaced undo and redo functionality."> | ||
<meta name="generator" content="VuePress 1.3.0"> | ||
|
||
|
||
<link rel="preload" href="/undo-redo-vuex/assets/css/0.styles.8e7686e1.css" as="style"><link rel="preload" href="/undo-redo-vuex/assets/js/app.b60afada.js" as="script"><link rel="preload" href="/undo-redo-vuex/assets/js/2.509406fa.js" as="script"><link rel="preload" href="/undo-redo-vuex/assets/js/6.7014b330.js" as="script"><link rel="prefetch" href="/undo-redo-vuex/assets/js/10.b4513535.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/11.1a2a9884.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/3.7f3a2956.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/4.f343b94f.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/5.adf0f287.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/7.5968826c.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/8.e0908114.js"><link rel="prefetch" href="/undo-redo-vuex/assets/js/9.c43d2b17.js"> | ||
<link rel="stylesheet" href="/undo-redo-vuex/assets/css/0.styles.8e7686e1.css"> | ||
</head> | ||
<body> | ||
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/undo-redo-vuex/" class="home-link router-link-active"><!----> <span class="site-name">Undo/Redo Vuex</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Guide" class="dropdown-title"><span class="title">Guide</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/installation/" class="nav-link"> | ||
Installation | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/usage/" class="nav-link"> | ||
Usage | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/testing/" class="nav-link"> | ||
Testing | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/demo/" class="nav-link"> | ||
Demo | ||
</a></li></ul></div></div><div class="nav-item"><a href="/undo-redo-vuex/api/" class="nav-link router-link-exact-active router-link-active"> | ||
API | ||
</a></div> <a href="https://github.com/factorial-io/undo-redo-vuex" target="_blank" rel="noopener noreferrer" class="repo-link"> | ||
GitHub | ||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="Guide" class="dropdown-title"><span class="title">Guide</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/installation/" class="nav-link"> | ||
Installation | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/usage/" class="nav-link"> | ||
Usage | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/testing/" class="nav-link"> | ||
Testing | ||
</a></li><li class="dropdown-item"><!----> <a href="/undo-redo-vuex/guide/demo/" class="nav-link"> | ||
Demo | ||
</a></li></ul></div></div><div class="nav-item"><a href="/undo-redo-vuex/api/" class="nav-link router-link-exact-active router-link-active"> | ||
API | ||
</a></div> <a href="https://github.com/factorial-io/undo-redo-vuex" target="_blank" rel="noopener noreferrer" class="repo-link"> | ||
GitHub | ||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>API documentation and reference</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/undo-redo-vuex/api/#undoredo-options-⇒-function" class="sidebar-link">undoRedo(options) ⇒</a></li><li><a href="/undo-redo-vuex/api/#undoredo-redo" class="sidebar-link">undoRedo:redo()</a></li><li><a href="/undo-redo-vuex/api/#undoredo-undo" class="sidebar-link">undoRedo:undo()</a></li><li><a href="/undo-redo-vuex/api/#undoredo-pipeactions-actions" class="sidebar-link">undoRedo:pipeActions(actions)</a></li><li><a href="/undo-redo-vuex/api/#undoredo-getconfig-namespace-⇒-object" class="sidebar-link">undoRedo:getConfig(namespace) ⇒</a></li><li><a href="/undo-redo-vuex/api/#undoredo-setconfig-namespace-config" class="sidebar-link">undoRedo:setConfig(namespace, config)</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api-documentation-and-reference"><a href="#api-documentation-and-reference" class="header-anchor">#</a> API documentation and reference</h1> <h2 id="undoredo-options-⇒-function"><a href="#undoredo-options-⇒-function" class="header-anchor">#</a> undoRedo(options) ⇒ <code>function</code></h2> <p>The Undo-Redo plugin module</p> <p><strong>Returns</strong>: <code>function</code> - plugin - the plugin function which accepts the store parameter</p> <table><thead><tr><th>Param</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td>options</td> <td><code>Object</code></td> <td></td></tr> <tr><td>options.namespace</td> <td><code>String</code></td> <td>The named vuex store module</td></tr> <tr><td>options.ignoreMutations</td> <td><code>Array.<String></code></td> <td>The list of store mutations (belonging to the module) to be ignored</td></tr></tbody></table> <h2 id="undoredo-redo"><a href="#undoredo-redo" class="header-anchor">#</a> undoRedo:redo()</h2> <p>The Redo function - commits the latest undone mutation to the store, | ||
and pushes it to the done stack</p> <h2 id="undoredo-undo"><a href="#undoredo-undo" class="header-anchor">#</a> undoRedo:undo()</h2> <p>The Undo function - pushes the latest done mutation to the top of the undone | ||
stack by popping the done stack and 'replays' all mutations in the done stack</p> <h2 id="undoredo-pipeactions-actions"><a href="#undoredo-pipeactions-actions" class="header-anchor">#</a> undoRedo:pipeActions(actions)</h2> <p>Piping async action calls sequentially using Array.prototype.reduce | ||
to chain and initial, empty promise</p> <table><thead><tr><th>Param</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td>actions</td> <td><code>Array.<Object></code></td> <td>The array of objects containing the each action's name and payload</td></tr></tbody></table> <h2 id="undoredo-getconfig-namespace-⇒-object"><a href="#undoredo-getconfig-namespace-⇒-object" class="header-anchor">#</a> undoRedo:getConfig(namespace) ⇒ <code>Object</code></h2> <p>Piping async action calls sequentially using Array.prototype.reduce | ||
to chain and initial, empty promise</p> <p><strong>Returns</strong>: <code>Object</code> - config - The object containing the undo/redo stacks of the store module</p> <table><thead><tr><th>Param</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td>namespace</td> <td><code>String</code></td> <td>The name of the store module</td></tr></tbody></table> <h2 id="undoredo-setconfig-namespace-config"><a href="#undoredo-setconfig-namespace-config" class="header-anchor">#</a> undoRedo:setConfig(namespace, config)</h2> <p>Piping async action calls sequentially using Array.prototype.reduce | ||
to chain and initial, empty promise</p> <table><thead><tr><th>Param</th> <th>Type</th> <th>Description</th></tr></thead> <tbody><tr><td>namespace</td> <td><code>String</code></td> <td>The name of the store module</td></tr> <tr><td>config</td> <td><code>String</code></td> <td>The object containing the updated undo/redo stacks of the store module</td></tr></tbody></table></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/factorial-io/undo-redo-vuex/edit/master/docs/api/README.md" target="_blank" rel="noopener noreferrer">Help us improve this page!</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <!----></footer> <!----> </main></div><div class="global-ui"></div></div> | ||
<script src="/undo-redo-vuex/assets/js/app.b60afada.js" defer></script><script src="/undo-redo-vuex/assets/js/2.509406fa.js" defer></script><script src="/undo-redo-vuex/assets/js/6.7014b330.js" defer></script> | ||
</body> | ||
</html> |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{9:function(n,w,o){}}]); |
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.