Thanks to visit codestin.com
Credit goes to github.com

Skip to content

galiprandi/react-tools

Repository files navigation

@galiprandi/react-tools

✨ Simple, composable & accessible utilities for React development.

Logo

NPM Downloads JSR Version GitHub Stars


πŸ“š Table of Contents


🧠 Overview

@galiprandi/react-tools is a lightweight, dependency-free utility library for React. It provides reusable components and hooks to simplify development and improve accessibility β€” no configuration needed.

πŸ‘‰ Live Playground


πŸš€ Installation

npm install @galiprandi/react-tools
# or
yarn add @galiprandi/react-tools
# or
pnpm add @galiprandi/react-tools

πŸ“¦ Components


AsyncBlock

Description
Declarative component to render async data with loading, success, and error states. Automatically cancels in-flight requests when dependencies change.

Example

<AsyncBlock
  promiseFn={() => fetch(`/api/user`).then(res => res.json())}
  pending={<p>Loading...</p>}
  success={(data) => <p>Welcome {data.name}</p>}
  error={(err) => <p>Error: {(err as Error).message}</p>}
  timeOut={5000}
  deps={[userId]}
/>

Props

Prop Type Description
promiseFn (signal?: AbortSignal) => Promise<T> Async function returning a Promise
pending ReactNode | () => ReactNode UI while loading
success (data: T) => ReactNode UI on success
error (err: unknown) => ReactNode UI on error
timeOut number Optional timeout in ms
deps any[] Dependency list for re-execution
onSuccess (data: T) => void Optional success callback
onError (err: unknown) => void Optional error callback

Form

Description
Enhanced <form> element that automatically gathers and returns values on submit.

Example

<Form<{ username: string }> onSubmitValues={console.log} filterEmptyValues>
  <Input name="username" label="Username" />
  <button type="submit">Submit</button>
</Form>

Props

Prop Type Description
onSubmitValues (values: T) => void Handles form submission with collected values
filterEmptyValues boolean (default: false) Remove empty fields before submission

Input

Description
Custom input component supporting transformations, debounce, datalist, and more.

Example

<Input
  label="Email"
  name="email"
  placeholder="Enter your email"
  transform="onlyEmail"
  onChangeValue={(val) => console.log(val)}
  debounceDelay={500}
/>

Props

Prop Type Description
label string Optional label
transform string ("titleCase", "onlyEmail"...) Built-in value transforms
transformFn (value: string) => string Custom value transform
onChangeValue (value: string) => void Fires on value change
onChangeDebounce (value: string) => void Fires after debounce
debounceDelay number Delay in milliseconds
datalist string[] List of autocomplete suggestions

DateTime

Description
A wrapper around <input type="datetime-local" /> that handles ISO string conversion.

Example

<DateTime
  label="Appointment"
  isoValue={value}
  onChangeISOValue={setValue}
/>

Props

Prop Type Description
isoValue string ISO 8601 datetime value
onChangeISOValue (iso: string) => void Callback with ISO string
...InputProps All <Input /> props Inherits all Input behavior

Dialog

Description
Accessible dialog/modal component built on top of the native <dialog> element.

Example

<Dialog
  behavior="modal"
  opener={<button>Open Modal</button>}
  onClose={() => console.log('Closed')}
>
  <p>This is a dialog!</p>
</Dialog>

Props

Prop Type Description
isOpen boolean Controlled open state (optional)
behavior 'dialog' | 'modal' Dialog type (default: 'modal')
onOpen () => void Triggered on open
onClose () => void Triggered on close
opener ReactNode Element to trigger opening
children ReactNode Content inside the dialog

Observer

Description
Tracks whether a child element is visible in the viewport using IntersectionObserver.

Example

<Observer onChange={(visible) => console.log(visible)}>
  <div>Watch me appear!</div>
</Observer>

Props

Prop Type Description
onChange (isVisible: boolean) => void Callback when visibility changes
threshold number | number[] Intersection threshold (optional)

