0.0.2 • Published 4 years ago

use-verify-code v0.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

react-useVerifyCode-hook

Language David GitHub package.json version

适用于验证码场景的 React Hooks.
React Hooks For Verify Code Sending & Status Controll

Usage

npm install use-verify-code -S
// or
yarn add use-verify-code

Plz use CodeSandBox Demo for praticing.

import React from 'react';
import useVerifyCode from './hooks/useVC';

export default function App() {
  const { current, setTarget, status } = useVerifyCode(3, { interval: 1000 });

  return (
    <>
      <button
        onClick={() => {
          setTarget();
        }}
        disabled={status}
      >
        {status ? `Send Again In ${current} s` : 'Send Verify Code'}
      </button>
    </>
  );
}
  • use status to toggle component status(verify code button usually).
  • use setTarget to begin interval.
  • use current to track current count.

Interface

export interface Opts {
  interval?: number; // interval time gap
}

type TUseVerifyCode = (
  start?: number, // time that [disable status] persist, default to be 60
  options?: Opts
) => {
  count: number; // current count status
  setTarget: (end?: number) => void; // invoke interval and set target, defalut to 0
  status: boolean; // interval status
};