content.d.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. import type { PopperEffect } from './popper';
  2. import type { ExtractPropTypes, StyleValue } from 'vue';
  3. import type { Options, Placement } from '@popperjs/core';
  4. import type { Measurable } from './constants';
  5. import type Content from './content.vue';
  6. type ClassObjectType = Record<string, boolean>;
  7. type ClassType = string | ClassObjectType | ClassType[];
  8. export interface CreatePopperInstanceParams {
  9. referenceEl: Measurable;
  10. popperContentEl: HTMLElement;
  11. arrowEl: HTMLElement | undefined;
  12. }
  13. export declare const popperCoreConfigProps: {
  14. readonly boundariesPadding: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  15. readonly fallbackPlacements: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Placement[]) | (() => Placement[]) | ((new (...args: any[]) => Placement[]) | (() => Placement[]))[], unknown, unknown, undefined, boolean>;
  16. readonly gpuAcceleration: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  17. readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  18. readonly placement: import("element-plus/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
  19. readonly popperOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
  20. readonly strategy: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
  21. };
  22. export type PopperCoreConfigProps = ExtractPropTypes<typeof popperCoreConfigProps>;
  23. export declare const popperContentProps: {
  24. readonly ariaLabel: StringConstructor;
  25. readonly id: StringConstructor;
  26. readonly style: {
  27. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue) | ((new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue))[], unknown, unknown>>;
  28. readonly required: false;
  29. readonly validator: ((val: unknown) => boolean) | undefined;
  30. __epPropKey: true;
  31. };
  32. readonly className: {
  33. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType) | ((new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType))[], unknown, unknown>>;
  34. readonly required: false;
  35. readonly validator: ((val: unknown) => boolean) | undefined;
  36. __epPropKey: true;
  37. };
  38. readonly effect: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => string) | (() => PopperEffect) | ((new (...args: any[]) => string) | (() => PopperEffect))[], unknown, unknown, "dark", boolean>;
  39. readonly visible: BooleanConstructor;
  40. readonly enterable: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  41. readonly pure: BooleanConstructor;
  42. readonly focusOnShow: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
  43. readonly trapping: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
  44. readonly popperClass: {
  45. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType) | ((new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType))[], unknown, unknown>>;
  46. readonly required: false;
  47. readonly validator: ((val: unknown) => boolean) | undefined;
  48. __epPropKey: true;
  49. };
  50. readonly popperStyle: {
  51. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue) | ((new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue))[], unknown, unknown>>;
  52. readonly required: false;
  53. readonly validator: ((val: unknown) => boolean) | undefined;
  54. __epPropKey: true;
  55. };
  56. readonly referenceEl: {
  57. readonly type: import("vue").PropType<HTMLElement>;
  58. readonly required: false;
  59. readonly validator: ((val: unknown) => boolean) | undefined;
  60. __epPropKey: true;
  61. };
  62. readonly triggerTargetEl: {
  63. readonly type: import("vue").PropType<HTMLElement>;
  64. readonly required: false;
  65. readonly validator: ((val: unknown) => boolean) | undefined;
  66. __epPropKey: true;
  67. };
  68. readonly stopPopperMouseEvent: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  69. readonly virtualTriggering: BooleanConstructor;
  70. readonly zIndex: NumberConstructor;
  71. readonly arrowOffset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 5, boolean>;
  72. readonly boundariesPadding: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  73. readonly fallbackPlacements: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Placement[]) | (() => Placement[]) | ((new (...args: any[]) => Placement[]) | (() => Placement[]))[], unknown, unknown, undefined, boolean>;
  74. readonly gpuAcceleration: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  75. readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  76. readonly placement: import("element-plus/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
  77. readonly popperOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
  78. readonly strategy: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
  79. };
  80. export type PopperContentProps = ExtractPropTypes<typeof popperContentProps>;
  81. export declare const popperContentEmits: {
  82. mouseenter: (evt: MouseEvent) => boolean;
  83. mouseleave: (evt: MouseEvent) => boolean;
  84. focus: () => boolean;
  85. blur: () => boolean;
  86. close: () => boolean;
  87. };
  88. export type PopperContentEmits = typeof popperContentEmits;
  89. export type PopperContentInstance = InstanceType<typeof Content> & unknown;
  90. /** @deprecated use `popperCoreConfigProps` instead, and it will be deprecated in the next major version */
  91. export declare const usePopperCoreConfigProps: {
  92. readonly boundariesPadding: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  93. readonly fallbackPlacements: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Placement[]) | (() => Placement[]) | ((new (...args: any[]) => Placement[]) | (() => Placement[]))[], unknown, unknown, undefined, boolean>;
  94. readonly gpuAcceleration: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  95. readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  96. readonly placement: import("element-plus/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
  97. readonly popperOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
  98. readonly strategy: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
  99. };
  100. /** @deprecated use `popperContentProps` instead, and it will be deprecated in the next major version */
  101. export declare const usePopperContentProps: {
  102. readonly ariaLabel: StringConstructor;
  103. readonly id: StringConstructor;
  104. readonly style: {
  105. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue) | ((new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue))[], unknown, unknown>>;
  106. readonly required: false;
  107. readonly validator: ((val: unknown) => boolean) | undefined;
  108. __epPropKey: true;
  109. };
  110. readonly className: {
  111. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType) | ((new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType))[], unknown, unknown>>;
  112. readonly required: false;
  113. readonly validator: ((val: unknown) => boolean) | undefined;
  114. __epPropKey: true;
  115. };
  116. readonly effect: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => string) | (() => PopperEffect) | ((new (...args: any[]) => string) | (() => PopperEffect))[], unknown, unknown, "dark", boolean>;
  117. readonly visible: BooleanConstructor;
  118. readonly enterable: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  119. readonly pure: BooleanConstructor;
  120. readonly focusOnShow: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
  121. readonly trapping: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
  122. readonly popperClass: {
  123. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType) | ((new (...args: any[]) => string | ClassObjectType | ClassType[]) | (() => ClassType))[], unknown, unknown>>;
  124. readonly required: false;
  125. readonly validator: ((val: unknown) => boolean) | undefined;
  126. __epPropKey: true;
  127. };
  128. readonly popperStyle: {
  129. readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue) | ((new (...args: any[]) => string | import("vue").CSSProperties | StyleValue[]) | (() => StyleValue))[], unknown, unknown>>;
  130. readonly required: false;
  131. readonly validator: ((val: unknown) => boolean) | undefined;
  132. __epPropKey: true;
  133. };
  134. readonly referenceEl: {
  135. readonly type: import("vue").PropType<HTMLElement>;
  136. readonly required: false;
  137. readonly validator: ((val: unknown) => boolean) | undefined;
  138. __epPropKey: true;
  139. };
  140. readonly triggerTargetEl: {
  141. readonly type: import("vue").PropType<HTMLElement>;
  142. readonly required: false;
  143. readonly validator: ((val: unknown) => boolean) | undefined;
  144. __epPropKey: true;
  145. };
  146. readonly stopPopperMouseEvent: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  147. readonly virtualTriggering: BooleanConstructor;
  148. readonly zIndex: NumberConstructor;
  149. readonly arrowOffset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 5, boolean>;
  150. readonly boundariesPadding: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  151. readonly fallbackPlacements: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Placement[]) | (() => Placement[]) | ((new (...args: any[]) => Placement[]) | (() => Placement[]))[], unknown, unknown, undefined, boolean>;
  152. readonly gpuAcceleration: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  153. readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  154. readonly placement: import("element-plus/es/utils").EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
  155. readonly popperOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | ((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>))[], unknown, unknown, () => {}, boolean>;
  156. readonly strategy: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
  157. };
  158. /** @deprecated use `popperContentEmits` instead, and it will be deprecated in the next major version */
  159. export declare const usePopperContentEmits: {
  160. mouseenter: (evt: MouseEvent) => boolean;
  161. mouseleave: (evt: MouseEvent) => boolean;
  162. focus: () => boolean;
  163. blur: () => boolean;
  164. close: () => boolean;
  165. };
  166. /** @deprecated use `PopperCoreConfigProps` instead, and it will be deprecated in the next major version */
  167. export type UsePopperCoreConfigProps = PopperCoreConfigProps;
  168. /** @deprecated use `PopperContentProps` instead, and it will be deprecated in the next major version */
  169. export type UsePopperContentProps = PopperContentProps;
  170. /** @deprecated use `PopperContentInstance` instead, and it will be deprecated in the next major version */
  171. export type ElPopperArrowContent = PopperContentInstance;
  172. export {};