@slotjs/hooks 0.0.2 → 0.0.3

package/README.md

@@ -1,8 +1,14 @@
 # @slotjs/hooks
 
-```ts
+```bash
+npm i @slotjs/hooks
+```
+
+```tsx
+import { useResponsive } from "@slotjs/hooks";
+
 const Index: React.FC = () => {
-  const isReady = useRootFontSize();
+  const isReady = useResponsive();
 
   return isReady ? (
     <ContentContainer>content</ContentContainer>

package/dist/types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A React hook to set the root font size based on the viewport width.
+ * It scales the font size up to a maximum of 2x the base font size.
+ * This is useful for responsive designs where the font size needs to adapt to different screen sizes.
+ * It listens for window resize events to adjust the font size dynamically.
+ *
+ * @param baseWidth
+ * @param baseFontSize
+ * @example
+ * ```ts
+ * const isReady = useResponsive(1920, 16);
+ * ```
+ * // This will set the root font size based on a base width of 1920px
+ * // and a base font size of 16px.
+ * // The hook returns true once the font size has been set, allowing components to render correctly
+ * // with the appropriate font size.
+ * @returns
+ */
+export declare function useResponsive(baseWidth?: number, baseFontSize?: number): boolean;
+
+export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@slotjs/hooks",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "description": "@slotjs/hooks for react",
   "homepage": "https://github.com/slotjs/hooks.git#readme",
@@ -16,6 +16,7 @@
   "author": "iamwjun",
   "scripts": {
     "dev": "vite",
+    "types": "tsc -p tsconfig.build.json",
     "build": "tsc -b && vite build",
     "lint": "eslint .",
     "preview": "vite preview",
@@ -30,6 +31,7 @@
     "@eslint/js": "^9.32.0",
     "@testing-library/jest-dom": "^6.6.4",
     "@testing-library/react": "^16.3.0",
+    "@types/node": "^24.3.0",
     "@types/react": "^19.1.9",
     "@types/react-dom": "^19.1.7",
     "@vitejs/plugin-react": "^4.7.0",
@@ -41,9 +43,21 @@
     "typescript": "~5.8.3",
     "typescript-eslint": "^8.39.0",
     "vite": "^7.1.0",
+    "vite-plugin-dts": "^4.5.4",
     "vitest": "^3.2.4"
   },
   "files": [
-    "dist"
-  ]
+    "dist",
+    "README.md"
+  ],
+  "main": "dist/index.umd.js",
+  "module": "dist/index.es.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.umd.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  }
 }

package/dist/README.md

@@ -1,13 +0,0 @@
-# @slotjs/hooks
-
-```ts
-const Index: React.FC = () => {
-  const isReady = useRootFontSize();
-
-  return isReady ? (
-    <ContentContainer>content</ContentContainer>
-  ) : (
-    <FullScreenWrapper>loading</FullScreenWrapper>
-  );
-};
-```