state-in-url 4.1.4 → 4.1.6

package/README.md

@@ -43,7 +43,7 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 
 <hr />
 
-Add a ⭐️ and <a href="https://github.com/asmyshlyaev177" target="_blank">follow me</a> to support the project!
+Add a <a href="#"><img src="https://raw.githubusercontent.com/acervenky/animated-github-badges/master/assets/starbadge.gif" width="25" height="25"></a>  and <a href="https://github.com/asmyshlyaev177" target="_blank">follow me</a> to support the project!
 
 Will appreciate you feedback/opinion on [discussions](https://github.com/asmyshlyaev177/state-in-url/discussions/1)
 
@@ -85,12 +85,13 @@ This library is a good alternative for NUQS.
 - ✨ **Complex data**: Nested objects, dates and arrays, works same as JSON, but in URL
 - ☂ **Default values**: Giving you default values if parameter not in url
 - ⌨ **Organized**: All possible values defined at start, protect you from getting non existing key
+- **flexible**: Can use more than 1 state objects on the same page, just use different keys
 - **Fast**: Minimal rerenders, around [1ms](https://github.com/asmyshlyaev177/state-in-url/blob/87c8c7c995c5cd7d9e7aa039c30bfe64b24abe4b/packages/urlstate/encoder/encoder.test.ts#L185) to encode and decode big object
 - **Server Side Rendering**: Can use it in Server Components, Next.js 14 and 15 are supported
 - **Lightweight**: Zero dependencies, library less than 2KB
 - **DX**: Good developer experience, documentation, JSDoc comments, and examples
 - **Framework Flexibility**: Hooks for `Next.js` and `react-router`, helpers to use it with other frameworks or pure JS
-- **Well tested**: Unit tests and Playwright tests for Chrome/Firefox/Safari
+- **Well tested**: [Unit tests and Playwright tests for Chrome/Firefox/Safari](https://github.com/asmyshlyaev177/state-in-url/actions/workflows/tests.yml)
 - **Permissive license**: MIT
 
 ## Table of content

package/dist/next/useUrlState/useUrlState.d.ts

@@ -7,10 +7,19 @@ import { type JSONCompatible } from "../../utils";
  * .
  */
 export declare function useUrlState<T extends JSONCompatible>({ defaultState: T, searchParams, replace, scroll, useHistory, }: OldParams<T>): {
+    /**
+     * @deprecated use `urlState`
+     */
     state: T;
     urlState: T;
+    /**
+     * @deprecated use `setState`
+     */
     updateState: (value: Partial<T> | ((currState: T) => T)) => void;
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * @deprecated use `setUrl`
+     */
     updateUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
     setUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
 };
@@ -49,9 +58,42 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState}
  */
 export declare function useUrlState<T extends JSONCompatible>(defaultState: T, params?: Params): {
+    /**
+     * State object. Don't mutate directly, use `setState` or `setUrl`
+     */
     urlState: T;
+    /**
+     * * Example:
+     * ```ts
+     * setState({ name: 'test' });
+     * // or
+     * setState(curr => ({ ...curr, name: 'test' }) );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#updatestate}
+     */
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * * Example:
+     * ```ts
+     * setUrl({ name: 'test' });
+     * // or
+     * setUrl(curr => ({ ...curr, name: 'test' }), { replace: true, scroll: false  } );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#updateurl}
+     */
     setUrl: (value?: Partial<T> | ((currState: T) => T), options?: Options) => void;
+    /**
+     * * Example:
+     * ```ts
+     * reset();
+     * // or
+     * reset({ replace: false, scroll: true })
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#reset}
+     */
     reset: (options?: Options & {
         [key: string]: unknown;
     }) => void;

package/dist/react-router/useUrlState/useUrlState.d.ts

@@ -7,8 +7,14 @@ import { type JSONCompatible } from "../../utils";
  * .
  */
 export declare function useUrlState<T extends JSONCompatible>({ defaultState: T, searchParams, replace, useHistory, }: OldParams<T>): {
+    /**
+     * @deprecated use `urlState`
+     */
     state: T;
     urlState: T;
+    /**
+     * @deprecated use `setState`
+     */
     updateState: (value: Partial<T> | ((currState: T) => T)) => void;
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
     updateUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
@@ -19,7 +25,7 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *
  * @param {JSONCompatible<T>} [defaultState] Fallback (default) values for state
  * @param {Object} params - Object with other parameters
- * @param {NavigateOptions} params.NavigateOptions See type from `react-router-dom`
+ * @param {NavigateOptions} params.NavigateOptions See type from [`react-router-dom`](https://api.reactrouter.com/v7/interfaces/react_router.NavigateOptions.html)
  * @param {boolean} params.replace replace URL or push, default `true`
  * @param {boolean} params.useHistory use window.history for navigation, default `false`
  * @param {boolean} params.preventScrollReset keep scroll position, default `true`
@@ -46,9 +52,44 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState}
  */
 export declare function useUrlState<T extends JSONCompatible>(defaultState: T, params?: Params): {
+    /**
+     * State object. Don't mutate directly, use `setState` or `setUrl`
+     */
     urlState: T;
+    /**
+     * * Example:
+     * ```ts
+     * setState({ name: 'test' });
+     * // or
+     * setState(curr => ({ ...curr, name: 'test' }) );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updatestate}
+     */
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * * Example:
+     * ```ts
+     * setUrl({ name: 'test' });
+     * // or
+     * setUrl(curr => ({ ...curr, name: 'test' }), { replace: true } );
+     * // can pass optional React-Router `NavigateOptions`
+     * setUrl(curr => ({ ...curr, name: 'test' }), { preventScrollReset: false } );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updateurl}
+     */
     setUrl: (value?: Partial<T> | ((currState: T) => T), options?: Params) => void;
+    /**
+     * * Example:
+     * ```ts
+     * reset();
+     * // or
+     * reset({ replace: false, preventScrollReset: false })
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#reset}
+     */
     reset: (options?: NavigateOptions & {
         [key: string]: unknown;
     }) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "state-in-url",
-  "version": "4.1.4",
-  "description": "Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Deep links and url state synchronization wthout any hasssle or boilerplate.",
+  "version": "4.1.6",
+  "description": "Store state in URL as in object, types and structure are preserved, with TS validation. Same API as React.useState, wthout any hasssle or boilerplate. Next.js@14-15 and react-router@6-7.",
   "homepage": "https://state-in-url.dev",
   "repository": {
     "type": "git",
@@ -388,30 +388,57 @@
     "wireit": "^0.14.9"
   },
   "keywords": [
-    "front-end",
-    "state-management",
+    "state in url",
+    "useSearchParams",
+    "useUrlState",
+    "url state",
+    "search params",
+    "nuqs alternative",
+    "reactive",
+    "json",
+    "state sync",
     "state management",
-    "deep links",
-    "deep linking",
+    "encode",
+    "decode",
+    "Next.js",
+    "react-router",
+    "url",
     "url synchronization",
-    "useUrlState",
-    "state in url",
+    "url sync",
+    "state synchronization",
+    "synchronized state",
+    "state-in-url",
+    "store",
+    "react hook",
+    "state hook",
+    "url-state",
     "client components communication",
     "query string",
-    "search params",
+    "query-string",
+    "querystring",
+    "search-params",
+    "searchparams",
+    "params",
+    "parse",
+    "stringify",
     "query params",
     "typescript",
-    "workflow",
-    "javascript",
     "hooks",
     "react.js",
     "reactjs",
     "react",
     "NextJS",
-    "Next.js",
-    "nuqs alternative",
     "query params parser",
-    "query params parsing"
+    "query params parsing",
+    "shared state",
+    "state sharing",
+    "front-end",
+    "state-management",
+    "state-sync",
+    "search",
+    "encode url",
+    "decode url",
+    "fast"
   ],
   "packageManager": "npm@10.8.2"
 }