Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 3.18 KB

README.md

File metadata and controls

92 lines (70 loc) · 3.18 KB
Raw

React Utilities 🚀

npm version JSR License Coverage Node.js pnpm Version | React Vitest Eslint Prettier

This repository is NOT a reimplementation of React itself. It is a collection of reusable React hooks, utilities, and tools to enhance development productivity. 🎉

Features

  • 🚀 Lightweight and optimized hooks and utilities for React projects.
  • 📦 Fully typed with TypeScript for better developer experience.
  • 🔒 Clean and consistent utilities for DOM, state, and async operations.
  • ✅ 100% (almost) test coverage with robust testing using Vitest.

Installation

Install the package via npm, yarn, pnpm, bun, or deno from JSR:

# With npm
npm install @zl-asica/react
# With yarn
yarn add @zl-asica/react
# With pnpm
pnpm add @zl-asica/react
# With bun
bun add @zl-asica/react
// With deno from JSR
import { useLocalStorage } from 'jsr:@zl-asica/react';

Usage

For more examples, check the documentation.

Example: useToggle

import { useToggle } from '@zl-asica/react';

const App = () => {
  const [isToggled, toggle] = useToggle(false);

  return <button onClick={toggle}>{isToggled ? 'ON' : 'OFF'}</button>;
};

Limitations

ESM only. This package is built with ESM and is not compatible with CommonJS. If you are using CommonJS, sorry, this package is not for you. 😢

Contributing

Contributions are welcome! Feel free to open an issue or submit a PR. ❤️

License

This project is licensed under the MIT License.