# xy-hooks

> English | [简体中文](./README.zh-CN.md)

Latest version **0.0.1-beta.1** (published 2020-12-11) · 0 weekly downloads

## Install

```sh
npm install xy-hooks
pnpm add xy-hooks
yarn add xy-hooks
bun add xy-hooks
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-beta.1 |
| Published | 2020-12-11 |
| First published | 2020-12-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 990.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | xylink.com |

## Links

- npm: https://www.npmjs.com/package/xy-hooks
- Repository: https://github.com/xylink-com/xyhooks
- Homepage: https://github.com/xylink-com/xyhooks#readme
- Issues: https://github.com/xylink-com/xyhooks/issues
- npm.io page: https://npm.io/package/xy-hooks

## Dependencies (1)

- [intersection-observer](https://npm.io/package/intersection-observer.md) ^0.11.0

## Recent versions

- 0.0.1-beta.1 (latest) — 2020-12-11

## README

English | [简体中文](./README.zh-CN.md)

# xy-hooks

React Hooks Library.

## 📚 Document

- [English](https://xylink-com.github.io/xy-hooks/)
- [中文](https://xylink-com.github.io/xy-hooks/zh-CN)

## ✨ Features

- Easy to learn and use.
- Contains a wealth of advanced Hooks that are refined from the app.
- Contains a wealth of basic Hooks.
- Written in TypeScript with predictable static types.

## 📦 Install

```
npm i xy-hooks --save
```

## 🔨 Usage

```
import { useRafInterval } from 'xy-hooks';
```

## 🤝 Contributing

```
$ git clone git@github.com:xylink-com/xy-hooks.git
$ cd xy-hooks
$ npm run init
$ npm start
```

Open your browser and visit http://127.0.0.1:8000 , see more at Development.

Feel relax to pull request if you have more ideas: [Pull request](https://github.com/xylink-com/xy-hooks/pulls)

## Quick start

You can copy the example directory to start your development quickly.Remember to register your hook in `index.ts` under src directory.

## 🤡 Demo & Doc

1. Write demo in the demo directory of your component.
2. Write docs in index.zh-CN.md for Chinese and index.en-US.md for English.
3. Embed your demo in your docs via `code` tag, like this:
```ts
<code src="./demo/basicScroll.tsx" />
```
You can import many demos for different usage.

4. Build docs with command `yarn build:doc`, the docs generated will de deployed in static Github Pages after your code be pushed to master.

## 👥 Discuss

Welcome to issues: [Push issues](https://github.com/xylink-com/xy-hooks/issues)

## ✅ License

[MIT](https://github.com/xylink-com/xy-hooks/blob/master/LICENSE)

---
_Source: https://npm.io/package/xy-hooks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._