@zag-js/popover 0.1.9 → 0.1.12

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,103 @@
-export { connect } from "./popover.connect";
-export { machine } from "./popover.machine";
-export type { UserDefinedContext as Context } from "./popover.types";
+import { RequiredBy, CommonProperties, MaybeElement, Context, PropTypes, NormalizeProps } from '@zag-js/types';
+import * as _zag_js_core from '@zag-js/core';
+import { StateMachine } from '@zag-js/core';
+import { DismissableElementHandlers } from '@zag-js/dismissable';
+import { PositioningOptions } from '@zag-js/popper';
+
+declare type ElementIds = Partial<{
+    anchor: string;
+    trigger: string;
+    content: string;
+    title: string;
+    description: string;
+    closeBtn: string;
+}>;
+declare type PublicContext = DismissableElementHandlers & CommonProperties & {
+    /**
+     * The ids of the elements in the popover. Useful for composition.
+     */
+    ids?: ElementIds;
+    /**
+     * Whether the popover should be modal. When set to `true`:
+     * - interaction with outside elements will be disabled
+     * - only popover content will be visible to screen readers
+     * - scrolling is blocked
+     * - focus is trapped within the popover
+     *
+     * @default false
+     */
+    modal?: boolean;
+    /**
+     * Whether the popover is rendered in a portal
+     */
+    portalled?: boolean;
+    /**
+     * Whether to automatically set focus on the first focusable
+     * content within the popover when opened.
+     */
+    autoFocus?: boolean;
+    /**
+     * The element to focus on when the popover is opened.
+     */
+    initialFocusEl?: MaybeElement | (() => MaybeElement);
+    /**
+     * Whether to close the popover when the user clicks outside of the popover.
+     */
+    closeOnInteractOutside?: boolean;
+    /**
+     * Whether to close the popover when the escape key is pressed.
+     */
+    closeOnEsc?: boolean;
+    /**
+     * Function invoked when the popover is opened.
+     */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * The user provided options used to position the popover content
+     */
+    positioning: PositioningOptions;
+    /**
+     * Whether to open the popover on page load
+     */
+    defaultOpen?: boolean;
+};
+declare type UserDefinedContext = RequiredBy<PublicContext, "id">;
+declare type ComputedContext = Readonly<{
+    /**
+     * @computed
+     * The computed value of `portalled`
+     */
+    currentPortalled: boolean;
+}>;
+declare type PrivateContext = Context<{
+    /**
+     * Whether to prevent returning focus to the trigger
+     */
+    focusTriggerOnClose?: boolean;
+}>;
+declare type MachineContext = PublicContext & ComputedContext & PrivateContext;
+declare type MachineState = {
+    value: "unknown" | "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>): {
+    portalled: boolean;
+    isOpen: boolean;
+    open(): void;
+    close(): void;
+    arrowProps: T["element"];
+    innerArrowProps: T["element"];
+    anchorProps: T["element"];
+    triggerProps: T["button"];
+    positionerProps: T["element"];
+    contentProps: T["element"];
+    titleProps: T["element"];
+    descriptionProps: T["element"];
+    closeButtonProps: T["button"];
+};
+
+declare function machine(ctx: UserDefinedContext): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
+
+export { UserDefinedContext as Context, connect, machine };