90 lines
3.1 KiB
Plaintext
90 lines
3.1 KiB
Plaintext
<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]
|
|
[](https://www.npmjs.com/package/ahooks-v2)
|
|
[](https://github.com/alibaba/hooks/issues)
|
|
[](https://coveralls.io/github/alibaba/hooks?branch=master)
|
|
|
|
[](http://isitmaintained.com/project/alibaba/hooks "Percentage of issues still open")
|
|
[](http://isitmaintained.com/project/alibaba/hooks "Average time to resolve an issue")
|
|
|
|
|
|
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/)
|
|
|
|
## ✨ 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
|
|
|
|
[](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 src="https://github.com/user-attachments/assets/0ba7a370-2a69-442f-b746-9eb16bbbc46c" width="200" style='display:inline' />
|
|
<img src="https://github.com/user-attachments/assets/a08693d3-bfcc-4aca-b2b0-2d9c23012858" width="200" style='display:inline' />
|
|
<img src="https://github.com/user-attachments/assets/15a505a7-06d1-4e72-ab02-6fad968323f1" 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
|