LazyRender

Description
Only renders children when they become visible in the viewport.

Example

<LazyRender placeholder={<span>Loading...</span>}>
  <img src="/heavy-image.jpg" alt="Lazy" />
</LazyRender>

Props

Prop Type Description
placeholder ReactNode Rendered before children become visible
threshold number | number[] Optional visibility sensitivity

πŸͺ Hooks

useDebounce

Description
A React hook that returns a debounced version of a value. Useful for search input, filters, etc.

Example

const debouncedSearch = useDebounce(searchTerm, 500);

Props

Parameter Type Description
value T Value to debounce
delay number Delay in milliseconds

Returns
Debounced version of the value (T).


useTimer

Description Managing timers like setTimeout and setInterval directly in React components can be complex, often leading to issues like memory leaks, unexpected behavior during re-renders, or difficulties in cancellation when components unmount.

The useTimer hook abstracts this complexity, providing a safe, declarative, and easy-to-use way to work with various types of timers. It ensures automatic cleanup, integrates with component lifecycles, and offers event callbacks for monitoring timer status, including progress for longer durations.

Features

  • Automatic Cleanup: Timers are automatically cleared when the component using the hook unmounts, preventing memory leaks.
  • Lifecycle Events: Receive notifications when a timer is set, cancelled, completes, or reports progress.
  • Flexible Scheduling: Set timers by milliseconds, a future Date object, or as limited intervals.
  • Simplified Control: Clear any active timer with a single method call.

Parameters (options)

Parameter Type Description
onSetTimer (timerId: number) => void Callback fired when a new timer is successfully set.
onCancelTimer (timerId: number) => void Callback fired when an active timer is cleared/cancelled.
onTimerComplete (timerId: number) => void Callback fired when a timer completes naturally (timeout) or for each interval execution (interval/limited interval).
onProgress (progress: number, elapsedMs: number, totalMs: number) => void Callback fired periodically during long timers (setTimeout) and limited intervals to report progress (0 to 1).

Returns An object containing control methods and status/info getters.

Property Type Description
setTimeout (callback: () => void, delay: number | Date) => number | null Sets a timeout with event callbacks. Accepts milliseconds or a future Date. Returns the timer ID.
setInterval (callback: () => void, delay: number) => number | null Sets an interval with event callbacks. Accepts milliseconds. Returns the timer ID.
setTimeoutDate (callback: () => void, targetDate: Date) => number | null Sets a timeout to execute at a specific future Date. Returns the timer ID.
setLimitedInterval (callback: () => void, delay: number, iterations: number) => number | null Sets an interval that executes a fixed number of times. Returns the timer ID.
clearTimer () => void Clears any currently active timer set by this hook instance.
isActive () => boolean Returns true if a timer is currently active, false otherwise.
getCurrentTimerId () => number | null Returns the ID of the currently active timer, or null.
getRemainingIterations () => number | null For setLimitedInterval, returns remaining executions.
getRemainingTime () => number For an active setTimeout, returns estimated remaining time in ms, otherwise -1.

Example

This example demonstrates how useTimer simplifies scheduling an action for a specific future targetDate and automatically handles cleanup, while utilizing event callbacks to monitor its state.

import { useEffect } from 'react';
import { useTimer } from '@galiprandi/react-tools';

function FutureExecution({ targetDate }: { targetDate: Date }) {
  const { setTimeoutDate, clearTimer } = useTimer({
    onSetTimer: (id) => console.log(`Timer ID ${id} set for future execution`),
    onTimerComplete: (id) => console.log(`Timer ID ${id} completed!`),
    onCancelTimer: (id) => console.log(`Timer ID ${id} cancelled!`),
    onProgress: (progress) =>
      console.log(`Progress: ${Math.round(progress * 100)}%`),
  });

  useEffect(() => {
    console.log(`Scheduling action for: ${targetDate.toLocaleTimeString()}`);

    setTimeoutDate(() => {
      // Do something here, like a fake fetch request
      console.log("--- Fake fetch executed! ---");
    }, targetDate);

    // ⚠️ Remember to clear the timer when the component unmounts or when the targetDate changes
    return () => {
      console.log('Component unmounting or targetDate change, clearing timer.');
      clearTimer();
    };
  }, [setTimeoutDate, clearTimer, targetDate]);

  return (
    <div>
      <p>Check the console for timer messages.</p>
    </div>
  );
}

