@zag-js/tooltip 0.1.10 → 0.1.13

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Chakra UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,3 +1,93 @@
-export { connect } from "./tooltip.connect";
-export { machine } from "./tooltip.machine";
-export type { UserDefinedContext as Context } from "./tooltip.types";
+import { RequiredBy, CommonProperties, RootProperties, PropTypes, NormalizeProps } from '@zag-js/types';
+import * as _zag_js_core from '@zag-js/core';
+import { StateMachine } from '@zag-js/core';
+import { PositioningOptions } from '@zag-js/popper';
+
+declare type ElementIds = Partial<{
+    trigger: string;
+    content: string;
+}>;
+declare type PublicContext = CommonProperties & {
+    /**
+     * The ids of the elements in the tooltip. Useful for composition.
+     */
+    ids?: ElementIds;
+    /**
+     * The `id` of the tooltip.
+     */
+    id: string;
+    /**
+     * The open delay of the tooltip.
+     */
+    openDelay: number;
+    /**
+     * The close delay of the tooltip.
+     */
+    closeDelay: number;
+    /**
+     * Whether to close the tooltip on pointerdown.
+     */
+    closeOnPointerDown: boolean;
+    /**
+     * Whether to close the tooltip when the Escape key is pressed.
+     */
+    closeOnEsc?: boolean;
+    /**
+     * Whether the tooltip's content is interactive.
+     * In this mode, the tooltip will remain open when user hovers over the content.
+     * @see https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus
+     */
+    interactive: boolean;
+    /**
+     * Function called when the tooltip is opened.
+     */
+    onOpen?: VoidFunction;
+    /**
+     * Function called when the tooltip is closed.
+     */
+    onClose?: VoidFunction;
+    /**
+     * Custom label for the tooltip.
+     */
+    "aria-label"?: string;
+    /**
+     * The user provided options used to position the popover content
+     */
+    positioning: PositioningOptions;
+};
+declare type UserDefinedContext = RequiredBy<PublicContext, "id">;
+declare type ComputedContext = Readonly<{
+    /**
+     * @computed Whether an `aria-label` is set.
+     */
+    readonly hasAriaLabel: boolean;
+}>;
+declare type PrivateContext = RootProperties & {};
+declare type MachineContext = PublicContext & ComputedContext & PrivateContext;
+declare type MachineState = {
+    value: "unknown" | "opening" | "open" | "closing" | "closed";
+    tags: "open" | "closed";
+};
+declare type State = StateMachine.State<MachineContext, MachineState>;
+declare type Send = StateMachine.Send<StateMachine.AnyEventObject>;
+
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): {
+    isOpen: boolean;
+    open(): void;
+    close(): void;
+    getAnimationState(): {
+        enter: boolean;
+        exit: boolean;
+    };
+    triggerProps: T["button"];
+    arrowProps: T["element"];
+    innerArrowProps: T["element"];
+    positionerProps: T["element"];
+    contentProps: T["element"];
+    labelProps: T["element"];
+    createPortal(): HTMLElement;
+};
+
+declare function machine(ctx: UserDefinedContext): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
+
+export { UserDefinedContext as Context, connect, machine };