From 19f6d4fa3856379651e2a3d31c5f361c168b57ba Mon Sep 17 00:00:00 2001 From: Malcolm Knott Date: Thu, 14 Oct 2021 11:13:56 +1300 Subject: [PATCH] Adding docs, code review clean up. --- index.html | 133 +++--------------------- packages/docs/src/en/plugins/persist.md | 11 ++ packages/persist/src/index.js | 4 +- 3 files changed, 29 insertions(+), 119 deletions(-) diff --git a/index.html b/index.html index 7cd6d95ae..03530e2dd 100644 --- a/index.html +++ b/index.html @@ -1,117 +1,18 @@ - - - - - - - Alpine Example - - - - - - - - - - - - - - - -
-
-
-

-
- - - - - - - - - -
-

Persist counter example ...

-
- - -
-
-
-
- - - - + + + + + + + + + + +
+ + + + Content... + +
diff --git a/packages/docs/src/en/plugins/persist.md b/packages/docs/src/en/plugins/persist.md index dec0e0d6d..d08bd76a8 100644 --- a/packages/docs/src/en/plugins/persist.md +++ b/packages/docs/src/en/plugins/persist.md @@ -194,3 +194,14 @@ Alpine.data('dropdown', function () { } }) ``` + + +## Using the Alpine.$persist global + +`Alpine.$persist` is exposed globally so it can be used outside of `x-data` contexts. This is useful to persist data from other sources such as `Alpine.store`. + +```js +Alpine.store('darkMode', { + on: Alpine.$persist(true).as('darkMode_on') +}); +``` \ No newline at end of file diff --git a/packages/persist/src/index.js b/packages/persist/src/index.js index e809c0aea..97a96cf25 100644 --- a/packages/persist/src/index.js +++ b/packages/persist/src/index.js @@ -1,7 +1,4 @@ - - export default function (Alpine) { - let persist = () => { let alias let storage = localStorage @@ -29,6 +26,7 @@ export default function (Alpine) { func.using = target => { storage = target; return func } }) } + Alpine.$persist = persist() Alpine.magic('persist', persist) }