All files / src/types button.ts

100% Statements 1/1
100% Branches 0/0
100% Functions 0/0
100% Lines 1/1

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119  1x                                                                                                                                                                                                                                          
import type { MiniprogramCustomEvent } from './mp'
 
/**
 * 微信开放能力的类型
 *
 * @export
 */
export type NativeButtonOpenType = 'contact' | 'liveActivity' | 'share' | 'getPhoneNumber' |
  'getRealtimePhoneNumber' | 'getUserInfo' | 'launchApp' | 'openSetting' | 'feedback' |
  'chooseAvatar' | 'agreePrivacyAuthorization'
 
/**
 * 原生按钮组件的类型
 *
 * @export
 * @interface NativeButtonProps
 */
export interface NativeButtonProps {
  /** 按钮的大小 */
  size?: 'default' | 'mini'
  /** 按钮的样式类型 */
  type?: 'default' | 'primary' | 'warn'
  /** 按钮是否镂空,背景色透明 */
  plain?: boolean
  /** 是否禁用 */
  disabled?: boolean
  /** 名称前是否带 loading 图标 */
  loading?: boolean
  /** 用于 form 组件,点击分别会触发 form 组件的 submit/reset 事件 */
  formType?: 'submit' | 'reset'
  /** 微信开放能力 */
  openType?: NativeButtonOpenType
  /** 指定按钮按下去的样式类。当 hover-class="none" 时,没有点击态效果 */
  hoverClass?: string
  /** 指定是否阻止本节点的祖先节点出现点击态 */
  hoverStopPropagation?: boolean
  /** 按住后多久出现点击态,单位毫秒 */
  hoverStartTime?: number
  /** 手指松开后点击态保留时间,单位毫秒 */
  hoverStayTime?: number
  /** 指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文 */
  lang?: 'en' | 'zh_CN' | 'zh_TW'
  /** 会话来源,open-type="contact"时有效 */
  sessionFrom?: string
  /** 会话内消息卡片标题,open-type="contact"时有效 */
  sendMessageTitle?: string
  /** 会话内消息卡片点击跳转小程序路径,open-type="contact"时有效 */
  sendMessagePath?: string
  /** 会话内消息卡片图片,open-type="contact"时有效 */
  sendMessageImg?: string
  /** 打开 APP 时,向 APP 传递的参数,open-type=launchApp时有效 */
  appParameter?: string
  /** 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息,open-type="contact"时有效 */
  showMessageCard?: boolean
  /** 当手机号快速验证或手机号实时验证额度用尽时,是否对用户展示“申请获取你的手机号,但该功能使用次数已达当前小程序上限,暂时无法使用”的提示,默认展示,open-type="getPhoneNumber" 或 open-type="getRealtimePhoneNumber" 时有效 */
  phoneNumberNoQuotaToast?: boolean
}
 
/**
 * 按钮的事件
 */
export type NativeButtonEvent = 'click' | 'getuserinfo' | 'contact' | 'createliveactivity' |
  'getphonenumber' | 'getrealtimephonenumber' | 'error' | 'opensetting' | 'launchapp' |
  'chooseavatar' | 'agreeprivacyauthorization'
 
/**
 * 默认事件的类型
 *
 * @export
 */
export type DefaultButtonHandle<
  Button = NativeButtonProps,
  Detail = MiniprogramCustomEvent['detail'],
  Method = NativeButtonEvent
> = (
  event: {
    /** 触发事件的方法 */
    method?: Method
    /** 按钮组件 */
    button?: Button,
    /** 索引值 */
    index?: number,
    /** 回调的 detail 数据 */
    detail?: Detail
  }
) => void | Promise<void>
 
/**
 * 原生按钮组件的事件类型
 *
 * @export
 * @interface NativeButtonHandle
 * @template Button
 */
export interface NativeButtonHandle<Button = NativeButtonProps> {
  /** 点击事件 */
  onClick?: DefaultButtonHandle<Button>
  /** 获取用户信息回调 */
  onGetUserInfo?: DefaultButtonHandle<Button>
  /** 客服消息回调 */
  onContact?: DefaultButtonHandle<Button>
  /** 获取用户手机号回调 */
  onGetPhoneNumber?: DefaultButtonHandle<Button>
  /** 打开 APP 成功的回调 */
  onLaunchApp?: DefaultButtonHandle<Button>
  /** 当使用开放能力时,发生错误的回调 */
  onError?: DefaultButtonHandle<Button>
  /** 在打开授权设置页后回调 */
  onOpenSetting?: DefaultButtonHandle<Button>
  /** 获取用户头像回调 */
  onChooseAvatar?: DefaultButtonHandle<Button>
  /** 新的一次性订阅消息下发机制回调 */
  onCreateLiveActivity?: DefaultButtonHandle<Button>
  /** 手机号实时验证回调 */
  onGetRealtimePhoneNumber?: DefaultButtonHandle<Button>
  /** 用户同意隐私协议事件回调 */
  onAgreePrivacyAuthorization?: DefaultButtonHandle<Button>
}