index.d.ts 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. import { Ref, ToRefs } from "vue";
  2. import { Middleware, Placement, SideObject, Strategy, VirtualElement } from "@floating-ui/dom";
  3. //#region ../../packages/hooks/use-floating/index.d.ts
  4. declare const useFloatingProps: {};
  5. type UseFloatingProps = ToRefs<{
  6. middleware: Array<Middleware>;
  7. placement: Placement;
  8. strategy: Strategy;
  9. }>;
  10. declare const getPositionDataWithUnit: <T extends Record<string, number>>(record: T | undefined, key: keyof T) => string;
  11. declare const useFloating: ({
  12. middleware,
  13. placement,
  14. strategy
  15. }: UseFloatingProps) => {
  16. update: () => Promise<void>;
  17. referenceRef: Ref<HTMLElement | VirtualElement | undefined>;
  18. contentRef: Ref<HTMLElement | undefined>;
  19. x: Ref<number | undefined>;
  20. y: Ref<number | undefined>;
  21. placement: Ref<Placement>;
  22. strategy: Ref<Strategy>;
  23. middlewareData: Ref<{
  24. [x: string]: any;
  25. arrow?: {
  26. x?: number | undefined;
  27. y?: number | undefined;
  28. centerOffset: number;
  29. alignmentOffset?: number | undefined;
  30. } | undefined;
  31. autoPlacement?: {
  32. index?: number | undefined;
  33. overflows: {
  34. placement: Placement;
  35. overflows: Array<number>;
  36. }[];
  37. } | undefined;
  38. flip?: {
  39. index?: number | undefined;
  40. overflows: {
  41. placement: Placement;
  42. overflows: Array<number>;
  43. }[];
  44. } | undefined;
  45. hide?: {
  46. referenceHidden?: boolean | undefined;
  47. escaped?: boolean | undefined;
  48. referenceHiddenOffsets?: {
  49. top: number;
  50. bottom: number;
  51. left: number;
  52. right: number;
  53. } | undefined;
  54. escapedOffsets?: {
  55. top: number;
  56. bottom: number;
  57. left: number;
  58. right: number;
  59. } | undefined;
  60. } | undefined;
  61. offset?: {
  62. x: number;
  63. y: number;
  64. placement: Placement;
  65. } | undefined;
  66. shift?: {
  67. x: number;
  68. y: number;
  69. enabled: {
  70. x: boolean;
  71. y: boolean;
  72. };
  73. } | undefined;
  74. }>;
  75. };
  76. type ArrowMiddlewareProps = {
  77. arrowRef: Ref<HTMLElement | null | undefined>;
  78. padding?: number | SideObject;
  79. };
  80. declare const arrowMiddleware: ({
  81. arrowRef,
  82. padding
  83. }: ArrowMiddlewareProps) => Middleware;
  84. //#endregion
  85. export { ArrowMiddlewareProps, UseFloatingProps, arrowMiddleware, getPositionDataWithUnit, useFloating, useFloatingProps };