backtop.d.ts 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. import { ExtractPublicPropTypes } from "vue";
  2. //#region ../../packages/components/backtop/src/backtop.d.ts
  3. interface BacktopProps {
  4. /**
  5. * @description the button will not show until the scroll height reaches this value.
  6. */
  7. visibilityHeight?: number;
  8. /**
  9. * @description the target to trigger scroll.
  10. */
  11. target?: string;
  12. /**
  13. * @description right distance.
  14. */
  15. right?: number;
  16. /**
  17. * @description bottom distance.
  18. */
  19. bottom?: number;
  20. }
  21. /**
  22. * @deprecated Removed after 3.0.0, Use `BacktopProps` instead.
  23. */
  24. declare const backtopProps: {
  25. /**
  26. * @description the button will not show until the scroll height reaches this value.
  27. */
  28. readonly visibilityHeight: {
  29. readonly type: NumberConstructor;
  30. readonly default: 200;
  31. };
  32. /**
  33. * @description the target to trigger scroll.
  34. */
  35. readonly target: {
  36. readonly type: StringConstructor;
  37. readonly default: "";
  38. };
  39. /**
  40. * @description right distance.
  41. */
  42. readonly right: {
  43. readonly type: NumberConstructor;
  44. readonly default: 40;
  45. };
  46. /**
  47. * @description bottom distance.
  48. */
  49. readonly bottom: {
  50. readonly type: NumberConstructor;
  51. readonly default: 40;
  52. };
  53. };
  54. /**
  55. * @deprecated Removed after 3.0.0, Use `BacktopProps` instead.
  56. */
  57. type BacktopPropsPublic = ExtractPublicPropTypes<typeof backtopProps>;
  58. declare const backtopEmits: {
  59. click: (evt: MouseEvent) => boolean;
  60. };
  61. type BacktopEmits = typeof backtopEmits;
  62. //#endregion
  63. export { BacktopEmits, BacktopProps, BacktopPropsPublic, backtopEmits, backtopProps };