They are a Vue mixin for component settings, that should be stored in the localStorage.
You can use this to ease storing and retrieving data
properties of your Vue Components.
Take a look at a bit further down to see how to integrate them.
# with npm
npm install --save stored-settings
# with yarn
yarn add stored-settings
Assuming you want to use Vue SFCs, you can integrate stored settings
import StoredSettings from 'stored-settings'
export default {
/* ... */
mixins: [
StoredSettings(/* key-prefix */ 'my-settings', {
/* define similar to props */
showHelp: {
type: Boolean
},
})
]
}
This will set up a data
Element containing showHelp
.
When changing showHelp
, the value will be written to the localStorage
at my-settings.showHelp
.
Basically any Data with a JSON representation can be stored/retrieved from the store. The Limits of the used store still apply though.
As basic supported types you can use:
Type | default |
---|---|
Boolean |
false |
Number |
0 |
String |
'' |
Array |
[] |
Object |
{} |
Date |
null |
You can provide your own functions to (de-)serialize the stored values.
serialize(value: T): String
will be used to serialize aT
value before storing it asString
parse(value: String): T
will be used to deserialize theString
back to the locally usedT
Beside that you can also overwrite the toJSON
if you provide your own class.
It's meant to be a small helper to move information form data
to the localStorage
.
How should I know, I'm just using this one.