TiddlyWiki5/plugins/tiddlywiki/browser-storage/settings.tid

title: $:/plugins/tiddlywiki/browser-storage/settings

! Disable

You can disable the browser storage plugin:

<$checkbox tiddler="$:/config/BrowserStorage/Enabled" field="text" checked="yes" unchecked="no" default="yes"> Use browser local storage</$checkbox>

! Clear

Click this button to clear browser storage and disable its use:

<$button message="tm-clear-browser-storage">Clear browser storage</$button>

! Save Filter

This filter determines which tiddlers will be saved to local storage.

* `[prefix[$:/state/]] -[prefix[$:/state/popup/]]` - the default value. Save state tiddlers except popup state tiddlers, thus preserving selected tabs and the open/closed status of table of contents entries. Any other tiddlers created or changed will be lost after reloading the page.
* `[all[]]` - attempt to save all changed tiddlers. This means even popup state tiddlers and temporary tiddlers will be saved.
* `[all[]] -[prefix[$:/state/popup/]] -[prefix[$:/temp/]] -[prefix[$:/HistoryList]]` - save all tiddlers except popup state tiddlers, temp tiddlers and the history list.

<$link to="$:/config/BrowserStorage/SaveFilter">Browser Storage Save Filter</$link>: <$edit-text tiddler="$:/config/BrowserStorage/SaveFilter" default="" tag="input" size="50"/>

! Custom Quota Exceeded Alert

This setting allows a custom alert message to be displayed when an attempt to store a tiddler fails due to the storage quota being exceeded:

<$link to="$:/config/BrowserStorage/QuotaExceededAlert">Quota Exceeded Alert</$link>: <$edit-text tiddler="$:/config/BrowserStorage/QuotaExceededAlert" default="" tag="input" size="50"/>

! Prevent browser from evicting local storage

Permission for local storage persistence: ''{{$:/info/browser/storage/persisted}}''

The first time a tiddler is saved to local storage a request will be made to prevent automatic eviction of local storage for this site. This means the data will not be cleared unless the user manually clears it.

Old browsers may not support this feature. New browsers might not support the feature if the wiki is hosted on a non-localhost unencrypted http connection.

Some browsers will explicitly prompt the user for permission. Other browsers may automatically grant or deny the request based on site usage or based on whether the site is bookmarked.

! Startup Log

The tiddler $:/temp/BrowserStorage/Log contains a log of the tiddlers that were loaded from local storage at startup:

<<list-links "[enlist{$:/temp/BrowserStorage/Log}sort[]]">>
BrowserStorage: Add a filter to determine which tiddlers are saved 2019-02-07 14:35:25 +00:00			`title: $:/plugins/tiddlywiki/browser-storage/settings`

Browser-storage: Add enable/disable and clear button 2019-03-01 22:06:14 +00:00			`! Disable`

			`You can disable the browser storage plugin:`

			`<$checkbox tiddler="$:/config/BrowserStorage/Enabled" field="text" checked="yes" unchecked="no" default="yes"> Use browser local storage</$checkbox>`

			`! Clear`

			`Click this button to clear browser storage and disable its use:`

			`<$button message="tm-clear-browser-storage">Clear browser storage</$button>`

BrowserStorage: Add startup log and fix save filter The previous filter was rejecting tiddlers that needed to be deleted. 2019-02-07 17:59:55 +00:00			`! Save Filter`

Allow browser storage plugin to delete existing tiddlers (#6625) * Do not remove localstorage items while looping While looping over all the browser storage items by index, the items should not be removed because removing alters the index positions. The item following the removed one will be skipped by the loop. Instead, accumulate a list of keys to remove and remove them after the loop. * Implement full delete support for browser storage plugin Before, deletes only worked for tiddlers which are only present in the localstorage. Now deleted tiddlers are marked in localstorage using an empty string value. At startup, the localstorage tiddlers with empty strings will be deleted from the wiki if they are still present. If they are already gone from the wiki, then the blank localstorage entry will be deleted. * Document drawbacks to using '[all[]]' and provide an alternative 2022-04-12 21:11:37 +00:00			`This filter determines which tiddlers will be saved to local storage.`

			* `[prefix[$:/state/]] -[prefix[$:/state/popup/]]` - the default value. Save state tiddlers except popup state tiddlers, thus preserving selected tabs and the open/closed status of table of contents entries. Any other tiddlers created or changed will be lost after reloading the page.
BrowserStoragePlugin: Do not save shadow tiddlers to local storage (#7365) If a tiddler is only a shadow tiddler, then do not save it to local storage. Otherwise when installing a plugin, each individual tiddler will be expanded and saved individually. In order to uninstall such a plugin, the plugin tiddler and each tiddler needs to be deleted. This can be prevented by including a run like `-[is[shadow]!is[tiddler]]` in the save filter, but that has the side effect of preventing overwritten shadow tiddlers from being deleted from local storage. 2023-05-06 10:41:22 +00:00			* `[all[]]` - attempt to save all changed tiddlers. This means even popup state tiddlers and temporary tiddlers will be saved.
			* `[all[]] -[prefix[$:/state/popup/]] -[prefix[$:/temp/]] -[prefix[$:/HistoryList]]` - save all tiddlers except popup state tiddlers, temp tiddlers and the history list.
BrowserStorage: Add a filter to determine which tiddlers are saved 2019-02-07 14:35:25 +00:00
			`<$link to="$:/config/BrowserStorage/SaveFilter">Browser Storage Save Filter</$link>: <$edit-text tiddler="$:/config/BrowserStorage/SaveFilter" default="" tag="input" size="50"/>`

BrowserStorage: Add startup log and fix save filter The previous filter was rejecting tiddlers that needed to be deleted. 2019-02-07 17:59:55 +00:00			`! Custom Quota Exceeded Alert`

BrowserStorage: Add support for a custom quota exceeded message 2019-02-07 14:46:23 +00:00			`This setting allows a custom alert message to be displayed when an attempt to store a tiddler fails due to the storage quota being exceeded:`

			`<$link to="$:/config/BrowserStorage/QuotaExceededAlert">Quota Exceeded Alert</$link>: <$edit-text tiddler="$:/config/BrowserStorage/QuotaExceededAlert" default="" tag="input" size="50"/>`
BrowserStorage: Add startup log and fix save filter The previous filter was rejecting tiddlers that needed to be deleted. 2019-02-07 17:59:55 +00:00
Request permission to protect local storage from eviction (#7398) * Request the browser to never evict the persistent storage * Store browser storage persisted state in a tiddler * Factor out some code into helper functions * Display status of persistence request in the settings page 2023-06-13 09:50:00 +00:00			`! Prevent browser from evicting local storage`

			`Permission for local storage persistence: ''{{$:/info/browser/storage/persisted}}''`

			`The first time a tiddler is saved to local storage a request will be made to prevent automatic eviction of local storage for this site. This means the data will not be cleared unless the user manually clears it.`

			`Old browsers may not support this feature. New browsers might not support the feature if the wiki is hosted on a non-localhost unencrypted http connection.`

			`Some browsers will explicitly prompt the user for permission. Other browsers may automatically grant or deny the request based on site usage or based on whether the site is bookmarked.`

BrowserStorage: Add startup log and fix save filter The previous filter was rejecting tiddlers that needed to be deleted. 2019-02-07 17:59:55 +00:00			`! Startup Log`

			`The tiddler $:/temp/BrowserStorage/Log contains a log of the tiddlers that were loaded from local storage at startup:`

			`<<list-links "[enlist{$:/temp/BrowserStorage/Log}sort[]]">>`