@slotjs/hooks 0.0.1 → 0.0.3

package/README.md

@@ -1,69 +1,19 @@
-# React + TypeScript + Vite
+# @slotjs/hooks
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```bash
+npm i @slotjs/hooks
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+```tsx
+import { useResponsive } from "@slotjs/hooks";
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+const Index: React.FC = () => {
+  const isReady = useResponsive();
 
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+  return isReady ? (
+    <ContentContainer>content</ContentContainer>
+  ) : (
+    <FullScreenWrapper>loading</FullScreenWrapper>
+  );
+};
 ```

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,9 +1,9 @@
 {
   "name": "@slotjs/hooks",
   "private": false,
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
-  "description": "code snippet",
+  "description": "@slotjs/hooks for react",
   "homepage": "https://github.com/slotjs/hooks.git#readme",
   "bugs": {
     "url": "https://github.com/slotjs/hooks.git/issues"
@@ -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"
+    }
+  }
 }