@true-tech-team/react-components 0.0.9 → 0.0.10

package/lib/hooks/useUrlState/useUrlState.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Serializer/deserializer for URL state values
+ */
+export interface UrlStateSerializer<T> {
+    /**
+     * Serialize value to URL string
+     */
+    serialize: (value: T) => string;
+    /**
+     * Deserialize URL string to value
+     */
+    deserialize: (value: string | null, defaultValue: T) => T;
+}
+/**
+ * Options for URL state hook
+ */
+export interface UseUrlStateOptions<T> {
+    /**
+     * Default value when parameter is not present in URL
+     */
+    defaultValue: T;
+    /**
+     * Custom serializer/deserializer for the value
+     * @default Inferred from defaultValue type
+     */
+    serializer?: UrlStateSerializer<T>;
+    /**
+     * Whether to replace history entry instead of push
+     * @default false
+     */
+    replace?: boolean;
+    /**
+     * Debounce delay for URL updates (ms)
+     * @default 0
+     */
+    debounce?: number;
+}
+/**
+ * Return type for URL state hook
+ */
+export type UseUrlStateReturn<T> = [
+    /** Current value */
+    T,
+    /** Setter function (like useState) */
+    (value: T | ((prev: T) => T)) => void,
+    /** Clear the parameter from URL */
+    () => void
+];
+/**
+ * Built-in serializers for common types
+ */
+export declare const urlStateSerializers: {
+    string: UrlStateSerializer<string>;
+    number: UrlStateSerializer<number>;
+    boolean: UrlStateSerializer<boolean>;
+    json: <T>() => UrlStateSerializer<T>;
+    array: <T extends string>() => UrlStateSerializer<T[]>;
+    numberArray: () => UrlStateSerializer<number[]>;
+};
+/**
+ * Hook that synchronizes React state with URL search parameters
+ *
+ * @example
+ * ```tsx
+ * // Basic string parameter
+ * const [search, setSearch] = useUrlState('q', { defaultValue: '' });
+ *
+ * // Number parameter with debounce
+ * const [page, setPage] = useUrlState('page', {
+ *   defaultValue: 1,
+ *   serializer: urlStateSerializers.number,
+ *   debounce: 300,
+ * });
+ *
+ * // Array parameter
+ * const [tags, setTags] = useUrlState('tags', {
+ *   defaultValue: [],
+ *   serializer: urlStateSerializers.array(),
+ * });
+ * ```
+ */
+export declare function useUrlState<T>(paramName: string, options: UseUrlStateOptions<T>): UseUrlStateReturn<T>;
+export default useUrlState;

package/lib/utils/index.d.ts

@@ -1,5 +1,5 @@
 export { getThemeValue, getColorValue, setThemeValue, applyThemeValues, pxToRem, gridSpacing, isDarkMode, getThemeMode, } from './theme-utils';
-export { getElementBounds, getViewportSize, getScrollPosition, isElementInViewport, } from './dom';
+export { getElementBounds, getViewportSize, getScrollPosition, isElementInViewport } from './dom';
 export type { ElementBounds, ViewportSize, ScrollPosition } from './dom';
-export { calculatePopoverPosition, findBestPosition, } from './positioning';
+export { calculatePopoverPosition, findBestPosition } from './positioning';
 export type { PopoverPosition, PositionCoordinates, PositionOptions, PopoverSize, PopoverWidth, } from './positioning';

package/package.json

@@ -1,55 +1,54 @@
-{
-  "name": "@true-tech-team/react-components",
-  "version": "0.0.9",
-  "description": "React TypeScript component library",
-  "main": "./index.js",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.mjs",
-      "require": "./index.js"
-    }
-  },
-  "scripts": {
-    "build": "nx build ui-components",
-    "test": "nx test ui-components",
-    "test:watch": "nx test ui-components --watch",
-    "test:coverage": "nx test ui-components --coverage",
-    "lint": "nx lint ui-components",
-    "lint:fix": "nx lint ui-components --fix",
-    "storybook": "nx storybook ui-components",
-    "storybook:build": "nx build-storybook ui-components",
-    "typecheck": "tsc --noEmit -p tsconfig.lib.json"
-  },
-  "peerDependencies": {
-    "react": ">=18.0.0",
-    "react-dom": ">=18.0.0"
-  },
-  "files": [
-    "index.js",
-    "index.mjs",
-    "index.d.ts",
-    "**/*.js",
-    "**/*.mjs",
-    "**/*.d.ts",
-    "**/*.css",
-    "**/*.scss"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "directory": "libs/ui-components"
-  },
-  "keywords": [
-    "react",
-    "components",
-    "typescript",
-    "ui",
-    "library"
-  ],
-  "license": "MIT"
-}
-
+{
+  "name": "@true-tech-team/react-components",
+  "version": "0.0.10",
+  "description": "React TypeScript component library",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
+  "scripts": {
+    "build": "nx build ui-components",
+    "test": "nx test ui-components",
+    "test:watch": "nx test ui-components --watch",
+    "test:coverage": "nx test ui-components --coverage",
+    "lint": "nx lint ui-components",
+    "lint:fix": "nx lint ui-components --fix",
+    "storybook": "nx storybook ui-components",
+    "storybook:build": "nx build-storybook ui-components",
+    "typecheck": "tsc --noEmit -p tsconfig.lib.json"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "**/*.js",
+    "**/*.mjs",
+    "**/*.d.ts",
+    "**/*.css",
+    "**/*.scss"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "directory": "libs/ui-components"
+  },
+  "keywords": [
+    "react",
+    "components",
+    "typescript",
+    "ui",
+    "library"
+  ],
+  "license": "MIT"
+}