@qtpy/use-ref-map 0.0.2 → 0.0.3

package/README.md

@@ -18,7 +18,7 @@
 | `getRef`       | `(key: string) => RefObject<T>`         | Возвращает ссылку (`RefObject`) для указанного ключа. Если ссылка не существует, создаётся новая с `current: null`. |
 | `deleteRef`    | `(key: string) => void`                 | Удаляет ссылку и соответствующий ключ из внутреннего хранилища.          |
 | `clearAllRefs` | `() => void`                            | Очищает все ссылки и ключи из внутреннего хранилища.                     |
-| `allKeys`   | `string[]`                              | Возвращает массив всех ключей, связанных с существующими ссылками.       |
+| `getAllKeys`   | `() => string[]`                              | Возвращает массив всех ключей, связанных с существующими ссылками.       |
 
 ## Использование
 
@@ -32,7 +32,7 @@ import useEvent from '@qtpy/use-event'; // хук для обработки со
 import { useState } from 'react';
 
 function ProjectsPage() {
-  const { getRef, allKeys } = useRefMap<HTMLDivElement>();
+  const { getRef, getAllKeys } = useRefMap<HTMLDivElement>();
   const [activeIndex, setActiveIndex] = useState(0);
   const projects = ['Проект 1', 'Проект 2', 'Проект 3'];
 
@@ -64,7 +64,7 @@ function ProjectsPage() {
         ))}
       </div>
       <p>Активный проект: {projects[activeIndex]}</p>
-      <p>Ключи ссылок: {allKeys.join(', ')}</p>
+      <p>Ключи ссылок: {getAllKeys.join(', ')}</p>
     </div>
   );
 }
