props.d.ts 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. import { IBaseProps } from '../_util/base';
  2. /**
  3. * @description 徽标,红点、数字或文字。用于告诉用户待处理的事物或更新数。
  4. */
  5. export interface IBadgeProps extends IBaseProps {
  6. /**
  7. * @description badge 类型
  8. * @default dot
  9. */
  10. type: 'dot' | 'number' | 'text' | 'bubble';
  11. /**
  12. * @description 红点内容,为空时表示只显示红点;可以是数字,也可以是文字;如果是数字,超过 99 会自动变成 ...
  13. */
  14. text: string | number;
  15. /**
  16. * @description 相对于 children 所在访问,left-top(左上角) top-right(右上角)
  17. * @default "top-right"
  18. */
  19. position: 'top-left' | 'top-center' | 'top-right' | 'left' | 'right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
  20. /**
  21. * @description 水平方向偏移量(字符串类型,需要带上像素单位)
  22. * @default "-50%"
  23. */
  24. offsetX: string;
  25. /**
  26. * @description 垂直方向偏移量(字符串类型,需要带上像素单位)
  27. * @default "-50%"
  28. */
  29. offsetY: number | string;
  30. /**
  31. * @description 是否有描边
  32. * @default false
  33. */
  34. stroke: boolean;
  35. /**
  36. * @description 背景色
  37. */
  38. bgColor: string;
  39. }
  40. export declare const BadgeDefaultProps: Partial<IBadgeProps>;
  41. export declare const BadgeFunctionalProps: Partial<IBadgeProps>;