xy-hooks

English | 简体中文

xy-hooks

React Hooks Library.

Document

• English
• 中文

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

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:

<code src="./demo/basicScroll.tsx" />

You can import many demos for different usage.

1. 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

License

MIT