@@ -72,7 +72,7 @@ function ProjectsPage() {
 
 Ссылка на хук [**useEvent**](https://www.npmjs.com/package/@qtpy/use-event)
 
-В этом примере хук `useRefMap` используется для создания ссылок на элементы `<div>` с помощью метода `map` и ключей вида `project_${index}`. При прокрутке страницы хук `useEvent` проверяет положение каждого элемента через `getBoundingClientRect` и обновляет `activeIndex`, если элемент выходит за верхнюю границу окна, подсвечивая активный проект. Список ключей выводится через `allKeys`.
+В этом примере хук `useRefMap` используется для создания ссылок на элементы `<div>` с помощью метода `map` и ключей вида `project_${index}`. При прокрутке страницы хук `useEvent` проверяет положение каждого элемента через `getBoundingClientRect` и обновляет `activeIndex`, если элемент выходит за верхнюю границу окна, подсвечивая активный проект. Список ключей выводится через `getAllKeys`.
 
 ### Императивное управление (вызов метода компонента)
 
@@ -135,11 +135,11 @@ function Component() {
 import useRefMap from '@qtpy/use-ref-map';
 
 function Component() {
-  const { getRef, clearAllRefs, allKeys } = useRefMap<HTMLElement>();
+  const { getRef, clearAllRefs, getAllKeys } = useRefMap<HTMLElement>();
 
   const clearRefs = () => {
     clearAllRefs();
-    console.log('Все ссылки очищены. Текущие ключи:', allKeys);
+    console.log('Все ссылки очищены. Текущие ключи:', getAllKeys());
   };
 
   return (
@@ -147,7 +147,7 @@ function Component() {
       <section ref={getRef('section1')}>Секция 1</section>
       <section ref={getRef('section2')}>Секция 2</section>
       <button onClick={clearRefs}>Очистить все ссылки</button>
-      <p>Ключи: {allKeys.join(', ')}</p>
+      <p>Ключи: {getAllKeys().join(', ')}</p>
     </div>
   );
 }
@@ -161,10 +161,10 @@ function Component() {
 import useRefMap from '@qtpy/use-ref-map';
 
 function Component() {
-  const { getRef, allKeys } = useRefMap<HTMLElement>();
+  const { getRef, getAllKeys } = useRefMap<HTMLElement>();
 
   const logKeys = () => {
-    console.log('Текущие ключи:', allKeys);
+    console.log('Текущие ключи:', getAllKeys());
   };
 
   return (
@@ -172,7 +172,7 @@ function Component() {
       <section ref={getRef('section1')}>Секция 1</section>
       <section ref={getRef('section2')}>Секция 2</section>
       <button onClick={logKeys}>Вывести ключи</button>
-      <p>Ключи: {allKeys.join(', ')}</p>
+      <p>Ключи: {getAllKeys().join(', ')}</p>
     </div>
   );
 }
@@ -189,7 +189,7 @@ export type RefMapMethods<T> = {
   getRef: (key: string) => RefObject<T>;
   deleteRef: (key: string) => void;
   clearAllRefs: () => void;
-  allKeys: string[];
+  getAllKeys: () => string[];
 };
 
 export type UseRefMapReturn<T, E extends keyof RefMapMethods<T>> = Pick<RefMapMethods<T>, E>;
@@ -205,5 +205,5 @@ export type UseRefMapReturn<T, E extends keyof RefMapMethods<T>> = Pick<RefMapMe
 - **Инициализация ссылок**: Метод `getRef` создаёт новую ссылку с `current: null`, если ссылка для указанного ключа ещё не существует.
 - **Типизация**: Хук поддерживает обобщённый тип `T` для работы с любыми типами данных (например, пользовательскими интерфейсами компонентов или `HTMLElement`). В отличие от предыдущей версии, `getRef` возвращает `RefObject<T>` вместо `RefObject<Partial<T>>`, предполагая, что `current` может быть `null`, но типизация остаётся строгой.
 - **Управление памятью**: Метод `deleteRef` удаляет отдельные ссылки, а `clearAllRefs` очищает все ссылки, предотвращая утечки памяти. Хук автоматически очищает все ссылки при размонтировании компонента через `useEffect`.
-- **Сохранение состояния**: Хук использует `useRef` для хранения ссылок и ключей, а `useMemo` для кэширования массива ключей, обновляемого через внутренний счётчик версии (`version`).
-- **Ограничение типизации**: Свойство `allKeys` возвращает `string[]` напрямую, а не функцию, что упрощает доступ к ключам, но требует использования `useMemo` для оптимизации рендеринга.
+- **Сохранение состояния**: Хук использует `useRef` для хранения ссылок и ключей.
+- **Ограничение типизации**: Свойство `getAllKeys` возвращает `string[]`.

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";const t=require("react");function l(){const r=t.useRef({}),n=t.useRef(new Set),[u,f]=t.useState(0),o=e=>(r.current[e]||(r.current[e]={current:null},n.current.add(e)),r.current[e]),c=e=>{r.current[e]&&(delete r.current[e],n.current.delete(e))},s=()=>{Object.keys(r.current).forEach(c),f(e=>e+1)};return t.useEffect(()=>()=>s(),[]),{getRef:o,deleteRef:c,clearAllRefs:s,allKeys:t.useMemo(()=>Array.from(n.current),[u])}}module.exports=l;
+"use strict";const c=require("react");function f(){const r=c.useRef({}),t=c.useRef(new Set),s=e=>(r.current[e]||(r.current[e]={current:null},t.current.add(e)),r.current[e]),n=e=>{r.current[e]&&(delete r.current[e],t.current.delete(e))},u=()=>{Object.keys(r.current).forEach(n)};return c.useEffect(()=>u,[]),{getRef:s,deleteRef:n,clearAllRefs:u,getAllKeys:()=>Array.from(t.current)}}module.exports=f;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export type RefMapMethods<T> = {
     getRef: (key: string) => RefObject<T>;
     deleteRef: (key: string) => void;
     clearAllRefs: () => void;
-    allKeys: string[];
+    getAllKeys: () => string[];
 };
 export default function useRefMap<T>(): RefMapMethods<T>;
 export type UseRefMapReturn<T, E extends keyof RefMapMethods<T>> = Pick<RefMapMethods<T>, E>;

package/dist/index.mjs

@@ -1,17 +1,17 @@
-import { useRef as s, useState as l, useEffect as a, useMemo as d } from "react";
-function R() {
-  const r = s({}), t = s(/* @__PURE__ */ new Set()), [u, f] = l(0), o = (e) => (r.current[e] || (r.current[e] = { current: null }, t.current.add(e)), r.current[e]), n = (e) => {
+import { useRef as u, useEffect as s } from "react";
+function o() {
+  const r = u({}), t = u(/* @__PURE__ */ new Set()), f = (e) => (r.current[e] || (r.current[e] = { current: null }, t.current.add(e)), r.current[e]), n = (e) => {
     r.current[e] && (delete r.current[e], t.current.delete(e));
   }, c = () => {
-    Object.keys(r.current).forEach(n), f((e) => e + 1);
+    Object.keys(r.current).forEach(n);
   };
-  return a(() => () => c(), []), {
-    getRef: o,
+  return s(() => c, []), {
+    getRef: f,
     deleteRef: n,
     clearAllRefs: c,
-    allKeys: d(() => Array.from(t.current), [u])
+    getAllKeys: () => Array.from(t.current)
   };
 }
 export {
-  R as default
+  o as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qtpy/use-ref-map",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "author": "QtPy",
   "license": "MIT",
   "homepage": "https://github.com/TheOnlyFastCoder2/QtPy-library/tree/main/useRefMap",