text: (window["webpackJsonp"]=window["webpackJsonp"]||[]).push([[0],{zpjW:function(e,t,n){"use strict";n.r(t);var a=n("q1tI"),l=n.n(a),i=n("dEAq"),c=n("ZpkN");t["default"]=function(){return l.a.createElement(l.a.Fragment,null,l.a.createElement("div",{className:"markdown"},l.a.createElement("h2",{id:"-features"},l.a.createElement(i["AnchorLink"],{to:"#-features","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\u2728 Features"),l.a.createElement("ul",null,l.a.createElement("li",null,"Easy to learn and use."),l.a.createElement("li",null,"Contains a wealth of advanced Hooks that are refined from the app."),l.a.createElement("li",null,"Contains a wealth of basic Hooks."),l.a.createElement("li",null,"Written in TypeScript with predictable static types.")),l.a.createElement("h2",{id:"-install"},l.a.createElement(i["AnchorLink"],{to:"#-install","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\ud83d\udce6 Install"),l.a.createElement(c["a"],{code:"npm i xy-hooks --save\n",lang:"unknown"}),l.a.createElement("h2",{id:"-usage"},l.a.createElement(i["AnchorLink"],{to:"#-usage","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\ud83d\udd28 Usage"),l.a.createElement(c["a"],{code:"import { useRafInterval } from 'xy-hooks';\n",lang:"unknown"}),l.a.createElement("h2",{id:"\ud83e\udd1d-contributing"},l.a.createElement(i["AnchorLink"],{to:"#\ud83e\udd1d-contributing","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\ud83e\udd1d Contributing"),l.a.createElement(c["a"],{code:"$ git clone git@github.com:xylink-com/xy-hooks.git\n$ cd xy-hooks\n$ npm run init\n$ npm start\n",lang:"unknown"}),l.a.createElement("p",null,"Open your browser and visit ",l.a.createElement(i["Link"],{to:"http://127.0.0.1:8000/"},"http://127.0.0.1:8000")," , see more at Development."),l.a.createElement("p",null,"Feel relax to pull request if you have more ideas: ",l.a.createElement(i["Link"],{to:"https://github.com/xylink-com/xy-hooks/pulls"},"Pull request")),l.a.createElement("h2",{id:"quick-start"},l.a.createElement(i["AnchorLink"],{to:"#quick-start","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"Quick start"),l.a.createElement("p",null,"You can copy the example directory to start your development quickly. Remember to register your hook in ",l.a.createElement("code",null,"index.ts")," under src directory."),l.a.createElement("h2",{id:"\ud83e\udd21-demo--doc"},l.a.createElement(i["AnchorLink"],{to:"#\ud83e\udd21-demo--doc","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\ud83e\udd21 Demo & Doc"),l.a.createElement("ol",null,l.a.createElement("li",null,"Write demo in the demo directory of your component."),l.a.createElement("li",null,"Write docs in index.zh-CN.md for Chinese and index.en-US.md for English."),l.a.createElement("li",null,"Embed your demo in your docs via ",l.a.createElement("code",null,"code")," tag, like this:")),l.a.createElement(c["a"],{code:'<code src="./demo/basicScroll.tsx" />\n',lang:"ts"}),l.a.createElement("p",null,"You can import many demos for different usage."),l.a.createElement("ol",{start:4},l.a.createElement("li",null,"Build docs with command ",l.a.createElement("code",null,"yarn build:doc"),", the docs generated will de deployed in static Github Pages after your code be pushed to master.")),l.a.createElement("h2",{id:"-discuss"},l.a.createElement(i["AnchorLink"],{to:"#-discuss","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\ud83d\udc65 Discuss"),l.a.createElement("p",null,"Welcome to issues: ",l.a.createElement(i["Link"],{to:"https://github.com/xylink-com/xy-hooks/issues"},"Push issues")),l.a.createElement("h2",{id:"-license"},l.a.createElement(i["AnchorLink"],{to:"#-license","aria-hidden":"true",tabIndex:-1},l.a.createElement("span",{className:["icon","icon-link"]})),"\u2705 License"),l.a.createElement("p",null,l.a.createElement(i["Link"],{to:"https://github.com/xylink-com/xy-hooks/blob/master/LICENSE"},"MIT"))))}}}]);