hooks - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #llm #golang #android #machine-learning #docker #nodejs #awesome #kubernetes #awesome-list #pytorch #ios #openai

hooks

(★ 14,978)

A high-quality & reliable React Hooks library. https://alibaba.github.io/hooks/

File Explorer

Download Latest Version (.zip)

- - demo.mdc
  - docs.mdc
  - git.mdc
  - project.mdc
  - testing.mdc
  - typescript.mdc
- - pr_cn.md
- - comment-when-needs-more-info.yml
  - gitleaks.yml
  - issue-close-require.yml
  - issue-reply.yml
  - pkg.pr.new.yml
  - static.yml
  - test.yml
- PULL_REQUEST_TEMPLATE.md
- commit-msg
- pre-commit
- config.ts
- hooks.ts
- - dom.en-US.md
  - dom.zh-CN.md
  - index.en-US.md
  - index.zh-CN.md
  - upgrade.en-US.md
  - upgrade.zh-CN.md
- index.en-US.md
- index.zh-CN.md
- .gitkeep
- - gulpfile.js
  - package.json
  - tsconfig.json
  - tsconfig.pro.json
  - vitest.config.ts
  - webpack.config.ts
- - gulpfile.js
  - package.json
  - README.md
  - tsconfig.json
  - tsconfig.pro.json
  - use-url-state.en-US.md
  - use-url-state.zh-CN.md
  - vitest.config.ts
  - webpack.config.ts
- - bootstrap-badge.css
  - test-external-script.js
- logo.svg
- simple-logo.svg
- style.css
- build-with-relative-paths.js
.babelrc
.coveralls.yml
.editorconfig
.gitignore
.gitleaks.toml
.npmrc
.travis.yml
AGENTS.md
biome.json
CLAUDE.md
CONTRIBUTING.MD
CONTRIBUTING.zh-CN.MD
gulpfile.js
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
README.zh-CN.md
SECURITY.md
tsconfig.base.json
tsconfig.pro.json
umd.html
vitest.config.ts
webpack.common.ts

# Installation Guide

1. Get the code

git clone https://github.com/alibaba/hooks

Downloads the entire project code from GitHub to your computer.

cd hooks

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install --save ahooks

Downloads and installs the libraries listed in package.json.

$ yarn add ahooks

Type this command into your terminal and run it.

$ pnpm add ahooks

Type this command into your terminal and run it.

$ pnpm run init

Type this command into your terminal and run it.

$ pnpm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <a href="https://ahooks.js.org">
    <img width="200" src="https://ahooks.js.org/logo.svg">
  </a>
</p>

<div align="center">

A high-quality & reliable React Hooks library.

[![NPM version][image-1]][1]
[![NPM downloads][image-2]][2]
[![npm](https://img.shields.io/npm/dw/ahooks-v2?label=downloads%28v2%29)](https://www.npmjs.com/package/ahooks-v2)
[![npm](https://img.shields.io/github/issues/alibaba/hooks)](https://github.com/alibaba/hooks/issues)
[![Coverage Status](https://coveralls.io/repos/github/alibaba/hooks/badge.svg?branch=master)](https://coveralls.io/github/alibaba/hooks?branch=master)
![gzip size](https://img.badgesize.io/https:/unpkg.com/ahooks/dist/ahooks.js?label=gzip%20size&compression=gzip)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks "Percentage of issues still open")
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/alibaba/hooks.svg)](http://isitmaintained.com/project/alibaba/hooks "Average time to resolve an issue")
![GitHub](https://img.shields.io/github/license/alibaba/hooks)

English | [简体中文](https://github.com/alibaba/hooks/blob/master/README.zh-CN.md)

</div>

## 📚 Documentation

- [English](https://ahooks.js.org/)
- [中文](https://ahooks.js.org/zh-CN/)

> Notice
>
> `use-url-state` is now published as `@ahooks.js/use-url-state`.
>
> If you are installing or upgrading this package, please use the new package name.

## ✨ Features

- Easy to learn and use
- Supports SSR
- Special treatment for functions, avoid closure problems
- Contains a large number of advanced Hooks that are refined from business scenarios
- Contains a comprehensive collection of basic Hooks
- Written in TypeScript with predictable static types

## 📦 Install

```bash
$ npm install --save ahooks
# or
$ yarn add ahooks
# or
$ pnpm add ahooks
# or
$ bun add ahooks
```

## 🔨 Usage

```ts
import { useRequest } from "ahooks";
```

## 💻 Online Demo

[![Edit demo for ahooks](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/demo-for-ahooks-forked-fg79k?file=/src/App.js)

## 🤝 Contributing

```bash
$ git clone git@github.com:alibaba/hooks.git
$ cd hooks
$ pnpm run init
$ pnpm start
```

Open your browser and visit http://127.0.0.1:8000

We welcome all contributions, please read our [CONTRIBUTING.MD](https://github.com/alibaba/hooks/blob/master/CONTRIBUTING.MD) first, let's build a better hooks library together.

Thanks to all the contributors:

<a href="https://github.com/alibaba/hooks/graphs/contributors">
  <img src="https://opencollective.com/ahooks/contributors.svg?width=960&button=false" alt="contributors" />
</a>

## 👥 Discuss

<img alt="ahooks discussion group 1" draggable="false" src="https://github.com/user-attachments/assets/dda464be-26cf-4c83-8fee-16862fb916cb" width="200" style='display:inline' />
<img alt="ahooks discussion group 2" draggable="false" src="https://github.com/user-attachments/assets/c804a026-3b07-4a20-ad7e-83cf2f86bc9a" width="200" style='display:inline' />
<img alt="ahooks discussion group 3" draggable="false" src="https://github.com/user-attachments/assets/52ac8ef8-6506-4540-a17d-823ae4371b88" width="200" style='display:inline' />

[1]: https://www.npmjs.com/package/ahooks
[2]: https://npmjs.org/package/ahooks
[image-1]: https://img.shields.io/npm/v/ahooks.svg?style=flat
[image-2]: https://img.shields.io/npm/dw/ahooks.svg?style=flat