@instructure/ui-popover 8.12.1-snapshot.51 → 8.13.0

package/types/Popover/index.d.ts

@@ -1,13 +1,15 @@
 import React, { Component } from 'react';
-import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils';
-import type { PopoverProps } from './props';
+import type { PositionProps } from '@instructure/ui-position';
+import type { DialogProps } from '@instructure/ui-dialog';
+import type { PopoverProps, PopoverState } from './props';
 /**
 ---
 category: components
 tags: overlay, portal, dialog
 ---
+@tsProps
 **/
-declare class Popover extends Component<PopoverProps> {
+declare class Popover extends Component<PopoverProps, PopoverState> {
     static readonly componentId = "Popover";
     static allowedProps: readonly (keyof {
         isShowingContent?: boolean | undefined;
@@ -17,17 +19,17 @@ declare class Popover extends Component<PopoverProps> {
         color?: "primary" | "primary-inverse" | undefined;
         shadow?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Shadow | undefined;
         stacking?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Stacking | undefined;
-        contentRef?: ((...args: any[]) => any) | undefined;
-        defaultFocusElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        contentRef?: ((contentElement: Element | null) => void) | undefined;
+        defaultFocusElement?: import("@instructure/shared-types").UIElement | undefined;
+        liveRegion?: import("@instructure/shared-types").LiveRegion | undefined;
         screenReaderLabel?: string | undefined;
         offsetX?: string | number | undefined;
         offsetY?: string | number | undefined;
-        placement: import("@instructure/ui-position").PlacementPropValues;
+        placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
         constrain?: import("@instructure/ui-position").PositionConstraint | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
         insertAt?: "top" | "bottom" | undefined;
-        liveRegion?: import("@instructure/shared-types").LiveRegion | undefined;
         id?: string | undefined;
         shouldAlignArrow?: boolean | undefined;
         shouldTrackPosition?: boolean | undefined;
@@ -37,19 +39,21 @@ declare class Popover extends Component<PopoverProps> {
         shouldCloseOnDocumentClick?: boolean | undefined;
         shouldCloseOnEscape?: boolean | undefined;
         shouldFocusContentOnTriggerBlur?: boolean | undefined;
-        onShowContent?: ((...args: any[]) => any) | undefined;
-        onHideContent?: ((...args: any[]) => any) | undefined;
-        onPositioned?: ((...args: any[]) => any) | undefined;
-        onPositionChanged?: ((...args: any[]) => any) | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
-        onFocus?: ((...args: any[]) => any) | undefined;
-        onBlur?: ((...args: any[]) => any) | undefined;
-        onKeyDown?: ((...args: any[]) => any) | undefined;
-        onKeyUp?: ((...args: any[]) => any) | undefined;
-        onMouseOver?: ((...args: any[]) => any) | undefined;
-        onMouseOut?: ((...args: any[]) => any) | undefined;
-        renderTrigger?: React.ReactNode | ((...args: any[]) => any);
-        children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
+        onShowContent?: ((event: Event) => void) | undefined;
+        onHideContent?: ((event: Event, args: {
+            documentClick: boolean;
+        }) => void) | undefined;
+        onPositioned?: ((position: import("@instructure/ui-position/types/Position/props").PositionObject) => void) | undefined;
+        onPositionChanged?: ((position: import("@instructure/ui-position/types/Position/props").PositionObject) => void) | undefined;
+        onClick?: ((event: Event) => void) | undefined;
+        onFocus?: ((event: Event) => void) | undefined;
+        onBlur?: ((event: Event) => void) | undefined;
+        onKeyDown?: ((event: Event) => void) | undefined;
+        onKeyUp?: ((event: Event) => void) | undefined;
+        onMouseOver?: ((event: Event) => void) | undefined;
+        onMouseOut?: ((event: Event) => void) | undefined;
+        renderTrigger?: React.ReactNode | (() => React.ReactNode);
+        children?: React.ReactNode | (() => React.ReactNode);
         elementRef?: ((element: Element | null) => void) | undefined;
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
@@ -60,17 +64,17 @@ declare class Popover extends Component<PopoverProps> {
         color?: "primary" | "primary-inverse" | undefined;
         shadow?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Shadow | undefined;
         stacking?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Stacking | undefined;
-        contentRef?: ((...args: any[]) => any) | undefined;
-        defaultFocusElement?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
+        contentRef?: ((contentElement: Element | null) => void) | undefined;
+        defaultFocusElement?: import("@instructure/shared-types").UIElement | undefined;
+        liveRegion?: import("@instructure/shared-types").LiveRegion | undefined;
         screenReaderLabel?: string | undefined;
         offsetX?: string | number | undefined;
         offsetY?: string | number | undefined;
-        placement: import("@instructure/ui-position").PlacementPropValues;
+        placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
         constrain?: import("@instructure/ui-position").PositionConstraint | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
         insertAt?: "top" | "bottom" | undefined;
-        liveRegion?: import("@instructure/shared-types").LiveRegion | undefined;
         id?: string | undefined;
         shouldAlignArrow?: boolean | undefined;
         shouldTrackPosition?: boolean | undefined;
@@ -80,19 +84,21 @@ declare class Popover extends Component<PopoverProps> {
         shouldCloseOnDocumentClick?: boolean | undefined;
         shouldCloseOnEscape?: boolean | undefined;
         shouldFocusContentOnTriggerBlur?: boolean | undefined;
-        onShowContent?: ((...args: any[]) => any) | undefined;
-        onHideContent?: ((...args: any[]) => any) | undefined;
-        onPositioned?: ((...args: any[]) => any) | undefined;
-        onPositionChanged?: ((...args: any[]) => any) | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
-        onFocus?: ((...args: any[]) => any) | undefined;
-        onBlur?: ((...args: any[]) => any) | undefined;
-        onKeyDown?: ((...args: any[]) => any) | undefined;
-        onKeyUp?: ((...args: any[]) => any) | undefined;
-        onMouseOver?: ((...args: any[]) => any) | undefined;
-        onMouseOut?: ((...args: any[]) => any) | undefined;
-        renderTrigger?: React.ReactNode | ((...args: any[]) => any);
-        children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
+        onShowContent?: ((event: Event) => void) | undefined;
+        onHideContent?: ((event: Event, args: {
+            documentClick: boolean;
+        }) => void) | undefined;
+        onPositioned?: ((position: import("@instructure/ui-position/types/Position/props").PositionObject) => void) | undefined;
+        onPositionChanged?: ((position: import("@instructure/ui-position/types/Position/props").PositionObject) => void) | undefined;
+        onClick?: ((event: Event) => void) | undefined;
+        onFocus?: ((event: Event) => void) | undefined;
+        onBlur?: ((event: Event) => void) | undefined;
+        onKeyDown?: ((event: Event) => void) | undefined;
+        onKeyUp?: ((event: Event) => void) | undefined;
+        onMouseOver?: ((event: Event) => void) | undefined;
+        onMouseOut?: ((event: Event) => void) | undefined;
+        renderTrigger?: React.ReactNode | (() => React.ReactNode);
+        children?: React.ReactNode | (() => React.ReactNode);
         elementRef?: ((element: Element | null) => void) | undefined;
     }>;
     static defaultProps: {
@@ -104,7 +110,6 @@ declare class Popover extends Component<PopoverProps> {
         offsetY: number;
         color: string;
         on: string[];
-        contentRef: (el: any) => void;
         withArrow: boolean;
         constrain: string;
         insertAt: string;
@@ -116,64 +121,44 @@ declare class Popover extends Component<PopoverProps> {
         shouldCloseOnDocumentClick: boolean;
         shouldFocusContentOnTriggerBlur: boolean;
         shouldCloseOnEscape: boolean;
-        onShowContent: (event: any) => void;
-        onHideContent: (event: any, { documentClick }: {
-            documentClick: any;
-        }) => void;
-        onClick: (event: any) => void;
-        onFocus: (event: any) => void;
-        onBlur: (event: any) => void;
-        onMouseOver: (event: any) => void;
-        onMouseOut: (event: any) => void;
-        onKeyDown: (event: any) => void;
-        onKeyUp: (event: any) => void;
-        onPositioned: (position: any) => void;
-        onPositionChanged: (position: any) => void;
-        renderTrigger: null;
-        children: null;
     };
-    _handleMouseOver: (...args: any[]) => any | undefined;
-    _handleMouseOut: (...args: any[]) => any | undefined;
-    constructor(props: any);
-    _raf: RequestAnimationFrameType[];
+    constructor(props: PopoverProps);
+    private _handleMouseOver;
+    private _handleMouseOut;
+    private _id;
+    private _raf;
+    private _trigger?;
+    private _view;
+    private _dialog;
+    private _contentElement;
+    private _focusRegion?;
+    private mouseOutTimeout?;
     ref: Element | null;
     handleRef: (el: Element | null) => void;
     get isTooltip(): boolean | undefined;
     componentDidMount(): void;
     componentWillUnmount(): void;
-    shouldComponentUpdate(nextProps: any, nextState: any, nextContext: any): boolean;
-    componentDidUpdate(prevProps: any, prevState: any, snapShot: any): void;
-    computeOffsets(placement: any): {
+    shouldComponentUpdate(nextProps: PopoverProps, nextState: PopoverState): boolean;
+    componentDidUpdate(prevProps: PopoverProps, prevState: PopoverState): void;
+    computeOffsets(placement: PopoverProps['placement']): {
         offsetX: string | number | undefined;
         offsetY: string | number | undefined;
     };
-    get placement(): import("@instructure/ui-position").PlacementPropValues;
-    get positionProps(): {
-        offsetX: any;
-        offsetY: any;
-        shouldTrackPosition: any;
-        insertAt: "top" | "bottom" | undefined;
-        placement: import("@instructure/ui-position").PlacementPropValues;
-        constrain: import("@instructure/ui-position").PositionConstraint | undefined;
-        onPositioned: (position: any) => void;
-        onPositionChanged: (position: any) => void;
-        target: import("@instructure/ui-position").PositionMountNode | undefined;
-        mountNode: import("@instructure/ui-position").PositionMountNode | undefined;
-        id: any;
-    };
-    get shown(): any;
-    get defaultFocusElement(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((...args: any[]) => any) | undefined;
-    show: (event: any) => void;
-    hide: (event: any, documentClick?: boolean) => void;
-    toggle: (event: any) => void;
-    handleDialogDismiss: (...args: any[]) => void;
-    handleDialogBlur: (event: any) => void;
-    handleTriggerKeyDown: (event: any) => void;
-    handleTriggerKeyUp: (event: any) => void;
-    handleTriggerBlur: (event: any) => void;
-    handlePositioned: (position: any) => void;
-    handlePositionChanged: (position: any) => void;
-    renderTrigger(): any;
+    get placement(): PopoverProps['placement'];
+    get positionProps(): Partial<PositionProps>;
+    get shown(): boolean | undefined;
+    get defaultFocusElement(): import("@instructure/shared-types").UIElement | undefined;
+    show: (event: Event) => void;
+    hide: (event: Event, documentClick?: boolean) => void;
+    toggle: (event: Event) => void;
+    handleDialogDismiss: DialogProps['onDismiss'];
+    handleDialogBlur: (event: Event) => void;
+    handleTriggerKeyDown: (event: KeyboardEvent) => void;
+    handleTriggerKeyUp: (event: KeyboardEvent) => void;
+    handleTriggerBlur: (event: Event) => void;
+    handlePositioned: PositionProps['onPositioned'];
+    handlePositionChanged: PositionProps['onPositionChanged'];
+    renderTrigger(): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
     renderContent(): JSX.Element | null;
     render(): JSX.Element;
 }

package/types/Popover/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Popover/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAiBxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAS1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAG3C;;;;;GAKG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA8ClB;IAED,gBAAgB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,SAAS,CAAA;IACrD,eAAe,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,SAAS,CAAA;gBAGxC,KAAK,KAAA;IAkCjB,IAAI,EAAE,yBAAyB,EAAE,CAAK;IAEtC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,SAAS,wBAOZ;IAED,iBAAiB;IAmBjB,oBAAoB;IAcpB,qBAAqB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,WAAW,KAAA;IAQvD,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IA6CjD,cAAc,CAAC,SAAS,KAAA;;;;IA4BxB,IAAI,SAAS,2DAWZ;IAED,IAAI,aAAa;;;;;;;;;;;;MAiBhB;IAED,IAAI,KAAK,QAKR;IAED,IAAI,mBAAmB,+GAEtB;IAGD,IAAI,uBAMH;IAGD,IAAI,gDAkBH;IAGD,MAAM,uBAML;IAGD,mBAAmB,2BAclB;IAGD,gBAAgB,uBASf;IAGD,oBAAoB,uBAcnB;IAGD,kBAAkB,uBAOjB;IAGD,iBAAiB,uBAYhB;IAGD,gBAAgB,0BAQf;IAGD,qBAAqB,0BAQpB;IAED,aAAa;IAyEb,aAAa;IA0Fb,MAAM;CAsBP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Popover/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AA2BxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGzD;;;;;;GAMG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;MAoBlB;gBAEW,KAAK,EAAE,YAAY;IA4B/B,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,eAAe,CAAyB;IAEhD,OAAO,CAAC,GAAG,CAAQ;IACnB,OAAO,CAAC,IAAI,CAAkC;IAC9C,OAAO,CAAC,QAAQ,CAAC,CAAoB;IACrC,OAAO,CAAC,KAAK,CAAkC;IAC/C,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,YAAY,CAAC,CAAa;IAElC,OAAO,CAAC,eAAe,CAAC,CAA+B;IAEvD,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,SAAS,wBAOZ;IAED,iBAAiB;IAiBjB,oBAAoB;IAUpB,qBAAqB,CAAC,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY;IAOtE,kBAAkB,CAAC,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY;IAsCnE,cAAc,CAAC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;;;;IA2BnD,IAAI,SAAS,IAAI,YAAY,CAAC,WAAW,CAAC,CAWzC;IAED,IAAI,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,CAc1C;IAED,IAAI,KAAK,wBAIR;IAED,IAAI,mBAAmB,8DAEtB;IAED,IAAI,UAAW,KAAK,UAKnB;IAED,IAAI,UAAW,KAAK,mCAenB;IAED,MAAM,UAAW,KAAK,UAMrB;IAED,mBAAmB,EAAE,WAAW,CAAC,WAAW,CAAC,CAY5C;IAED,gBAAgB,UAAW,KAAK,UAS/B;IAED,oBAAoB,UAAW,aAAa,UAa3C;IAED,kBAAkB,UAAW,aAAa,UAOzC;IAED,iBAAiB,UAAW,KAAK,UAYhC;IAED,gBAAgB,EAAE,aAAa,CAAC,cAAc,CAAC,CAO9C;IAED,qBAAqB,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAOxD;IAED,aAAa;IAsEb,aAAa;IAmFb,MAAM;CAsBP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/types/Popover/props.d.ts

@@ -1,56 +1,202 @@
 import React from 'react';
 import type { Shadow, Stacking } from '@instructure/emotion';
-import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
+import type { PlacementPropValues, PositionConstraint, PositionMountNode, PositionObject } from '@instructure/ui-position';
 import type { BidirectionalProps } from '@instructure/ui-i18n';
-import type { PropValidators, LiveRegion } from '@instructure/shared-types';
+import type { PropValidators, LiveRegion, UIElement } from '@instructure/shared-types';
 declare type PopoverOwnProps = {
+    /**
+     * Whether or not the `<Popover />` content is shown
+     */
     isShowingContent?: boolean;
+    /**
+     * Whether or not to show the content by default, when uncontrolled
+     */
     defaultIsShowingContent?: boolean;
+    /**
+     * The action that causes the content to display (`click`, `hover`, `focus`)
+     */
     on?: ('click' | 'hover' | 'focus') | ('click' | 'hover' | 'focus')[];
+    /**
+     * Whether or not an arrow pointing to the trigger should be rendered
+     */
     withArrow?: boolean;
+    /**
+     * Color variant of the popover content
+     */
     color?: 'primary' | 'primary-inverse';
+    /**
+     * Controls the shadow depth for the `<Popover />`
+     */
     shadow?: Shadow;
+    /**
+     * Controls the z-index depth for the `<Popover />` content
+     */
     stacking?: Stacking;
-    contentRef?: (...args: any[]) => any;
-    defaultFocusElement?: React.ReactElement | ((...args: any[]) => any);
+    /**
+     * A function that returns a reference to the content element
+     */
+    contentRef?: (contentElement: Element | null) => void;
+    /**
+     * An element or a function returning an element to focus by default
+     */
+    defaultFocusElement?: UIElement;
+    /**
+     * An element, function returning an element, or array of elements that will
+     * not be hidden from the screen reader when the `<Popover />` is open
+     */
+    liveRegion?: LiveRegion;
+    /**
+     * An accessible label for the `<Popover />` content
+     */
     screenReaderLabel?: string;
+    /**
+     * The horizontal offset for the positioned content
+     */
     offsetX?: string | number;
+    /**
+     * The vertical offset for the positioned content
+     */
     offsetY?: string | number;
-    placement: PlacementPropValues;
+    /**
+     * The placement of the content in relation to the trigger
+     *
+     * One of: 'top', 'bottom', 'start', 'end', 'top start', 'top center',
+     * 'top end', 'top stretch', 'bottom start', 'bottom center', 'bottom end',
+     * 'bottom stretch', 'start top', 'start center', 'start bottom',
+     * 'start stretch', 'end top', 'end center', 'end bottom', 'end stretch',
+     * 'center start', 'center end', 'offscreen'
+     */
+    placement?: PlacementPropValues;
+    /**
+     * The parent in which to constrain the popover.
+     *
+     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+     * or a function returning an element
+     */
     constrain?: PositionConstraint;
+    /**
+     * An element or a function returning an element to use as the mount node
+     * for the `<Popover />` (defaults to `document.body`)
+     */
     mountNode?: PositionMountNode;
+    /**
+     * Target element for positioning the Popover (if it differs from the trigger)
+     */
     positionTarget?: PositionMountNode;
+    /**
+     * Insert the element at the 'top' of the mountNode or at the 'bottom'
+     */
     insertAt?: 'bottom' | 'top';
-    liveRegion?: LiveRegion;
+    /**
+     * An id is generated if not supplied.
+     */
     id?: string;
+    /**
+     * Whether or not the content should offset to align by its arrow
+     */
     shouldAlignArrow?: boolean;
+    /**
+     * Whether or not position should be tracked or just set on initial render
+     */
     shouldTrackPosition?: boolean;
+    /**
+     * Should the `<Popover />` render offscreen when visually hidden
+     */
     shouldRenderOffscreen?: boolean;
+    /**
+     * Whether focus should contained within the `<Popover/>` when it is open
+     */
     shouldContainFocus?: boolean;
+    /**
+     * Whether focus should be returned to the trigger when the `<Popover/>` is closed
+     */
     shouldReturnFocus?: boolean;
+    /**
+     * Should the `<Popover />` hide when clicks occur outside the content
+     */
     shouldCloseOnDocumentClick?: boolean;
+    /**
+     * Should the `<Popover />` hide when the escape key is pressed
+     */
     shouldCloseOnEscape?: boolean;
+    /**
+     * Should the content become focused when the trigger is blurred
+     */
     shouldFocusContentOnTriggerBlur?: boolean;
-    onShowContent?: (...args: any[]) => any;
-    onHideContent?: (...args: any[]) => any;
-    onPositioned?: (...args: any[]) => any;
-    onPositionChanged?: (...args: any[]) => any;
-    onClick?: (...args: any[]) => any;
-    onFocus?: (...args: any[]) => any;
-    onBlur?: (...args: any[]) => any;
-    onKeyDown?: (...args: any[]) => any;
-    onKeyUp?: (...args: any[]) => any;
-    onMouseOver?: (...args: any[]) => any;
-    onMouseOut?: (...args: any[]) => any;
-    renderTrigger?: React.ReactNode | ((...args: any[]) => any);
-    children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
+    /**
+     * Callback fired when content is shown. When controlled, this callback is
+     * fired when the Popover expects to be shown
+     */
+    onShowContent?: (event: Event) => void;
+    /**
+     * Callback fired when content is hidden. When controlled, this callback is
+     * fired when the Popover expects to be hidden
+     */
+    onHideContent?: (event: Event, args: {
+        documentClick: boolean;
+    }) => void;
+    /**
+     * Callback fired when content has been is initially positioned.
+     * If `shouldRenderOffscreen` is true, it will only fire once, the first
+     * time the content is shown
+     */
+    onPositioned?: (position: PositionObject) => void;
+    /**
+     * Callback fired when the position changes
+     */
+    onPositionChanged?: (position: PositionObject) => void;
+    /**
+     * Callback fired when component is clicked
+     */
+    onClick?: (event: Event) => void;
+    /**
+     * Callback fired when trigger is focused
+     */
+    onFocus?: (event: Event) => void;
+    /**
+     * Callback fired when component is blurred
+     */
+    onBlur?: (event: Event) => void;
+    /**
+     * Callback fired on keydown
+     */
+    onKeyDown?: (event: Event) => void;
+    /**
+     * Callback fired on keyup
+     */
+    onKeyUp?: (event: Event) => void;
+    /**
+     * Callback fired when mouse is over trigger
+     */
+    onMouseOver?: (event: Event) => void;
+    /**
+     * Callback fired when mouse leaves trigger
+     */
+    onMouseOut?: (event: Event) => void;
+    /**
+     * The element that triggers the popover
+     */
+    renderTrigger?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * The content to be shown by the popover
+     */
+    children?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * Provides a reference to the underlying HTML root element
+     */
     elementRef?: (element: Element | null) => void;
 };
 declare type PopoverProps = PopoverOwnProps & BidirectionalProps;
+declare type PopoverState = {
+    placement: PopoverOwnProps['placement'];
+    offsetX: PopoverOwnProps['offsetX'];
+    offsetY: PopoverOwnProps['offsetY'];
+    isShowingContent?: boolean;
+};
 declare type PropKeys = keyof PopoverOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { PopoverProps };
+export type { PopoverProps, PopoverState };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

package/types/Popover/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Popover/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAOzB,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AA8B3E,aAAK,eAAe,GAAG;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,EAAE,CAAA;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACpC,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACpE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,SAAS,EAAE,mBAAmB,CAAA;IAC9B,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAClC,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;IAC3B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,+BAA+B,CAAC,EAAE,OAAO,CAAA;IACzC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACvC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACvC,YAAY,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACtC,iBAAiB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC3C,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAChC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACpC,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC3D,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,aAAK,YAAY,GAAG,eAAe,GAAG,kBAAkB,CAAA;AAExD,aAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAsLvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eA0CnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Popover/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAOzB,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACf,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,UAAU,EACV,SAAS,EACV,MAAM,2BAA2B,CAAA;AAElC,aAAK,eAAe,GAAG;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;IAEjC;;OAEG;IACH,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,EAAE,CAAA;IAEpE;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAGzB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAE/B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAE9B;;;OAGG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;IAE3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;IAEzC;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEtC;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAA;IAExE;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAEjD;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAEtD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEzD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEpD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,aAAK,YAAY,GAAG,eAAe,GAAG,kBAAkB,CAAA;AAExD,aAAK,YAAY,GAAG;IAClB,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAA;IACvC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACnC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAiDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eA0CnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**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.