props.d.ts 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. import { IBaseProps } from '../_util/base';
  2. /**
  3. * @description 按钮,用户只需单击一下即可执行操作并做出选择。
  4. * 常用于表单提交、界面跳转、模块引导点击。具体用法和小程序框架中 button 保持一致,在 button 基础上做了样式的封装。
  5. * 封装后的按钮可改变按钮形态、增加 loading,以及内置了几种不同样式的按钮。
  6. */
  7. export interface IButtonProps extends IBaseProps {
  8. /**
  9. * @description 按钮类型
  10. * @default default
  11. */
  12. type?: 'default' | 'primary' | 'text';
  13. /**
  14. * @description 是否禁用
  15. * @default false
  16. */
  17. disabled?: boolean;
  18. /**
  19. * @description 按下时的类名
  20. */
  21. activeClassName?: string;
  22. /**
  23. * @description 辅助文字,显示在第二行
  24. */
  25. subText?: string;
  26. /**
  27. * @description 内联,不撑满父级宽度
  28. * @default false
  29. */
  30. inline?: boolean;
  31. /**
  32. * @description 内联尺寸
  33. * @default medium
  34. */
  35. size?: 'small' | 'medium' | 'large';
  36. /**
  37. * @description 按钮左侧图标
  38. */
  39. icon?: string;
  40. /**
  41. * @description 是否加载中,加载中时不可点击
  42. * @default false
  43. */
  44. loading?: boolean;
  45. /**
  46. * @description 是否为危险按钮,危险按钮的颜色会变成红色
  47. * @default false
  48. */
  49. danger?: boolean;
  50. /**
  51. * @description 按钮原生类型,在表单提交时有效
  52. * @default button
  53. */
  54. formType?: 'button' | 'submit' | 'reset';
  55. /**
  56. * @description 点击回调
  57. */
  58. onTap?: (event: any) => void;
  59. /**
  60. * @description 点击回调
  61. */
  62. catchTap?: (event: any) => void;
  63. /**
  64. * @description 生活号 id,必须是当前小程序同主体且已关联的生活号,open-type="lifestyle" 时有效。
  65. */
  66. publicId?: string;
  67. /**
  68. * @description 开放能力。
  69. */
  70. openType?: string;
  71. /**
  72. * @description 当 openType 为 getAuthorize 时有效。
  73. */
  74. scope?: string;
  75. onGetAuthorize?: (event: any) => void;
  76. onFollowLifestyle?: (event: any) => void;
  77. onError?: (event: any) => void;
  78. onGetUserInfo?: (event: any) => void;
  79. onGetPhoneNumber?: (event: any) => void;
  80. }
  81. export declare const ButtonDefaultProps: Partial<IButtonProps>;