Skip to content

Latest commit

 

History

History
158 lines (97 loc) · 3.37 KB

README.md

File metadata and controls

158 lines (97 loc) · 3.37 KB
Raw

persist

Repository size

About   |   start   |   demo   |   Author


About

persist makes quick work of automatically storing input field values and loading them on page load - aka persisting inputs.

Check out the demo.

For now this is just some speculative reality. I just need something dumb like this for a testing lots of phones. Feel free to use it and gimme some feedback though!

quick start

add persist to any input, select, textarea field to have its value persist between page loads. or just add persistto the body tag to persist the whole page, or a form tag to persist the form.

<input persist type="text"></input>

API

initialise

persist({
    namespace: 'persist-demo',
    version: 1,
    verbose: true,
    cleanup: true,
    showPersistManager: true,
    highlight: true,
})

tag stuff up!

apply persist to body,form,input,select,textarea tags to persist them. persist-for, persist-until, forget-between-versions only work on the input tag level

safely naming your inputs

its recommended to provide a persist-name value on your fields, especially if you have dynamic document bodies. This will guard against name attribute changes breaking your persistence.

<input persist persist-name="my-input" name="my-input-post-migration" type="text"></input>

The logic for determining input identifiers is as follows:

field.getAttribute("persist-name") || field.getAttribute("name") || field.getAttribute("id") || field.type || field.tagName.toLowerCase();

persist

persist input values between page loads

<input persist type="text"></input>

persist-for

persist input values for a certain amount of time

<input persist persist-for="1h" type="text"></input>

persist-until

persist input values until a certain date

<input persist persist-until="2021-12-31" type="text"></input>

forget-between-versions

forget all stored values when the version changes

<input persist forget-between-versions type="text"></input>

supported input types

number ✅

date ✅

color ✅

url ✅

email ✅

phone ✅

textarea ✅

select ✅

select[multiple] ✅

checkbox ✅

radio ✅

radio group 🤔

file 🤔

text ✅

range ✅

datetime-local ✅

month ✅

password ✅

search ✅

tel ✅

time ✅

week ✅

files ⚠️

files dont work

note about files: `persist` will store files as base64 strings. It goes without saying that this is not a good idea for large files. Consult the mozilla documentation to see how much data browsers can store in local storage. link: https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API#storage_limits

browser support

persist uses the localStorage api, which is supported by all modern browsers. link: https://caniuse.com/?search=localStorage