@colidy/hooks - npm Package Compare versions

Comparing version 0.0.4 to 0.0.6

index.d.ts

@@ -16,1 +16,2 @@ export * from './useDarkMode';
 export * from './useKeyPress';
+export * from './useViewport';

index.js

@@ -32,1 +32,2 @@ "use strict";
 __exportStar(require("./useKeyPress"), exports);
+__exportStar(require("./useViewport"), exports);

package.json

 {
 	"name": "@colidy/hooks",
-	"version": "0.0.4",
+	"version": "0.0.6",
 	"description": "This library provides a collection of custom React hooks to simplify various tasks, including form management, state management, and other utilities. Each hook is designed to be reusable and easy to integrate into your React projects.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -25,2 +25,3 @@ # @colidy/hooks
     - [useFocus](#usefocus)
+    - [useTableOfContents](#useTableOfContents)
 3. [Contributing](#contributing)
@@ -375,2 +376,45 @@ 4. [License](#license)
 
+### 17. `useTableOfContents`
+
+A hook to programmatically set focus on an element.
+
+#### Usage:
+
+```typescript
+import React from 'react';
+import { useTableOfContents } from '@colidy/hooks/useTableOfContents';
+
+interface TOCItem {
+  id: string;
+  level: number;
+  title: string;
+}
+
+const TocComponent: React.FC = () => {
+  const { contents, active } = useTableOfContents(['h2', 'h3', 'h4'], '[data-toc]');
+
+  return (
+    <div>
+      <div data-toc>
+        <h1>Heading 1</h1>
+        <h2>Heading 2</h2>
+        <h3>Heading 3</h3>
+        <h4>Heading 4</h4>
+        <h5>Heading 5</h5>
+        <h6>Heading 6</h6>
+      </div>
+      <ul>
+      {contents.map(({ id, level, text }) => (
+        <li key={id} style={{ marginLeft: \`\${level - 2}em\` }}>
+          {\`Title: \${text}, Level: \${level}, Id: \${id}\`}
+        </li>
+      ))}
+      </ul>
+    </div>
+  );
+};
+
+export default TocComponent;
+```
+
 ## Contributing
@@ -377,0 +421,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37690

increased by13.63%

Number of package files

41

increased by5.13%

Lines of code

602

increased by15.55%

Number of lines in readme file

425

increased by11.55%

Number of medium supply chain risk alerts

1

decreased by-50%

No dependency changes