README

@livelybone/use-count-down

pkg.module supported, which means that you can apply tree-shaking in you project

中文文档

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

Your can see the usage by run the example of the module, here is the step:

Clone the library git clone https://github.com/livelybone/use-count-down.git
Go to the directory cd your-module-directory
Install npm dependencies npm i(use taobao registry: npm i --registry=http://registry.npm.taobao.org)
Open service npm run dev
See the example(usually is http://127.0.0.1/examples/test.html) in your browser

Installation

npm i -S @livelybone/use-count-down

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

useCountDown

Interface

See what method or params you can use in index.d.ts

Usage

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>
  )
}

Use in html, see what your can use in CDN: unpkg

<-- use what you want -->
<script src="https://unpkg.com/@livelybone/use-count-down/lib/umd/<--module-->.js"></script>

Usage no npm install needed!