props.d.ts 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. import { IBaseProps } from '../_util/base';
  2. /**
  3. * @description 通告栏,
  4. * 当应用有重要公告或者由于用户的刷新操作产生提示反馈时可以使用通告栏系统。
  5. * 通告栏不会对用户浏览当前页面内容产生影响,但又能明显的引起用户的注意。公告内容不超过一行。
  6. */
  7. export interface INoticeBarProps extends IBaseProps {
  8. /**
  9. * @description 消息的展示
  10. */
  11. icon?: string;
  12. /**
  13. * @description 提示类型
  14. * default 橙色,error 红色,primary 蓝色,info 灰色
  15. * @default "default"
  16. */
  17. type?: 'default' | 'error' | 'primary' | 'info';
  18. /**
  19. * @description 通告类型,link 表示连接,整行可点;closeable 表示点击 x 可以关闭;不填时表示你右侧没有图标
  20. */
  21. mode?: 'link' | 'closeable';
  22. /**
  23. * @description 是否开启滚动动画
  24. * @default false
  25. */
  26. enableMarquee: boolean;
  27. /**
  28. * @description 是否循环滚动,enableMarquee 为 true 时有效
  29. * @default false
  30. */
  31. loop: boolean;
  32. /**
  33. * @description 微信版本需要通过此字段启用 icon 位置的插槽
  34. * @default false
  35. */
  36. slotIcon?: boolean;
  37. /**
  38. * @description 点击图标(箭头或者叉,由mode属性决定)的事件回调
  39. */
  40. onTap: () => void;
  41. /**
  42. * @description 行动点点击回调
  43. * @param 当前点击的行动点序号
  44. */
  45. onActionTap: (index: number) => void;
  46. }
  47. export declare const NoticeBarDefaultProps: Partial<INoticeBarProps>;