Merge pull request #964 from GitbookIO/features/plugin_api

Better APIs for Plugins

1 files changed, 37 insertions, 0 deletions

diff --git a/theme/javascript/storage.js b/theme/javascript/storage.js
new file mode 100644
index 0000000..7a7643c
--- /dev/null
+++ b/theme/javascript/storage.js
@@ -0,0 +1,37 @@
+var baseKey = '';
+
+/*
+ * Simple module for storing data in the browser's local storage
+ */
+module.exports = {
+    setBaseKey: function(key) {
+        baseKey = key;
+    },
+
+    // Write something in localstorage
+    set: function(key, value) {
+        key = baseKey+':'+key;
+
+        try {
+            localStorage[key] = JSON.stringify(value);
+        } catch(e) {}
+    },
+
+    // Read a value from localstorage
+    get: function(key, def) {
+        key = baseKey+':'+key;
+        if (localStorage[key] === undefined) return def;
+        try {
+            var v = JSON.parse(localStorage[key]);
+            return v == null ? def : v;;
+        } catch(err) {
+            return localStorage[key] || def;
+        }
+    },
+
+    // Remove a key from localstorage
+    remove: function(key) {
+        key = baseKey+':'+key;
+        localStorage.removeItem(key);
+    }
+};