发送验证码

策略类型

use hook

在使用扩展 hooks 前，确保你已熟悉了 alova 的基本使用。

验证码发送 hook，减掉你在开发验证码发送功能时的繁琐。

特性

• 验证码发送后自动开始倒计时；
• 自定义倒计时秒数；
• 验证码发送限制；

使用

基本使用

展示表单 hook 的基本使用。

vue

<template>
  <input v-model="mobile" />
  <button
    @click="sendCaptcha"
    :loading="sending"
    :disabled="sending || countdown > 0">
    {{ loading ? '发送中...' : countdown > 0 ? `${countdown}后可重发` : '发送验证码' }}
  </button>
</template>

<script setup>
  import { ref } from 'vue';
  import { apiSendCaptcha } from './api.js';
  import { useCaptcha } from 'alova/client';

  const mobile = ref('');
  const {
    // 发送状态
    loading: sending,

    // 倒计时
    countdown,

    // 调用sendCaptcha才会请求接口发送验证码
    send: sendCaptcha
  } = useCaptcha(() => apiSendCaptcha(mobile.value));
</script>

react

import { useState } from 'react';
import { apiSendCaptcha } from './api.js';
import { useCaptcha } from 'alova/clientct';

const App = () => {
  const [mobile, setMobile] = useState('');
  const {
    // 发送状态
    loading: sending,

    // 倒计时
    countdown,

    // 调用sendCaptcha才会请求接口发送验证码
    send: sendCaptcha
  } = useCaptcha(() => apiSendCaptcha(mobile));

  return (
    <div>
      <input
        value={mobile}
        onChange={({ target }) => setMobile(target.value)}
      />
      <button
        onClick={sendCaptcha}
        loading={sending}
        disabled={sending || countdown > 0}>
        {loading ? '发送中...' : countdown > 0 ? `${countdown}后可重发` : '发送验证码'}
      </button>
    </div>
  );
};

svelte

<script>
  import { apiSendCaptcha } from './api.js';
  import { useCaptcha } from 'alova/client';

  let mobile = '';
  const {
    // 发送状态
    loading: sending,

    // 倒计时
    countdown,

    // 调用sendCaptcha才会请求接口发送验证码
    send: sendCaptcha
  } = useCaptcha(() => apiSendCaptcha(mobile));
</script>

<input bind:value="{mobile}" />
<button
  on:click="{sendCaptcha}"
  loading="{$sending}"
  disabled="{$sending || $countdown > 0}">
  { $loading ? '发送中...' : $countdown > 0 ? `${$countdown}后可重发` : '发送验证码' }
</button>

solid

import { apiSendCaptcha } from './api.js';
import { useCaptcha } from 'alova/clientct';
import { createSignal } from 'solid-js';

const App = () => {
  const [mobile, setMobile] = createSignal('');
  const {
    // 发送状态
    loading: sending,

    // 倒计时
    countdown,

    // 调用sendCaptcha才会请求接口发送验证码
    send: sendCaptcha
  } = useCaptcha(() => apiSendCaptcha(mobile()));

  return (
    <div>
      <input
        value={mobile()}
        onChange={({ target }) => setMobile(target.value)}
      />
      <button
        onClick={sendCaptcha}
        loading={sending()}
        disabled={sending() || countdown() > 0}>
        {loading ? '发送中...' : countdown() > 0 ? `${countdown()}后可重发` : '发送验证码'}
      </button>
    </div>
  );
};

默认情况下，验证码发送成功后将会倒计时 60 秒，当倒计时没有结束时再调用send将会抛出错误。

自定义倒计时秒数

你也可以自定义倒计时秒数

useCaptcha(() => apiSendCaptcha(mobile.value), {
  // ...
  // 将倒计时设为20秒
  initialCountdown: 20
});

API

Hook 配置

继承useRequest除immediate外的所有配置，useCaptcha中immediate已硬编码为 false。

名称	描述	类型	默认值	版本
initialCountdown	初始倒计时，当验证码发送成功时将会以此数据来开始倒计时	number	60	-

响应式数据

继承useRequest所有响应式数据。

名称	描述	类型	版本
countdown	当前倒计时，每秒-1，当倒计时结束后才可以再次发送验证码	number	-

操作函数

继承useRequest所有操作函数。

名称	描述	函数参数	返回值	版本
send	发送请求，当倒计时未结束时调用将抛出错误	与 useRequest.send 一致	Promise<Response>	-

事件

继承useRequest所有事件。