Skip to content

Commit 439eb26

Browse files
committed
docs: update README to clarify querystring options for key and format
1 parent b346991 commit 439eb26

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/zustand-querystring/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ export const useStore = create<Store>()(
5959
querystring options:
6060

6161
- <b>select</b> - the select option controls what part of the state is synced with the query string
62-
- <b>key: string</b> - the key option controls how the state is stored in the querystring (default: 'state')
62+
- <b>key: string | false</b> - the key option controls how the state is stored in the querystring (default: 'state'). Set to `false` for standalone mode where each state key becomes a separate query parameter.
6363
- <b>url</b> - the url option is used to provide the request url on the server side render
64-
- <b>format</b> - custom format for stringify/parse (default: JSON-based format)
64+
- <b>format</b> - custom format for stringify/parse (default: JSON-based format). Use `readable` from `zustand-querystring/format/readable` for human-readable URLs.
6565
- <b>syncNull: boolean</b> - when true, null values that differ from initial state are synced to URL (default: false)
6666
- <b>syncUndefined: boolean</b> - when true, undefined values that differ from initial state are synced to URL (default: false)
6767

0 commit comments

Comments
 (0)