index.d.ts 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. import * as vue from "vue";
  2. import { Ref } from "vue";
  3. import * as _popperjs_core0 from "@popperjs/core";
  4. import { Instance, Modifier, Options, State, VirtualElement } from "@popperjs/core";
  5. //#region ../../packages/hooks/use-popper/index.d.ts
  6. type ElementType = HTMLElement | undefined;
  7. type ReferenceElement = ElementType | VirtualElement;
  8. type PartialOptions = Partial<Options>;
  9. declare const usePopper: (referenceElementRef: Ref<ReferenceElement>, popperElementRef: Ref<ElementType>, opts?: Ref<PartialOptions> | PartialOptions) => {
  10. state: vue.ComputedRef<{
  11. elements?: {
  12. reference: Element | VirtualElement;
  13. popper: HTMLElement;
  14. arrow?: HTMLElement;
  15. } | undefined;
  16. options?: _popperjs_core0.OptionsGeneric<any> | undefined;
  17. placement?: _popperjs_core0.Placement | undefined;
  18. strategy?: _popperjs_core0.PositioningStrategy | undefined;
  19. orderedModifiers?: Modifier<any, any>[] | undefined;
  20. rects?: _popperjs_core0.StateRects | undefined;
  21. scrollParents?: {
  22. reference: Array<Element | _popperjs_core0.Window | _popperjs_core0.VisualViewport>;
  23. popper: Array<Element | _popperjs_core0.Window | _popperjs_core0.VisualViewport>;
  24. } | undefined;
  25. styles?: {
  26. [key: string]: Partial<CSSStyleDeclaration>;
  27. } | undefined;
  28. attributes?: {
  29. [key: string]: {
  30. [key: string]: string | boolean;
  31. };
  32. } | undefined;
  33. modifiersData?: {
  34. [key: string]: any;
  35. arrow?: {
  36. x?: number;
  37. y?: number;
  38. centerOffset: number;
  39. };
  40. hide?: {
  41. isReferenceHidden: boolean;
  42. hasPopperEscaped: boolean;
  43. referenceClippingOffsets: _popperjs_core0.SideObject;
  44. popperEscapeOffsets: _popperjs_core0.SideObject;
  45. };
  46. offset?: {
  47. top?: _popperjs_core0.Offsets | undefined;
  48. auto?: _popperjs_core0.Offsets | undefined;
  49. bottom?: _popperjs_core0.Offsets | undefined;
  50. "bottom-start"?: _popperjs_core0.Offsets | undefined;
  51. left?: _popperjs_core0.Offsets | undefined;
  52. right?: _popperjs_core0.Offsets | undefined;
  53. "auto-start"?: _popperjs_core0.Offsets | undefined;
  54. "auto-end"?: _popperjs_core0.Offsets | undefined;
  55. "top-start"?: _popperjs_core0.Offsets | undefined;
  56. "top-end"?: _popperjs_core0.Offsets | undefined;
  57. "bottom-end"?: _popperjs_core0.Offsets | undefined;
  58. "right-start"?: _popperjs_core0.Offsets | undefined;
  59. "right-end"?: _popperjs_core0.Offsets | undefined;
  60. "left-start"?: _popperjs_core0.Offsets | undefined;
  61. "left-end"?: _popperjs_core0.Offsets | undefined;
  62. };
  63. preventOverflow?: _popperjs_core0.Offsets;
  64. popperOffsets?: _popperjs_core0.Offsets;
  65. } | undefined;
  66. reset?: boolean | undefined;
  67. }>;
  68. styles: vue.ComputedRef<{
  69. [key: string]: Partial<CSSStyleDeclaration>;
  70. }>;
  71. attributes: vue.ComputedRef<{
  72. [key: string]: {
  73. [key: string]: string | boolean;
  74. };
  75. }>;
  76. update: () => Promise<Partial<State>> | undefined;
  77. forceUpdate: () => void | undefined;
  78. instanceRef: vue.ComputedRef<Instance | undefined>;
  79. };
  80. type UsePopperReturn = ReturnType<typeof usePopper>;
  81. //#endregion
  82. export { PartialOptions, UsePopperReturn, usePopper };