trigger.d.ts 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. import { Measurable } from "./constants.js";
  2. import { _default } from "./trigger.vue.js";
  3. import * as vue from "vue";
  4. //#region ../../packages/components/popper/src/trigger.d.ts
  5. interface PopperTriggerProps {
  6. /** @description Indicates the reference element to which the popper is attached */
  7. virtualRef?: Measurable;
  8. /** @description Indicates whether virtual triggering is enabled */
  9. virtualTriggering?: boolean;
  10. onMouseenter?: (e: MouseEvent) => void;
  11. onMouseleave?: (e: MouseEvent) => void;
  12. onClick?: (e: PointerEvent) => void;
  13. onKeydown?: (e: KeyboardEvent) => void;
  14. onFocus?: (e: FocusEvent) => void;
  15. onBlur?: (e: FocusEvent) => void;
  16. onContextmenu?: (e: PointerEvent) => void;
  17. id?: string;
  18. open?: boolean;
  19. }
  20. /**
  21. * @deprecated Removed after 3.0.0, Use `PopperTriggerProps` instead.
  22. */
  23. declare const popperTriggerProps: {
  24. readonly virtualRef: {
  25. readonly type: vue.PropType<Measurable>;
  26. readonly required: false;
  27. readonly validator: ((val: unknown) => boolean) | undefined;
  28. __epPropKey: true;
  29. };
  30. readonly virtualTriggering: BooleanConstructor;
  31. readonly onMouseenter: {
  32. readonly type: vue.PropType<(e: MouseEvent) => void>;
  33. readonly required: false;
  34. readonly validator: ((val: unknown) => boolean) | undefined;
  35. __epPropKey: true;
  36. };
  37. readonly onMouseleave: {
  38. readonly type: vue.PropType<(e: MouseEvent) => void>;
  39. readonly required: false;
  40. readonly validator: ((val: unknown) => boolean) | undefined;
  41. __epPropKey: true;
  42. };
  43. readonly onClick: {
  44. readonly type: vue.PropType<(e: PointerEvent) => void>;
  45. readonly required: false;
  46. readonly validator: ((val: unknown) => boolean) | undefined;
  47. __epPropKey: true;
  48. };
  49. readonly onKeydown: {
  50. readonly type: vue.PropType<(e: KeyboardEvent) => void>;
  51. readonly required: false;
  52. readonly validator: ((val: unknown) => boolean) | undefined;
  53. __epPropKey: true;
  54. };
  55. readonly onFocus: {
  56. readonly type: vue.PropType<(e: FocusEvent) => void>;
  57. readonly required: false;
  58. readonly validator: ((val: unknown) => boolean) | undefined;
  59. __epPropKey: true;
  60. };
  61. readonly onBlur: {
  62. readonly type: vue.PropType<(e: FocusEvent) => void>;
  63. readonly required: false;
  64. readonly validator: ((val: unknown) => boolean) | undefined;
  65. __epPropKey: true;
  66. };
  67. readonly onContextmenu: {
  68. readonly type: vue.PropType<(e: PointerEvent) => void>;
  69. readonly required: false;
  70. readonly validator: ((val: unknown) => boolean) | undefined;
  71. __epPropKey: true;
  72. };
  73. readonly id: StringConstructor;
  74. readonly open: BooleanConstructor;
  75. };
  76. type PopperTriggerInstance = InstanceType<typeof _default> & unknown;
  77. /** @deprecated use `popperTriggerProps` instead, and it will be deprecated in the next major version */
  78. declare const usePopperTriggerProps: {
  79. readonly virtualRef: {
  80. readonly type: vue.PropType<Measurable>;
  81. readonly required: false;
  82. readonly validator: ((val: unknown) => boolean) | undefined;
  83. __epPropKey: true;
  84. };
  85. readonly virtualTriggering: BooleanConstructor;
  86. readonly onMouseenter: {
  87. readonly type: vue.PropType<(e: MouseEvent) => void>;
  88. readonly required: false;
  89. readonly validator: ((val: unknown) => boolean) | undefined;
  90. __epPropKey: true;
  91. };
  92. readonly onMouseleave: {
  93. readonly type: vue.PropType<(e: MouseEvent) => void>;
  94. readonly required: false;
  95. readonly validator: ((val: unknown) => boolean) | undefined;
  96. __epPropKey: true;
  97. };
  98. readonly onClick: {
  99. readonly type: vue.PropType<(e: PointerEvent) => void>;
  100. readonly required: false;
  101. readonly validator: ((val: unknown) => boolean) | undefined;
  102. __epPropKey: true;
  103. };
  104. readonly onKeydown: {
  105. readonly type: vue.PropType<(e: KeyboardEvent) => void>;
  106. readonly required: false;
  107. readonly validator: ((val: unknown) => boolean) | undefined;
  108. __epPropKey: true;
  109. };
  110. readonly onFocus: {
  111. readonly type: vue.PropType<(e: FocusEvent) => void>;
  112. readonly required: false;
  113. readonly validator: ((val: unknown) => boolean) | undefined;
  114. __epPropKey: true;
  115. };
  116. readonly onBlur: {
  117. readonly type: vue.PropType<(e: FocusEvent) => void>;
  118. readonly required: false;
  119. readonly validator: ((val: unknown) => boolean) | undefined;
  120. __epPropKey: true;
  121. };
  122. readonly onContextmenu: {
  123. readonly type: vue.PropType<(e: PointerEvent) => void>;
  124. readonly required: false;
  125. readonly validator: ((val: unknown) => boolean) | undefined;
  126. __epPropKey: true;
  127. };
  128. readonly id: StringConstructor;
  129. readonly open: BooleanConstructor;
  130. };
  131. /** @deprecated use `PopperTriggerInstance` instead, and it will be deprecated in the next major version */
  132. type ElPopperArrowTrigger = PopperTriggerInstance;
  133. //#endregion
  134. export { ElPopperArrowTrigger, PopperTriggerInstance, PopperTriggerProps, popperTriggerProps, usePopperTriggerProps };