content.d.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. import { EpPropFinalized, EpPropMergeType } from "../../../utils/vue/props/types.js";
  2. import { PopperEffect } from "../../popper/src/popper.js";
  3. import { PopperContentProps } from "../../popper/src/content.js";
  4. import { Options, Placement } from "../../popper/index.js";
  5. import _default from "./content.vue.js";
  6. import { UseDelayedToggleProps } from "../../../hooks/use-delayed-toggle/index.js";
  7. import { AriaProps } from "../../../hooks/use-aria/index.js";
  8. import * as _$vue from "vue";
  9. import { ExtractPublicPropTypes } from "vue";
  10. //#region ../../packages/components/tooltip/src/content.d.ts
  11. interface ElTooltipContentProps extends UseDelayedToggleProps, Omit<PopperContentProps, 'visible'> {
  12. /**
  13. * @description which element the tooltip CONTENT appends to
  14. */
  15. appendTo?: string | HTMLElement;
  16. /**
  17. * @description display content, can be overridden by `slot#content`
  18. */
  19. content?: string;
  20. /**
  21. * @description whether `content` is treated as HTML string
  22. */
  23. rawContent?: boolean;
  24. /**
  25. * @description when tooltip inactive and `persistent` is `false` , popconfirm will be destroyed
  26. */
  27. persistent?: boolean;
  28. /**
  29. * @description visibility of Tooltip
  30. */
  31. visible?: boolean | null;
  32. /**
  33. * @description animation name
  34. */
  35. transition?: string;
  36. /**
  37. * @description whether tooltip content is teleported, if `true` it will be teleported to where `append-to` sets
  38. */
  39. teleported?: boolean;
  40. /**
  41. * @description whether Tooltip is disabled
  42. */
  43. disabled?: boolean;
  44. ariaLabel?: AriaProps['ariaLabel'];
  45. }
  46. declare const useTooltipContentPropsDefaults: {
  47. readonly content: "";
  48. readonly visible: null;
  49. readonly teleported: true;
  50. readonly effect: "dark";
  51. readonly enterable: true;
  52. readonly stopPopperMouseEvent: true;
  53. readonly pure: false;
  54. readonly focusOnShow: false;
  55. readonly trapping: false;
  56. readonly virtualTriggering: false;
  57. readonly loop: false;
  58. readonly style: undefined;
  59. readonly popperStyle: undefined;
  60. readonly arrowOffset: 5;
  61. readonly boundariesPadding: 0;
  62. readonly gpuAcceleration: true;
  63. readonly offset: 12;
  64. readonly placement: "bottom";
  65. readonly popperOptions: () => {};
  66. readonly strategy: "absolute";
  67. readonly showAfter: 0;
  68. readonly hideAfter: 200;
  69. readonly autoClose: 0;
  70. };
  71. /**
  72. * @deprecated Removed after 3.0.0, Use `ElTooltipContentProps` instead.
  73. */
  74. declare const useTooltipContentProps: {
  75. readonly ariaLabel: StringConstructor;
  76. readonly appendTo: {
  77. readonly type: _$vue.PropType<EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement) | (((new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement)) | null)[], unknown, unknown>>;
  78. readonly required: false;
  79. readonly validator: ((val: unknown) => boolean) | undefined;
  80. __epPropKey: true;
  81. };
  82. readonly content: EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
  83. readonly rawContent: BooleanConstructor;
  84. readonly persistent: BooleanConstructor;
  85. readonly visible: EpPropFinalized<(new (...args: any[]) => boolean) | (() => boolean | null) | (((new (...args: any[]) => boolean) | (() => boolean | null)) | null)[], unknown, unknown, null, boolean>;
  86. readonly transition: StringConstructor;
  87. readonly teleported: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  88. readonly disabled: BooleanConstructor;
  89. readonly loop: BooleanConstructor;
  90. readonly id: StringConstructor;
  91. readonly style: EpPropFinalized<(new (...args: any[]) => string | false | _$vue.CSSProperties | _$vue.StyleValue[]) | (() => _$vue.StyleValue) | (((new (...args: any[]) => string | false | _$vue.CSSProperties | _$vue.StyleValue[]) | (() => _$vue.StyleValue)) | null)[], unknown, unknown, undefined, boolean>;
  92. readonly className: {
  93. readonly type: _$vue.PropType<EpPropMergeType<(new (...args: any[]) => string | {
  94. [x: string]: boolean;
  95. } | (string | {
  96. [x: string]: boolean;
  97. } | (string | {
  98. [x: string]: boolean;
  99. } | (string | {
  100. [x: string]: boolean;
  101. } | (string | {
  102. [x: string]: boolean;
  103. } | (string | {
  104. [x: string]: boolean;
  105. } | (string | {
  106. [x: string]: boolean;
  107. } | (string | {
  108. [x: string]: boolean;
  109. } | (string | {
  110. [x: string]: boolean;
  111. } | (string | {
  112. [x: string]: boolean;
  113. } | (string | {
  114. [x: string]: boolean;
  115. } | (string | {
  116. [x: string]: boolean;
  117. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  118. [x: string]: boolean;
  119. } | (string | {
  120. [x: string]: boolean;
  121. } | (string | {
  122. [x: string]: boolean;
  123. } | (string | {
  124. [x: string]: boolean;
  125. } | (string | {
  126. [x: string]: boolean;
  127. } | (string | {
  128. [x: string]: boolean;
  129. } | (string | {
  130. [x: string]: boolean;
  131. } | (string | {
  132. [x: string]: boolean;
  133. } | (string | {
  134. [x: string]: boolean;
  135. } | (string | {
  136. [x: string]: boolean;
  137. } | (string | {
  138. [x: string]: boolean;
  139. } | (string | {
  140. [x: string]: boolean;
  141. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (((new (...args: any[]) => string | {
  142. [x: string]: boolean;
  143. } | (string | {
  144. [x: string]: boolean;
  145. } | (string | {
  146. [x: string]: boolean;
  147. } | (string | {
  148. [x: string]: boolean;
  149. } | (string | {
  150. [x: string]: boolean;
  151. } | (string | {
  152. [x: string]: boolean;
  153. } | (string | {
  154. [x: string]: boolean;
  155. } | (string | {
  156. [x: string]: boolean;
  157. } | (string | {
  158. [x: string]: boolean;
  159. } | (string | {
  160. [x: string]: boolean;
  161. } | (string | {
  162. [x: string]: boolean;
  163. } | (string | {
  164. [x: string]: boolean;
  165. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  166. [x: string]: boolean;
  167. } | (string | {
  168. [x: string]: boolean;
  169. } | (string | {
  170. [x: string]: boolean;
  171. } | (string | {
  172. [x: string]: boolean;
  173. } | (string | {
  174. [x: string]: boolean;
  175. } | (string | {
  176. [x: string]: boolean;
  177. } | (string | {
  178. [x: string]: boolean;
  179. } | (string | {
  180. [x: string]: boolean;
  181. } | (string | {
  182. [x: string]: boolean;
  183. } | (string | {
  184. [x: string]: boolean;
  185. } | (string | {
  186. [x: string]: boolean;
  187. } | (string | {
  188. [x: string]: boolean;
  189. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[])) | null)[], unknown, unknown>>;
  190. readonly required: false;
  191. readonly validator: ((val: unknown) => boolean) | undefined;
  192. __epPropKey: true;
  193. };
  194. readonly effect: EpPropFinalized<(new (...args: any[]) => string) | (() => PopperEffect) | (((new (...args: any[]) => string) | (() => PopperEffect)) | null)[], unknown, unknown, "dark", boolean>;
  195. readonly enterable: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  196. readonly pure: BooleanConstructor;
  197. readonly focusOnShow: BooleanConstructor;
  198. readonly trapping: BooleanConstructor;
  199. readonly popperClass: {
  200. readonly type: _$vue.PropType<EpPropMergeType<(new (...args: any[]) => string | {
  201. [x: string]: boolean;
  202. } | (string | {
  203. [x: string]: boolean;
  204. } | (string | {
  205. [x: string]: boolean;
  206. } | (string | {
  207. [x: string]: boolean;
  208. } | (string | {
  209. [x: string]: boolean;
  210. } | (string | {
  211. [x: string]: boolean;
  212. } | (string | {
  213. [x: string]: boolean;
  214. } | (string | {
  215. [x: string]: boolean;
  216. } | (string | {
  217. [x: string]: boolean;
  218. } | (string | {
  219. [x: string]: boolean;
  220. } | (string | {
  221. [x: string]: boolean;
  222. } | (string | {
  223. [x: string]: boolean;
  224. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  225. [x: string]: boolean;
  226. } | (string | {
  227. [x: string]: boolean;
  228. } | (string | {
  229. [x: string]: boolean;
  230. } | (string | {
  231. [x: string]: boolean;
  232. } | (string | {
  233. [x: string]: boolean;
  234. } | (string | {
  235. [x: string]: boolean;
  236. } | (string | {
  237. [x: string]: boolean;
  238. } | (string | {
  239. [x: string]: boolean;
  240. } | (string | {
  241. [x: string]: boolean;
  242. } | (string | {
  243. [x: string]: boolean;
  244. } | (string | {
  245. [x: string]: boolean;
  246. } | (string | {
  247. [x: string]: boolean;
  248. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (((new (...args: any[]) => string | {
  249. [x: string]: boolean;
  250. } | (string | {
  251. [x: string]: boolean;
  252. } | (string | {
  253. [x: string]: boolean;
  254. } | (string | {
  255. [x: string]: boolean;
  256. } | (string | {
  257. [x: string]: boolean;
  258. } | (string | {
  259. [x: string]: boolean;
  260. } | (string | {
  261. [x: string]: boolean;
  262. } | (string | {
  263. [x: string]: boolean;
  264. } | (string | {
  265. [x: string]: boolean;
  266. } | (string | {
  267. [x: string]: boolean;
  268. } | (string | {
  269. [x: string]: boolean;
  270. } | (string | {
  271. [x: string]: boolean;
  272. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
  273. [x: string]: boolean;
  274. } | (string | {
  275. [x: string]: boolean;
  276. } | (string | {
  277. [x: string]: boolean;
  278. } | (string | {
  279. [x: string]: boolean;
  280. } | (string | {
  281. [x: string]: boolean;
  282. } | (string | {
  283. [x: string]: boolean;
  284. } | (string | {
  285. [x: string]: boolean;
  286. } | (string | {
  287. [x: string]: boolean;
  288. } | (string | {
  289. [x: string]: boolean;
  290. } | (string | {
  291. [x: string]: boolean;
  292. } | (string | {
  293. [x: string]: boolean;
  294. } | (string | {
  295. [x: string]: boolean;
  296. } | /*elided*/any)[])[])[])[])[])[])[])[])[])[])[])) | null)[], unknown, unknown>>;
  297. readonly required: false;
  298. readonly validator: ((val: unknown) => boolean) | undefined;
  299. __epPropKey: true;
  300. };
  301. readonly popperStyle: EpPropFinalized<(new (...args: any[]) => string | false | _$vue.CSSProperties | _$vue.StyleValue[]) | (() => _$vue.StyleValue) | (((new (...args: any[]) => string | false | _$vue.CSSProperties | _$vue.StyleValue[]) | (() => _$vue.StyleValue)) | null)[], unknown, unknown, undefined, boolean>;
  302. readonly referenceEl: {
  303. readonly type: _$vue.PropType<HTMLElement>;
  304. readonly required: false;
  305. readonly validator: ((val: unknown) => boolean) | undefined;
  306. __epPropKey: true;
  307. };
  308. readonly triggerTargetEl: {
  309. readonly type: _$vue.PropType<HTMLElement>;
  310. readonly required: false;
  311. readonly validator: ((val: unknown) => boolean) | undefined;
  312. __epPropKey: true;
  313. };
  314. readonly stopPopperMouseEvent: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  315. readonly virtualTriggering: BooleanConstructor;
  316. readonly zIndex: NumberConstructor;
  317. readonly arrowOffset: EpPropFinalized<NumberConstructor, unknown, unknown, 5, boolean>;
  318. readonly boundariesPadding: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  319. readonly fallbackPlacements: EpPropFinalized<(new (...args: any[]) => Placement[]) | (() => Placement[]) | (((new (...args: any[]) => Placement[]) | (() => Placement[])) | null)[], unknown, unknown, undefined, boolean>;
  320. readonly gpuAcceleration: EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
  321. readonly offset: EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
  322. readonly placement: EpPropFinalized<StringConstructor, Placement, unknown, "bottom", boolean>;
  323. readonly popperOptions: EpPropFinalized<(new (...args: any[]) => Partial<Options>) | (() => Partial<Options>) | (((new (...args: any[]) => Partial<Options>) | (() => Partial<Options>)) | null)[], unknown, unknown, () => {}, boolean>;
  324. readonly strategy: EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
  325. readonly showAfter: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  326. readonly hideAfter: EpPropFinalized<NumberConstructor, unknown, unknown, 200, boolean>;
  327. readonly autoClose: EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
  328. };
  329. /**
  330. * @deprecated Removed after 3.0.0, Use `ElTooltipContentProps` instead.
  331. */
  332. type ElTooltipContentPropsPublic = ExtractPublicPropTypes<typeof useTooltipContentProps>;
  333. type TooltipContentInstance = InstanceType<typeof _default> & unknown;
  334. //#endregion
  335. export { ElTooltipContentProps, ElTooltipContentPropsPublic, TooltipContentInstance, useTooltipContentProps, useTooltipContentPropsDefaults };