Skip to main content

Getting Started

Install @ts-hooks-kit/core, understand compatibility, and integrate hooks into your app.


Introduction

@ts-hooks-kit/core is a TypeScript-first React hooks library with strong API parity to usehooks-ts, plus additional production-focused hooks. The goal is a familiar developer experience with modern React 18/19 support.

Requirements

  • React 18 or 19
  • TypeScript 5+ (recommended, not required)
  • Node.js 20+

Install

Use your preferred package manager:

pnpm add @ts-hooks-kit/core
npm install @ts-hooks-kit/core
yarn add @ts-hooks-kit/core
bun add @ts-hooks-kit/core

Basic Usage

import { useBoolean, useLocalStorage } from '@ts-hooks-kit/core'

export function Example() {
  const { value, toggle } = useBoolean(false)
  const [name] = useLocalStorage('name', 'ts-hooks-kit')

  return (
    <button type="button" onClick={toggle}>
      {value ? `Enabled for ${name}` : 'Disabled'}
    </button>
  )
}

Compatibility

  • React ^18 || ^19
  • TypeScript-first APIs
  • ESM + CJS outputs
  • Tree-shakeable — import only what you need