@quartzds/core 1.0.0-beta.1

package/dist/types/components/tooltip/tooltip.d.ts

@@ -0,0 +1,147 @@
+import type { AutoUpdateOptions, DetectOverflowOptions, FlipOptions, Placement, ReferenceElement, ShiftOptions, Strategy } from '@floating-ui/dom';
+import type { ComponentInterface } from '../../stencil-public-runtime';
+import type { OffsetOptions } from '../../helpers';
+/**
+ * @experimental
+ * @slot Content to display in the dropdown.
+ * @see https://quartz.se.com/build/components/tooltip
+ */
+export declare class Tooltip implements ComponentInterface {
+  /**
+   * Options to pass to Floating UI's
+   * [`autoUpdate()` function](https://floating-ui.com/docs/autoUpdate).
+   *
+   * @see https://floating-ui.com/docs/autoupdate#options
+   */
+  readonly autoUpdateOptions?: AutoUpdateOptions;
+  /**
+   * Prevents the tooltip from being shown by user interaction. The tooltip can
+   * still be displayed by calling the `show()` method.
+   */
+  disabled: boolean;
+  /**
+   * Options to pass to Floating UI's
+   * [`flip` middleware](https://floating-ui.com/docs/flip).
+   *
+   * The [`crossAxis` option](https://floating-ui.com/docs/flip#crossaxis) is
+   * set to the value of the `noShift` property by default for interoperability
+   * with the [`shift` middleware](https://floating-ui.com/docs/shift).
+   *
+   * @see https://floating-ui.com/docs/flip#options
+   */
+  readonly flipOptions?: Partial<DetectOverflowOptions & FlipOptions>;
+  /**
+   * Disable Floating UI's
+   * [`flip` middleware](https://floating-ui.com/docs/flip).
+   */
+  readonly noFlip: boolean;
+  /**
+   * Disable Floating UI's
+   * [`shift` middleware](https://floating-ui.com/docs/shift).
+   */
+  readonly noShift: boolean;
+  /**
+   * Options to pass to Floating UI's
+   * [`offset` middleware](https://floating-ui.com/docs/offset).
+   *
+   * The [`mainAxis` option](https://floating-ui.com/docs/offset#mainaxis) is
+   * not supported.
+   *
+   * @see https://floating-ui.com/docs/offset#options
+   */
+  readonly offsetOptions?: OffsetOptions;
+  /**
+   * Where to place the tooltip relative to the `target`.
+   *
+   * @see https://floating-ui.com/docs/tutorial#placements
+   */
+  readonly placement: Placement;
+  /**
+   * Options to pass to Floating UI's
+   * [`shift` middleware](https://floating-ui.com/docs/shift).
+   *
+   * @see https://floating-ui.com/docs/shift#options
+   */
+  readonly shiftOptions?: Partial<DetectOverflowOptions & ShiftOptions>;
+  /**
+   * The CSS position strategy to use.
+   *
+   * @see https://floating-ui.com/docs/computeposition#strategy
+   */
+  readonly strategy?: Strategy;
+  /**
+   * The trigger element that will trigger the tooltip. The target specified
+   * can be any of the follow:
+   *
+   * - A CSS selector string
+   * - A reference to an
+   * [`Element`](https://developer.mozilla.org/docs/Web/API/Element) or
+   * [Virtual Element](https://floating-ui.com/docs/virtual-elements)
+   * - A function returning a reference to an
+   * [`Element`](https://developer.mozilla.org/docs/Web/API/Element),
+   * [Virtual Element](https://floating-ui.com/docs/virtual-elements),
+   * or a CSS selector string
+   */
+  readonly target: ReferenceElement | string | (() => ReferenceElement | string);
+  /**
+   * Emitted when the tooltip is closed.
+   */
+  private readonly closeEmitter;
+  private readonly element;
+  private hostPosition?;
+  private hostTransform?;
+  private open;
+  private middleware?;
+  private aDisplay?;
+  private side;
+  private aShape;
+  private aViewbox;
+  private aHeight;
+  private aWidth;
+  private aGap;
+  private aX;
+  private aY;
+  private arrowContainerElement?;
+  private cleanup?;
+  private clickedTooltip;
+  private isTouchDevice;
+  private referenceElement?;
+  /**
+   * Show the tooltip.
+   */
+  show(): Promise<void>;
+  /**
+   * Close the tooltip.
+   */
+  close(): Promise<void>;
+  /**
+   * Update the tooltip's arrow.
+   *
+   * This method should typically be called when the Quartz platform was
+   * changed.
+   */
+  updateArrow(): Promise<void>;
+  protected handleMouseDown(event: MouseEvent): Promise<void>;
+  protected updateMiddleware(): Promise<void>;
+  private updateReferenceElement;
+  private updatePosition;
+  private startAutoUpdate;
+  componentWillLoad(): Promise<void>;
+  componentDidLoad(): Promise<void>;
+  disconnectedCallback(): void;
+  render(): any;
+  private readonly arrowContainerRef;
+  private readonly boundTooltipMouseDown;
+  private handleFocus;
+  private readonly boundFocus;
+  private handleMouseEnter;
+  private readonly boundMouseEnter;
+  private handleMouseLeave;
+  private readonly boundMouseLeave;
+  private handleFocusOut;
+  private readonly boundFocusout;
+  private handleReferenceClick;
+  private readonly boundReferenceClick;
+  private disconnectReferenceElement;
+}
+//# sourceMappingURL=tooltip.d.ts.map