@weser/hooks 0.0.14 → 0.0.16

package/README.md

@@ -1,22 +1,3 @@
 # @weser/hooks
 
-<img alt="npm version" src="https://badge.fury.io/js/@weser%2Fhooks.svg"> <img alt="npm downloads" src="https://img.shields.io/npm/dm/@weser/hooks.svg"> <a href="https://bundlephobia.com/result?p=@weser/hooks@latest"><img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/@weser/hooks.svg"></a>
-
-## Installation
-
-```sh
-# npm
-npm i --save @weser/hooks
-# yarn
-yarn add @weser/hooks
-# pnpm
-pnpm add @weser/hooks
-```
-
-## Documentation
-
-## License
-
-@weser/hooks is licensed under the [MIT License](http://opensource.org/licenses/MIT).<br>
-Documentation is licensed under [Creative Common License](http://creativecommons.org/licenses/by/4.0/).<br>
-Created with ♥ by [@robinweser](http://weser.io).
+[Documentation](https://packages.weser.io/hooks)

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { default as useDisclosure } from './useDisclosure.js';
 export { default as useFirstRender } from './useFirstRender.js';
 export { default as useFocusTrap } from './useFocusTrap.js';
 export { default as useKeyDown } from './useKeyDown.js';
+export { default as useList } from './useList.js';
 export { default as useRerender } from './useRerender.js';
 export { default as useRouteChange } from './useRouteChange.js';
 export { default as useScrollBlocking } from './useScrollBlocking.js';

package/dist/index.js

@@ -5,6 +5,7 @@ export { default as useDisclosure } from './useDisclosure.js';
 export { default as useFirstRender } from './useFirstRender.js';
 export { default as useFocusTrap } from './useFocusTrap.js';
 export { default as useKeyDown } from './useKeyDown.js';
+export { default as useList } from './useList.js';
 export { default as useRerender } from './useRerender.js';
 export { default as useRouteChange } from './useRouteChange.js';
 export { default as useScrollBlocking } from './useScrollBlocking.js';

package/dist/useDisclosure.d.ts

@@ -1,15 +1,15 @@
 export default function useDisclosure(defaultExpanded?: boolean): {
     toggleProps: {
-        id: string;
-        onClick: () => void;
-        type: "button";
-        'aria-expanded': boolean;
-        'aria-controls': string;
+        readonly id: string;
+        readonly onClick: () => void;
+        readonly type: "button";
+        readonly 'aria-expanded': boolean;
+        readonly 'aria-controls': string;
     };
     contentProps: {
-        id: string;
-        'aria-hidden': boolean;
-        'aria-labelledby': string;
+        readonly id: string;
+        readonly 'aria-hidden': boolean;
+        readonly 'aria-labelledby': string;
     };
     isExpanded: boolean;
     toggle: () => void;

package/dist/useList.d.ts

@@ -0,0 +1,8 @@
+export default function useList<T>(defaultList?: Array<T>): readonly [T[], {
+    set: (list: Array<T>) => void;
+    add: (item: T) => void;
+    removeAt: (index: number) => void;
+    updateAt: (index: number, item: T) => void;
+    insertAt: (index: number, item: T) => void;
+    clear: () => void;
+}];

package/dist/useList.js

@@ -0,0 +1,31 @@
+import { useState } from 'react';
+export default function useList(defaultList = []) {
+    const [list, setList] = useState(defaultList);
+    function set(list) {
+        setList(list);
+    }
+    function add(item) {
+        setList([...list, item]);
+    }
+    function removeAt(index) {
+        setList(list.filter((_, i) => i !== index));
+    }
+    function updateAt(index, item) {
+        setList(list.map((entry, i) => (i === index ? item : entry)));
+    }
+    function insertAt(index, item) {
+        setList([...list.slice(0, index), item, ...list.slice(index)]);
+    }
+    function clear() {
+        setList([]);
+    }
+    const actions = {
+        set,
+        add,
+        removeAt,
+        updateAt,
+        insertAt,
+        clear,
+    };
+    return [list, actions];
+}

package/dist/useRouteChange.d.ts

@@ -1 +1 @@
-export default function useRouteChange(onRouteChange: (path: string) => void, pathname?: string): void;
+export default function useRouteChange(onRouteChange: (path: string) => void, pathname?: string, dependencies?: any[]): void;

package/dist/useRouteChange.js

@@ -1,10 +1,10 @@
 import { useEffect } from 'react';
-export default function useRouteChange(onRouteChange, pathname) {
+export default function useRouteChange(onRouteChange, pathname, dependencies = []) {
     useEffect(() => {
         if (pathname) {
             onRouteChange(pathname);
         }
-    }, [pathname]);
+    }, [pathname, ...dependencies]);
     // track clicks on links with the current path
     useEffect(() => {
         const onClick = (e) => {
@@ -17,7 +17,7 @@ export default function useRouteChange(onRouteChange, pathname) {
         };
         window.addEventListener('click', onClick);
         return () => window.removeEventListener('click', onClick);
-    }, [pathname]);
+    }, [pathname, ...dependencies]);
 }
 function getContainingAnchor(node) {
     if (!node || !(node instanceof Node))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weser/hooks",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "React hooks for building apps",
   "author": "Robin Weser <robin@weser.io>",
   "license": "MIT",
@@ -52,5 +52,5 @@
     "rimraf": "^3.0.2",
     "typescript": "^5.4.5"
   },
-  "gitHead": "2844a44c54a0ada9f675baf40226f87fe894c29f"
+  "gitHead": "7b2bc4fa318330eb2031b0d1835554a8a9f0f6bd"
 }