@vingy/vueltip 2.1.0 → 2.2.0

package/dist/index.d.mts

@@ -1,332 +0,0 @@
-import * as vue from "vue";
-import { App, Component, Directive, DirectiveBinding, ShallowRef, StyleValue } from "vue";
-
-//#region src/basicTooltip.component.d.ts
-declare const BasicTooltip: vue.DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, vue.PublicProps>;
-//#endregion
-//#region ../../node_modules/.pnpm/@floating-ui+utils@0.2.10/node_modules/@floating-ui/utils/dist/floating-ui.utils.d.mts
-declare type AlignedPlacement = `${Side}-${Alignment}`;
-declare type Alignment = 'start' | 'end';
-declare type Axis = 'x' | 'y';
-declare type ClientRectObject = Prettify$1<Rect & SideObject>;
-declare type Coords = { [key in Axis]: number };
-declare type Dimensions = { [key in Length]: number };
-declare interface ElementRects {
-  reference: Rect;
-  floating: Rect;
-}
-declare type Length = 'width' | 'height';
-declare type Padding = number | Prettify$1<Partial<SideObject>>;
-declare type Placement = Prettify$1<Side | AlignedPlacement>;
-declare type Prettify$1<T> = { [K in keyof T]: T[K] } & {};
-declare type Rect = Prettify$1<Coords & Dimensions>;
-declare type Side = 'top' | 'right' | 'bottom' | 'left';
-declare type SideObject = { [key in Side]: number };
-declare type Strategy = 'absolute' | 'fixed';
-//#endregion
-//#region ../../node_modules/.pnpm/@floating-ui+core@1.7.4/node_modules/@floating-ui/core/dist/floating-ui.core.d.mts
-declare type Boundary = any;
-/**
- * Function option to derive middleware options from state.
- */
-declare type Derivable<T> = (state: MiddlewareState$1) => T;
-/**
- * Resolves with an object of overflow side offsets that determine how much the
- * element is overflowing a given clipping boundary on each side.
- * - positive = overflowing the boundary by that number of pixels
- * - negative = how many pixels left before it will overflow
- * - 0 = lies flush with the boundary
- * @see https://floating-ui.com/docs/detectOverflow
- */
-declare function detectOverflow(state: MiddlewareState$1, options?: DetectOverflowOptions | Derivable<DetectOverflowOptions>): Promise<SideObject>;
-declare interface DetectOverflowOptions {
-  /**
-   * The clipping element(s) or area in which overflow will be checked.
-   * @default 'clippingAncestors'
-   */
-  boundary?: Boundary;
-  /**
-   * The root clipping area in which overflow will be checked.
-   * @default 'viewport'
-   */
-  rootBoundary?: RootBoundary;
-  /**
-   * The element in which overflow is being checked relative to a boundary.
-   * @default 'floating'
-   */
-  elementContext?: ElementContext;
-  /**
-   * Whether to check for overflow using the alternate element's boundary
-   * (`clippingAncestors` boundary only).
-   * @default false
-   */
-  altBoundary?: boolean;
-  /**
-   * Virtual padding for the resolved overflow detection offsets.
-   * @default 0
-   */
-  padding?: Padding;
-}
-declare type ElementContext = 'reference' | 'floating';
-declare interface Elements$1 {
-  reference: ReferenceElement$1;
-  floating: FloatingElement$1;
-}
-declare type FloatingElement$1 = any;
-declare type Middleware$1 = {
-  name: string;
-  options?: any;
-  fn: (state: MiddlewareState$1) => Promisable$1<MiddlewareReturn>;
-};
-declare interface MiddlewareData {
-  [key: string]: any;
-  arrow?: Partial<Coords> & {
-    centerOffset: number;
-    alignmentOffset?: number;
-  };
-  autoPlacement?: {
-    index?: number;
-    overflows: Array<{
-      placement: Placement;
-      overflows: Array<number>;
-    }>;
-  };
-  flip?: {
-    index?: number;
-    overflows: Array<{
-      placement: Placement;
-      overflows: Array<number>;
-    }>;
-  };
-  hide?: {
-    referenceHidden?: boolean;
-    escaped?: boolean;
-    referenceHiddenOffsets?: SideObject;
-    escapedOffsets?: SideObject;
-  };
-  offset?: Coords & {
-    placement: Placement;
-  };
-  shift?: Coords & {
-    enabled: { [key in Axis]: boolean };
-  };
-}
-declare interface MiddlewareReturn extends Partial<Coords> {
-  data?: {
-    [key: string]: any;
-  };
-  reset?: boolean | {
-    placement?: Placement;
-    rects?: boolean | ElementRects;
-  };
-}
-declare interface MiddlewareState$1 extends Coords {
-  initialPlacement: Placement;
-  placement: Placement;
-  strategy: Strategy;
-  middlewareData: MiddlewareData;
-  elements: Elements$1;
-  rects: ElementRects;
-  platform: {
-    detectOverflow: typeof detectOverflow;
-  } & Platform;
-}
-/**
- * Platform interface methods to work with the current platform.
- * @see https://floating-ui.com/docs/platform
- */
-declare interface Platform {
-  getElementRects: (args: {
-    reference: ReferenceElement$1;
-    floating: FloatingElement$1;
-    strategy: Strategy;
-  }) => Promisable$1<ElementRects>;
-  getClippingRect: (args: {
-    element: any;
-    boundary: Boundary;
-    rootBoundary: RootBoundary;
-    strategy: Strategy;
-  }) => Promisable$1<Rect>;
-  getDimensions: (element: any) => Promisable$1<Dimensions>;
-  convertOffsetParentRelativeRectToViewportRelativeRect?: (args: {
-    elements?: Elements$1;
-    rect: Rect;
-    offsetParent: any;
-    strategy: Strategy;
-  }) => Promisable$1<Rect>;
-  getOffsetParent?: (element: any) => Promisable$1<any>;
-  isElement?: (value: any) => Promisable$1<boolean>;
-  getDocumentElement?: (element: any) => Promisable$1<any>;
-  getClientRects?: (element: any) => Promisable$1<Array<ClientRectObject>>;
-  isRTL?: (element: any) => Promisable$1<boolean>;
-  getScale?: (element: any) => Promisable$1<{
-    x: number;
-    y: number;
-  }>;
-  detectOverflow?: typeof detectOverflow;
-}
-declare type Promisable$1<T> = T | Promise<T>;
-declare type ReferenceElement$1 = any;
-declare type RootBoundary = 'viewport' | 'document' | Rect;
-//#endregion
-//#region ../../node_modules/.pnpm/@floating-ui+dom@1.7.5/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.mts
-declare interface Elements {
-  reference: ReferenceElement;
-  floating: FloatingElement;
-}
-declare type FloatingElement = HTMLElement;
-declare type Middleware = Prettify<Omit<Middleware$1, 'fn'> & {
-  fn(state: MiddlewareState): Promisable<MiddlewareReturn>;
-}>;
-declare type MiddlewareState = Prettify<Omit<MiddlewareState$1, 'elements'> & {
-  elements: Elements;
-}>;
-declare type Prettify<T> = { [K in keyof T]: T[K] } & {};
-declare type Promisable<T> = T | Promise<T>;
-declare type ReferenceElement = Element | VirtualElement;
-/**
- * Custom positioning reference element.
- * @see https://floating-ui.com/docs/virtual-elements
- */
-declare interface VirtualElement {
-  getBoundingClientRect(): ClientRectObject;
-  getClientRects?(): Array<ClientRectObject> | DOMRectList;
-  contextElement?: Element;
-}
-declare namespace index_d_exports {
-  export { V as Vue, Vue2, del, install, isVue2, isVue3, set };
-}
-import * as import_vue from "vue";
-declare const isVue2: boolean;
-declare const isVue3: boolean;
-declare const Vue2: any;
-declare const install: (vue?: any) => void;
-/** 
- * @deprecated To avoid bringing in all the tree-shakable modules, this API has been deprecated. Use `Vue2` or named exports instead.
- * Refer to https://github.com/vueuse/vue-demi/issues/41
- */
-declare const V: typeof vue;
-declare function set<T>(target: any, key: any, val: T): T;
-declare function del(target: any, key: any): void;
-//#endregion
-//#region ../../node_modules/.pnpm/@floating-ui+vue@1.1.10_vue@3.5.28_typescript@5.9.3_/node_modules/@floating-ui/vue/dist/floating-ui.vue.d.mts
-declare type MaybeReadonlyRef<T> = T | Readonly<index_d_exports.Ref<T>>;
-declare type MaybeReadonlyRefOrGetter<T> = MaybeReadonlyRef<T> | (() => T);
-declare type UseFloatingOptions<T extends ReferenceElement = ReferenceElement> = {
-  /**
-   * Represents the open/close state of the floating element.
-   * @default true
-   */
-  open?: MaybeReadonlyRefOrGetter<boolean | undefined>;
-  /**
-   * Where to place the floating element relative to its reference element.
-   * @default 'bottom'
-   */
-  placement?: MaybeReadonlyRefOrGetter<Placement | undefined>;
-  /**
-   * The type of CSS position property to use.
-   * @default 'absolute'
-   */
-  strategy?: MaybeReadonlyRefOrGetter<Strategy | undefined>;
-  /**
-   * These are plain objects that modify the positioning coordinates in some fashion, or provide useful data for the consumer to use.
-   * @default undefined
-   */
-  middleware?: MaybeReadonlyRefOrGetter<Middleware[] | undefined>;
-  /**
-   * Whether to use `transform` instead of `top` and `left` styles to
-   * position the floating element (`floatingStyles`).
-   * @default true
-   */
-  transform?: MaybeReadonlyRefOrGetter<boolean | undefined>;
-  /**
-   * Callback to handle mounting/unmounting of the elements.
-   * @default undefined
-   */
-  whileElementsMounted?: (reference: T, floating: FloatingElement, update: () => void) => () => void;
-};
-//#endregion
-//#region ../shared/dist/types.d.mts
-//#region src/types.d.ts
-type Maybe<T> = T | null | undefined; //#endregion
-//#endregion
-//#region src/types.d.ts
-interface CustomVueltipData {}
-interface Content {
-  text: Maybe<string>;
-  custom?: CustomVueltipData;
-}
-type Value = Maybe<string> | (Content & {
-  placement?: Placement;
-});
-type Modifier = 'x' | 'y' | 'none' | 'both';
-type TooltipDirective = Directive<HTMLElement, Value, Modifier, Placement>;
-type Options = {
-  /** @default 'data-vueltip-placement' */placementAttribute: string; /** @default 'data-vueltip-key' */
-  keyAttribute: string; /** @default 'data-vueltip-truncate' */
-  truncateAttribute: string; /** @default 0 */
-  showDelay: number; /** @default 200 */
-  hideDelay: number; /** @default false */
-  handleDialogModals: boolean; /** @default 'both' */
-  defaultTruncateDetection: Modifier; /** @default 'top' */
-  defaultPlacement: Placement;
-};
-type UseTooltipOptions = {
-  tooltipElement: Readonly<ShallowRef<HTMLElement | null>>;
-  arrowElement?: Readonly<ShallowRef<HTMLElement | null>>;
-  offset?: number;
-  padding?: number;
-  arrowSize?: number;
-  floatingOptions?: UseFloatingOptions<HTMLElement>;
-};
-declare module 'vue' {
-  interface GlobalDirectives {
-    vTooltip: TooltipDirective;
-  }
-}
-//#endregion
-//#region src/composables.d.ts
-declare const useVueltip: ({
-  tooltipElement,
-  arrowElement,
-  offset: _offset,
-  padding,
-  arrowSize,
-  floatingOptions
-}: UseTooltipOptions) => {
-  tooltipStyles: Readonly<vue.Ref<{
-    position: Strategy;
-    top: string;
-    left: string;
-    transform?: string;
-    willChange?: string;
-  }, {
-    position: Strategy;
-    top: string;
-    left: string;
-    transform?: string;
-    willChange?: string;
-  }>>;
-  arrowStyles: vue.ComputedRef<StyleValue>;
-  show: vue.ComputedRef<boolean>;
-  content: vue.Ref<Maybe<Content>, Maybe<Content>>;
-};
-//#endregion
-//#region src/directive.d.ts
-declare const vueltipDirective: {
-  updated: (el: HTMLElement, binding: DirectiveBinding<Value, Modifier, Placement>) => void;
-  created: (el: HTMLElement, binding: DirectiveBinding<Value, Modifier, Placement>) => void;
-  beforeUnmount: (el: HTMLElement) => void;
-};
-//#endregion
-//#region src/options.d.ts
-declare const setOptions: (opts?: Partial<Options>) => void;
-//#endregion
-//#region src/plugin.d.ts
-declare const vueltipPlugin: {
-  install: (app: App, options: Partial<Options & {
-    component: Component;
-  }>) => void;
-};
-//#endregion
-export { BasicTooltip, type Content, type CustomVueltipData, setOptions, useVueltip, vueltipDirective, vueltipPlugin };