@progress/kendo-react-popup 7.2.4-develop.3 → 7.2.4-develop.4

package/index.d.mts

@@ -1,5 +1,468 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-export * from './index';
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { AlignStrategy } from '@progress/kendo-popup-common';
+import { CollisionType as CollisionType_2 } from '@progress/kendo-popup-common';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { MarginSettings } from '@progress/kendo-popup-common';
+import { OffsetPosition } from '@progress/kendo-popup-common';
+import { PopupSettings } from '@progress/kendo-popup-common';
+import { PositionMode as PositionMode_2 } from '@progress/kendo-popup-common';
+import PropTypes from 'prop-types';
+import * as React_2 from 'react';
+import { ZIndexContext } from '@progress/kendo-react-common';
+import { ZIndexContextType } from '@progress/kendo-react-common';
+
+/**
+ * Defines the horizontal and vertical aligning point of the Popup.
+ */
+export declare interface Align extends AlignStrategy {
+    /**
+     * Defines the possible horizontal point values that are relative to the anchor or the Popup.
+     *
+     * The available options are:
+     * - `left`—Uses the leftmost point of the anchor element.
+     * - `center`—Uses the center point of the anchor element.
+     * - `right`—Uses the rightmost point of the anchor element.
+     */
+    horizontal: 'left' | 'center' | 'right';
+    /**
+     * Defines the possible vertical point values that are relative to the anchor or the Popup.
+     *
+     * The available options are:
+     * - `top`—Uses the top point of the anchor element.
+     * - `center`—Uses the center point of the anchor element.
+     * - `bottom`—Uses the bottom point of the anchor element.
+     */
+    vertical: 'top' | 'center' | 'bottom';
+}
+
+/**
+ * Defines the horizontal and vertical collision behavior of the Popup.
+ */
+export declare interface Collision {
+    /**
+     * Defines the horizontal collision behavior of the Popup.
+     */
+    horizontal: CollisionType;
+    /**
+     * Defines the vertical collision behavior of the Popup.
+     */
+    vertical: CollisionType;
+}
+
+/**
+ * Defines the possible collision behavior when the Popup is not fully visible.
+ *
+ * The available options are:
+ * - `fit`—Moves the Popup horizontally until it is fully displayed in the viewport.
+ * - `flip`—Flips the Popup position based on the origin and the position properties.
+ * - `none`—The Popup is rendered at its original position.
+ */
+export declare type CollisionType = CollisionType_2;
+
+/**
+ * Defines the horizontal and the vertical margin offset of the component.
+ */
+export declare interface Margin extends MarginSettings {
+    /**
+     * Defines the possible horizontal margin value.
+     */
+    horizontal: number;
+    /**
+     * Defines the possible vertical margin value.
+     */
+    vertical: number;
+}
+
+/**
+ * The offset position of the Popup.
+ */
+export declare interface Offset extends OffsetPosition {
+    /**
+     * Defines the top position of the Popup.
+     */
+    top: number;
+    /**
+     * Defines the left position of the Popup.
+     */
+    left: number;
+}
+
+/**
+ * The KendoReact Popup component.
+ */
+export declare const Popup: React_2.ForwardRefExoticComponent<PopupProps & React_2.RefAttributes<unknown>>;
+
+/** @hidden */
+export declare type Popup = PopupHandle;
+
+/**
+ * The animation settings for the Popup component.
+ */
+export declare interface PopupAnimation {
+    /**
+     * The duration of the opening animation in milliseconds. Defaults to `300ms`.
+     */
+    openDuration?: number;
+    /**
+     * The duration of the closing animation in milliseconds. Defaults to `300ms`.
+     */
+    closeDuration?: number;
+}
+
+/**
+ * Represents the object of the `Close` Popup event.
+ */
+export declare interface PopupCloseEvent {
+    /**
+     * An event target.
+     */
+    target: Popup;
+}
+
+declare interface PopupHandle extends Pick<PopupWithoutContext, keyof PopupWithoutContext> {
+    /**
+     * @hidden
+     */
+    element: any;
+}
+
+/**
+ * Represents the object of the `Open` Popup event.
+ */
+export declare interface PopupOpenEvent {
+    /**
+     * An event target.
+     */
+    target: Popup;
+}
+
+/**
+ * Represents the props of the [KendoReact Popup component]({% slug overview_popup %}).
+ */
+export declare interface PopupProps extends PopupSettings {
+    /**
+     * Controls the Popup animation ([see example]({% slug animations_popup %})). By default, the opening and closing animations are enabled.
+     */
+    animate?: boolean | PopupAnimation;
+    /**
+     * Specifies the element which will be used as an anchor ([see example]({% slug alignmentpositioning_popup %})). The Popup opens next to that element.
+     */
+    anchor?: HTMLElement | null;
+    /**
+     * Defines the container to which the Popup will be appended. Defaults to [`body`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body).
+     * * If set to `null` the Popup will be rendered without React Portal.
+     */
+    appendTo?: HTMLElement | null;
+    /**
+     * Specifies the pivot point of the anchor ([see example]({% slug alignmentpositioning_popup %})).
+     */
+    anchorAlign?: Align;
+    /**
+     * Configures the collision behavior of the Popup ([see example]({% slug viewportboundarydetection_popup %})).
+     */
+    collision?: Collision;
+    /**
+     * Configures the margin value that will be added to the popup dimensions
+     * in pixels and leaves a blank space between the popup and the anchor.
+     */
+    margin?: Margin;
+    /**
+     * Specifies the position mode of the component. By default, the Popup uses fixed positioning.
+     * To make the Popup acquire absolute positioning, set this option to `absolute`.
+     *
+     * > If you need to support mobile browsers with the zoom option, use the `absolute` positioning of the Popup.
+     */
+    positionMode?: PositionMode;
+    /**
+     * Used to set the document scale when using a [scale transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale).
+     *
+     * The document or container scale is required to compute the popup position correctly. Detecting the scale is not reliable and must be set by providing a value for SCALE. See [Support for Document Scale]({% slug documentscale_popup %}).
+     *
+     * > Using this token is not necessary for user-applied browser zoom.
+     *
+     */
+    scale?: number;
+    /**
+     * Specifies the pivot point of the Popup ([see example]({% slug alignmentpositioning_popup %})).
+     */
+    popupAlign?: Align;
+    /**
+     * Specifies the absolute position of the element ([see example]({% slug alignmentpositioning_popup %})). The Popup opens next to that point. The pivot point of the Popup is defined by the `popupAlign` configuration option. The boundary detection is applied by using the window viewport.
+     */
+    offset?: Offset;
+    /**
+     * Specifies a list of CSS classes that will be added to the internal animated element ([see example]({% slug appearance_popup %})).
+     */
+    popupClass?: string | Array<string> | {
+        [key: string]: boolean;
+    };
+    /**
+     * Specifies a list of CSS classes that will be added to the Popup element.
+     */
+    className?: string | Array<string>;
+    /**
+     * Specifies the id that will be added to the Popup element.
+     */
+    id?: string;
+    /**
+     * Represents the styles that are applied to the Popup.
+     */
+    style?: React.CSSProperties;
+    /**
+     * Fires after the Popup is opened and the opening animation ends.
+     */
+    onOpen?: (event: PopupOpenEvent) => void;
+    /**
+     * Fires after the Popup is closed.
+     */
+    onClose?: (event: PopupCloseEvent) => void;
+    /**
+     * Fires after the Popup position is set.
+     */
+    onPosition?: (event: PositionEvent) => void;
+    /**
+     * Controls the Popup visibility ([see example]({% slug hidden_popup %})). Defaults to `false`.
+     */
+    show?: boolean;
+    /**
+     * @hidden
+     *
+     * If contentKey has changed, the popup will recalculate its position.
+     */
+    contentKey?: any;
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+    /**
+     * @hidden
+     */
+    useBaseStyles?: boolean;
+    /**
+     * @hidden
+     */
+    role?: string;
+}
+
+/**
+ * The PopupPropsContext. It allows to configure the Popup props from a wrapper component.
+ *
+ * @example
+ * ```jsx-no-run
+ *  <PopupPropsContext.Provider value={props => ({ ...props, appendTo: document.querySelector('myPopupsContainer') })}>
+ *      <DropDownList />
+ *      <Editor />
+ *  </PopupPropsContext.Provider>
+ * ```
+ */
+export declare const PopupPropsContext: React_2.Context<(props: PopupProps) => PopupProps>;
+
+/**
+ * @hidden
+ */
+declare interface PopupState {
+    current: Status;
+    previous: Status;
+    props: {
+        show?: boolean;
+        anchor?: HTMLElement;
+        anchorAlign?: Align;
+        appendTo?: HTMLElement;
+        collision?: Collision;
+        popupAlign?: Align;
+        className?: string | Array<string>;
+        popupClass?: string | Array<string>;
+        style?: React_2.CSSProperties;
+        offset?: Offset;
+        contentKey?: any;
+    };
+}
+
+/**
+ * @hidden
+ */
+export declare class PopupWithoutContext extends React_2.Component<PopupProps, PopupState> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        anchor: (props: PopupProps) => Error | null;
+        appendTo: (props: PopupProps) => Error | null;
+        className: PropTypes.Requireable<NonNullable<string | object | null | undefined>>;
+        id: PropTypes.Requireable<string>;
+        popupClass: PropTypes.Requireable<NonNullable<string | object | null | undefined>>;
+        collision: PropTypes.Requireable<PropTypes.InferProps<{
+            horizontal: PropTypes.Requireable<string>;
+            vertical: PropTypes.Requireable<string>;
+        }>>;
+        anchorAlign: PropTypes.Requireable<PropTypes.InferProps<{
+            horizontal: PropTypes.Requireable<string>;
+            vertical: PropTypes.Requireable<string>;
+        }>>;
+        popupAlign: PropTypes.Requireable<PropTypes.InferProps<{
+            horizontal: PropTypes.Requireable<string>;
+            vertical: PropTypes.Requireable<string>;
+        }>>;
+        offset: PropTypes.Requireable<PropTypes.InferProps<{
+            left: PropTypes.Requireable<number>;
+            top: PropTypes.Requireable<number>;
+        }>>;
+        children: PropTypes.Requireable<NonNullable<PropTypes.ReactNodeLike>>;
+        show: PropTypes.Requireable<boolean>;
+        animate: PropTypes.Requireable<NonNullable<boolean | PropTypes.InferProps<{
+            openDuration: PropTypes.Requireable<number>;
+            closeDuration: PropTypes.Requireable<number>;
+        }> | null | undefined>>;
+        margin: PropTypes.Requireable<PropTypes.InferProps<{
+            horizontal: PropTypes.Requireable<number>;
+            vertical: PropTypes.Requireable<number>;
+        }>>;
+        positionMode: PropTypes.Requireable<string>;
+        scale: PropTypes.Requireable<number>;
+        style: PropTypes.Requireable<object>;
+        onClose: PropTypes.Requireable<(...args: any[]) => any>;
+        onPosition: PropTypes.Requireable<(...args: any[]) => any>;
+        onOpen: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    /**
+     * @hidden
+     */
+    static defaultProps: {
+        collision: {
+            horizontal: string;
+            vertical: string;
+        };
+        anchorAlign: {
+            horizontal: string;
+            vertical: string;
+        };
+        popupAlign: {
+            horizontal: string;
+            vertical: string;
+        };
+        offset: {
+            left: number;
+            top: number;
+        };
+        animate: boolean;
+        show: boolean;
+        margin: {
+            horizontal: number;
+            vertical: number;
+        };
+        positionMode: string;
+    };
+    /**
+     * @hidden
+     */
+    static contextType: React_2.Context<ZIndexContextType>;
+    /**
+     * @hidden
+     */
+    context: React_2.ContextType<typeof ZIndexContext>;
+    /**
+     * @hidden
+     */
+    static displayName: string;
+    /**
+     * @hidden
+     */
+    readonly state: PopupState;
+    private _collisions;
+    private _scrollableParents;
+    private _popup;
+    /**
+     * Represents the Popup DOM element.
+     */
+    get element(): HTMLDivElement | null;
+    constructor(props: PopupProps);
+    /**
+     * @hidden
+     */
+    static getDerivedStateFromProps(props: PopupProps, state: PopupState): {
+        props: {
+            show: boolean | undefined;
+            anchor: HTMLElement | null | undefined;
+            anchorAlign: Align | undefined;
+            appendTo: HTMLElement | null | undefined;
+            collision: Collision | undefined;
+            popupAlign: Align | undefined;
+            className: string | string[] | undefined;
+            popupClass: string | string[] | {
+                [key: string]: boolean;
+            } | undefined;
+            style: React_2.CSSProperties | undefined;
+            offset: Offset | undefined;
+            contentKey: any;
+        };
+        current: Status;
+        previous: Status;
+    };
+    /**
+     *
+     * @hidden
+     */
+    componentDidUpdate(prevProps: PopupProps): void;
+    /**
+     * @hidden
+     */
+    componentDidMount(): void;
+    /**
+     * @hidden
+     */
+    componentWillUnmount(): void;
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element | null;
+    private show;
+    private setPosition;
+    private onOpened;
+    private animate;
+    private onClosing;
+    private onClosed;
+    private get animationDuration();
+    private attachRepositionHandlers;
+    private detachRepositionHandlers;
+    private reposition;
+    private getCurrentZIndex;
+}
+
+/**
+ * Represents the object of the `Position` Popup event.
+ */
+declare interface PositionEvent {
+    /**
+     * An event target.
+     */
+    target: Popup;
+    /**
+     * Indicates if the position is fitted.
+     */
+    fitted: boolean;
+    /**
+     * Indicates if the position is flipped.
+     */
+    flipped: boolean;
+}
+
+/**
+ * The type which defines all possible position modes of the Popup.
+ */
+export declare type PositionMode = PositionMode_2;
+
+declare enum Status {
+    hiding = "hiding",
+    hidden = "hidden",
+    showing = "showing",
+    shown = "shown",
+    reposition = "reposition"
+}
+
+export { }