useList

Description A React hook to simplify managing array state in components. It provides immutable helper methods for common operations like adding, inserting, removing, updating, finding, and counting items based on index or item properties, reducing boilerplate compared to manual state updates.

Parameters

Parameter Type Description
initialList T[] The initial array state (defaults to [])

Returns An object containing the current array state (list) and helper functions to modify or query it immutably.

Property Type Description
list T[] The current array state.
addItem (item: T) => void Adds an item to the end of the array.
insert (index: number, item: T) => void Inserts an item at the specified index. If the index is out of bounds, the item is added to the beginning (index < 0) or end (index > length).
insertMany (items: T[]) => void Adds multiple items to the end of the array. Does nothing if input is not an array or is empty.
removeByIdx (index: number) => void Removes the item at the specified index. If the index is out of bounds, the list remains unchanged.
removeBy (key: string | undefined | null, value: any) => void Removes the first item where item[key] strictly equals value. If key is undefined or null, removes the first item where item strictly equals value (useful for primitives). If no match is found, the list remains unchanged.
removeManyBy (key: string | undefined | null, value: any) => void Removes all items where item[key] strictly equals value. If key is undefined or null, removes all items where item strictly equals value (useful for primitives). If no match is found, the list remains unchanged.
updateByIdx (index: number, updateFn: (item: T) => T) => void Updates the item at the specified index using an immutable updateFn. If the index is out of bounds, the list remains unchanged.
updateBy (key: string | undefined | null, value: any, updateFn: (item: T) => T) => void Updates the first item where item[key] strictly equals value (or item === value if key is null/undefined) using an immutable updateFn. If no match is found, the list remains unchanged.
updateManyBy (key: string | undefined | null, value: any, updateFn: (item: T) => T) => void Updates all items where item[key] strictly equals value (or item === value if key is null/undefined) using an immutable updateFn. If no matches are found, the list remains unchanged.
clearList () => void Removes all items from the list, setting it to an empty array.
setList (newList: T[] | ((currentList: T[]) => T[])) => void Replaces the entire list array, similar to the standard useState setter. Accepts a new array or a function updater.
findItemBy (key: string | undefined | null, value: any) => T | undefined Finds and returns the first item where item[key] strictly equals value. If key is undefined or null, finds the first item where item strictly equals value. Does not modify the list. Returns undefined if not found.
findItemsBy (key: string | undefined | null, value: any) => T[] Finds and returns all items where item[key] strictly equals value. If key is undefined or null, finds all items where item strictly equals value. Does not modify the list. Returns an empty array if no matches are found.
count (predicate?: (item: T) => boolean) => number Returns the total number of items in the list, or the count of items matching an optional predicate. Does not modify the list.

β™Ώ Accessibility & Performance

All components follow accessibility best practices:

  • βœ… Dialog uses proper ARIA roles and keyboard focus control.
  • βœ… Input supports labeling, aria attributes, and datalists.
  • βœ… LazyRender and Observer use IntersectionObserver to optimize rendering.

❓ FAQ

Q: Is this compatible with React Native?
A: No, this library is intended for use in React DOM (web).

Q: Can I style components with Tailwind or CSS modules?
A: Yes, components are unstyled and fully customizable.

Q: Does it support SSR or work in Next.js?
A: Yes, all components are compatible with SSR environments.

Q: How can I report a bug or request a new feature?
A: Open an issue on the GitHub repo.


πŸ“„ License

MIT Β© @galiprandi

About

A set of simple and intuitive utilities for developing React applications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages