@livelybone/use-count-down/README-CN.md

A react hook for seconds count down

# @livelybone/use-count-down
[![NPM Version](http://img.shields.io/npm/v/@livelybone/use-count-down.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/use-count-down)
[![Download Month](http://img.shields.io/npm/dm/@livelybone/use-count-down.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/use-count-down)
![gzip with dependencies: 0.6kb](https://img.shields.io/badge/gzip--with--dependencies-0.6kb-brightgreen.svg "gzip with dependencies: 0.6kb")
![typescript](https://img.shields.io/badge/typescript-supported-blue.svg "typescript")
![pkg.module](https://img.shields.io/badge/pkg.module-supported-blue.svg "pkg.module")

> `pkg.module supported`, 天然支持 tree-shaking, 使用 es module 引用即可

[English Document](./README.md)

A react hook for seconds count down

## repository
https://github.com/livelybone/use-count-down.git

## Demo
https://github.com/livelybone/use-count-down#readme

## Run Example
你可以通过运行项目的 example 来了解这个组件的使用，以下是启动步骤：

1. 克隆项目到本地 `git clone https://github.com/livelybone/form.git`
2. 进入本地克隆目录 `cd your-module-directory`
3. 安装项目依赖 `npm i`(使用 taobao 源: `npm i --registry=http://registry.npm.taobao.org`)
4. 启动服务 `npm run dev`
5. 在你的浏览器看 example (地址通常是 `http://127.0.0.1:3000/examples/test.html`)

## Installation
```bash
npm i -S @livelybone/use-count-down
```

## Global name - The variable the module exported in `umd` bundle
`useCountDown`

## Interface
去 [index.d.ts](./index.d.ts) 查看可用方法和参数

## Usage
```typescript jsx
import React from 'react'
import useCountDown from '@livelybone/use-count-down'

const Comp = () => {
  const {count, isRunning, start, stop} = useCountDown(60)
  
  return (
    <div>
      {isRunning ? `${count}s` : 'click the right button the start'}
      <button onClick={start}>start</button>
      <button onClick={stop}>stop</button>
    </div>
  )
}
```


在 HTML 文件中直接引用，你可以在 [CDN: unpkg](https://unpkg.com/@livelybone/form/lib/umd/) 看到你能用到的所有 js 脚本
```html
<-- 然后使用你需要的 -->
<script src="https://unpkg.com/@livelybone/form/lib/umd/<--module-->.js"></script>
```