Runtime Variables
SBCanvas.vars is an in-memory key-value store that persists across widget re-renders but resets when the overlay disconnects. Use it for runtime state that doesn’t need server persistence.
For data that should survive disconnects, use SBCanvas.store instead.
Setting Variables
Reading Variables
Deleting Variables
Example: Combo Counter
Example: Cross-Widget State
Widget A sets a variable:API Reference
| Method | Returns | Description |
|---|---|---|
vars.set(key, value) | void | Store a value |
vars.get(key) | any | Retrieve a value |
vars.delete(key) | void | Remove a key |
vars.getAll() | object | Get all variables as a plain object |
vars.clear() | void | Remove all variables |
Vars vs Store
vars | store | |
|---|---|---|
| Persists across re-renders | Yes | Yes |
| Persists across disconnects | No | Yes |
| Async | No | Yes |
| Server-backed | No | Yes |
| Use for | Temporary runtime state | Permanent widget data |