Represents a state Var that is stored as a cookie in the browser. Currently only supports string values.
Parameters
name: The name of the cookie on the client side.path: The cookie path. Use/to make the cookie accessible on all pages.max_age: Relative max age of the cookie in seconds from when the client receives it.domain: Domain for the cookie (e.g.,sub.domain.comor.allsubdomains.com).secure: If the cookie is only accessible through HTTPS.same_site: Whether the cookie is sent with third-party requests. Can be one of (True,False,None,lax,strict).
Cookies are accessed like any other Var in the state. If another state needs access
to the value of a cookie, the state should be a substate of the state that defines
the cookie. Alternatively the get_state API can be used to access the other state.
For rendering cookies in the frontend, import the state that defines the cookie and reference it directly.
Remove a cookie from the client's browser.
Parameters:
key: The name of cookie to remove.
This event can also be returned from an event handler:
Represents a state Var that is stored in localStorage in the browser. Currently only supports string values.
Parameters
name: The name of the storage key on the client side.sync: Boolean indicates if the state should be kept in sync across tabs of the same browser.
Because LocalStorage applies to the entire browser, all LocalStorage Vars are automatically shared across tabs.
The sync parameter controls whether an update in one tab should be actively
propagated to other tabs without requiring a navigation or page refresh event.
Remove a local storage item from the client's browser.
Parameters
key: The key to remove from local storage.
This event can also be returned from an event handler:
Clear all local storage items from the client's browser. This may affect other apps running in the same domain or libraries within your app that use local storage.
Represents a state Var that is stored in sessionStorage in the browser. Similar to localStorage, but the data is cleared when the page session ends (when the browser/tab is closed). Currently only supports string values.
Parameters
name: The name of the storage key on the client side.
SessionStorage data is cleared when the page session ends. A page session lasts as long as the browser is open and survives page refreshes and restores, but is cleared when the tab or browser is closed.
Unlike LocalStorage, SessionStorage is isolated to the tab/window in which it was created, so it's not shared with other tabs/windows of the same origin.
Remove a session storage item from the client's browser.
Parameters
key: The key to remove from session storage.
This event can also be returned from an event handler:
Clear all session storage items from the client's browser. This may affect other apps running in the same domain or libraries within your app that use session storage.
If a non-trivial data structure should be stored in a Cookie, LocalStorage, or SessionStorage var it needs to be serialized before and after storing it. It is recommended to use a pydantic class for the data which provides simple serialization helpers and works recursively in complex object structures.
Here's a comparison of the different client-side storage options in Reflex:
| Feature | rx.Cookie | rx.LocalStorage | rx.SessionStorage |
|---|---|---|---|
| Persistence | Until cookie expires | Until explicitly deleted | Until browser/tab is closed |
| Storage Limit | ~4KB | ~5MB | ~5MB |
| Sent with Requests | Yes | No | No |
| Accessibility | Server & Client | Client Only | Client Only |
| Expiration | Configurable | Never | End of session |
| Scope | Configurable (domain, path) | Origin (domain) | Tab/Window |
| Syncing Across Tabs | No | Yes (with sync=True) | No |
| Use Case | Authentication, Server-side state | User preferences, App state | Temporary session data |
Use rx.Cookie When:
- You need the data to be accessible on the server side (cookies are sent with HTTP requests)
- You're handling user authentication
- You need fine-grained control over expiration and scope
- You need to limit the data to specific paths in your app
Use rx.LocalStorage When:
- You need to store larger amounts of data (up to ~5MB)
- You want the data to persist indefinitely (until explicitly deleted)
- You need to share data between different tabs/windows of your app
- You want to store user preferences that should be remembered across browser sessions
Use rx.SessionStorage When:
- You need temporary data that should be cleared when the browser/tab is closed
- You want to isolate data to a specific tab/window
- You're storing sensitive information that shouldn't persist after the session ends
- You're implementing per-session features like form data, shopping carts, or multi-step processes
- You want to persist data for a state after Redis expiration (for server-side state that needs to survive longer than Redis TTL)