Browser Storage Component

The Browser Storage component reads from, writes to, or deletes data in the browser's local or session storage. Use it to persist data between sessions or pass data between modules without a server round-trip.

How to read settings tables

The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

General Settings

Setting	Field	Type	Default	Description
Property ID	`key`	Text input	`browserStorage`	The unique identifier for this component instance.
Canvas Label Text	`label`	Text input	—	Identifies the component on the Module Builder canvas. Does not display.

Data Settings

Setting	Field	Type	Default	Description
Interaction Type	`operation`	Choice chip	Write	Choice chip that sets the storage operation to perform.

Write: Stores data to the browser's local or session storage under the specified namespace.

Read: Retrieves data from the browser's local or session storage and maps values to module fields using the Outputs table.

Delete: Removes data from the browser's local or session storage under the specified namespace.

Setting	Field	Type	Default	Description
Namespace	`namespace`	Property ID	—	A namespace associated with the data to be saved or accessed.

Filters

Narrows the scope of the read, write, or delete operation to specific data properties.

Column	Field	Type	Description
Property ID	`property`	Drop-down	The module field to filter on.
Set Filter to	`comparison`	Drop-down	The comparison type for the filter.
Mapping	`mapping`	Text input	The data source component ID to compare against.
Required	`required`	☐/✓	When checked, this setting marks this filter as required.
Exclude	`exclude`	☐/✓	When checked, this setting excludes this field from the operation.
Optional	`optional`	☐/✓	When checked, this setting marks this filter as optional.

Write Settings (visible when Interaction Type is Write)

Setting	Field	Type	Default	Description
Replace	`replace`	Toggle	OFF	When ON, replaces the entire stored data object. When OFF, merges new data into the existing object.

Inputs (Write)

Defines the data written to storage.

Column	Field	Type	Description
Property ID	`property`	Property ID	The module field whose value to write.
Mapping	`mapping`	Text input	The key name to use in storage.
Required	`required`	☐/✓	When checked, this setting marks this input as required.
Exclude	`exclude`	☐/✓	When checked, this setting excludes this field from the write operation.
Optional	`optional`	☐/✓	When checked, this setting marks this input as optional.

Outputs

Defines the module fields populated with data retrieved from storage.

Column	Field	Type	Description
Property ID	`property`	Property ID	The module field to populate with the retrieved value.
Mapping	`mapping`	Text input	The storage key to read from.

Actions Settings

Triggers

Setting	Field	Type	Default	Description
Post Trigger	`postTrigger`	Property ID	—	Triggers another component after the storage operation completes.
Error Trigger	`errorHandler`	Property ID	—	Triggers a component when the storage operation fails.

Advanced Settings

Setting	Field	Type	Default	Description
Disable Execution	`disabled`	Toggle	OFF	Prevents the component from executing when triggered.
Set Debounce	`debounceSetting`	Number input	`500`	Sets the delay before executing after being triggered, in milliseconds (ms).

Changelog

Date	Change
—	Initial publication.

Documentation Index