@fluentui/react-popover 9.0.0-rc.6 → 9.0.0-rc.9

package/lib-commonjs/components/Popover/Popover.types.d.ts

@@ -1,109 +0,0 @@
-import * as React from 'react';
-import type { PopperVirtualElement, PositioningShorthand, usePopperMouseTarget } from '@fluentui/react-positioning';
-import type { PortalProps } from '@fluentui/react-portal';
-/**
- * Determines popover padding and arrow size
- */
-export declare type PopoverSize = 'small' | 'medium' | 'large';
-declare type PopoverCommons = Pick<PortalProps, 'mountNode'> & {
-    /**
-     * Controls the opening of the Popover
-     */
-    open: boolean;
-    /**
-     * Used to set the initial open state of the Popover in uncontrolled mode
-     */
-    defaultOpen?: boolean;
-    /**
-     * Call back when the component requests to change value
-     * The `open` value is used as a hint when directly controlling the component
-     */
-    onOpenChange?: (e: OpenPopoverEvents, data: OnOpenChangeData) => void;
-    /**
-     * Flag to open the Popover by hovering the trigger
-     */
-    openOnHover?: boolean;
-    /**
-     * Flag to open the Popover as a context menu. Disables all other interactions
-     */
-    openOnContext?: boolean;
-    /**
-     * Do not display the arrow
-     */
-    noArrow?: boolean;
-    /**
-     * Determines popover padding and arrow size
-     * @default medium
-     */
-    size?: PopoverSize;
-    /**
-     * A popover can appear styled with brand or inverted.
-     * When not specified, the default style is used.
-     */
-    appearance?: 'brand' | 'inverted';
-    /**
-     * Should trap focus
-     */
-    trapFocus?: boolean;
-    /**
-     * Configures the position of the Popover
-     */
-    positioning?: PositioningShorthand;
-};
-/**
- * Popover Props
- */
-export declare type PopoverProps = Partial<PopoverCommons> & {
-    /**
-     * Can contain two children including {@link PopoverTrigger} and {@link PopoverSurface}.
-     * Alternatively can only contain {@link PopoverSurface} if using a custom `target`.
-     */
-    children: [JSX.Element, JSX.Element] | JSX.Element;
-};
-/**
- * Popover State
- */
-export declare type PopoverState = PopoverCommons & Pick<PopoverProps, 'children'> & {
-    /**
-     * Callback to open/close the Popover
-     */
-    setOpen: (e: OpenPopoverEvents, open: boolean) => void;
-    /**
-     * Callback to toggle the open state of the Popover
-     */
-    toggleOpen: (e: OpenPopoverEvents) => void;
-    /**
-     * Ref of the PopoverTrigger
-     */
-    triggerRef: React.MutableRefObject<HTMLElement | null>;
-    /**
-     * Ref of the PopoverSurface
-     */
-    contentRef: React.MutableRefObject<HTMLElement | null>;
-    /**
-     * Ref of the pointing arrow
-     */
-    arrowRef: React.MutableRefObject<HTMLDivElement | null>;
-    /**
-     * Anchors the popper to the mouse click for context events
-     */
-    contextTarget: PopperVirtualElement | undefined;
-    /**
-     * A callback to set the target of the popper to the mouse click for context events
-     */
-    setContextTarget: ReturnType<typeof usePopperMouseTarget>[1];
-    size: NonNullable<PopoverProps['size']>;
-    popoverTrigger: React.ReactElement | undefined;
-    popoverSurface: React.ReactElement | undefined;
-};
-/**
- * Data attached to open/close events
- */
-export declare type OnOpenChangeData = {
-    open: boolean;
-};
-/**
- * The supported events that will trigger open/close of the menu
- */
-export declare type OpenPopoverEvents = MouseEvent | TouchEvent | React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement> | React.FocusEvent<HTMLElement>;
-export {};

package/lib-commonjs/components/Popover/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Popover';
-export * from './Popover.types';
-export * from './renderPopover';
-export * from './usePopover';

package/lib-commonjs/components/Popover/renderPopover.d.ts

@@ -1,5 +0,0 @@
-import type { PopoverState } from './Popover.types';
-/**
- * Render the final JSX of Popover
- */
-export declare const renderPopover_unstable: (state: PopoverState) => JSX.Element;

package/lib-commonjs/components/Popover/usePopover.d.ts

@@ -1,10 +0,0 @@
-import type { PopoverProps, PopoverState } from './Popover.types';
-/**
- * Create the state required to render Popover.
- *
- * The returned state can be modified with hooks such as usePopoverStyles,
- * before being passed to renderPopover_unstable.
- *
- * @param props - props from this instance of Popover
- */
-export declare const usePopover_unstable: (props: PopoverProps) => PopoverState;

package/lib-commonjs/components/PopoverSurface/PopoverSurface.d.ts

@@ -1,6 +0,0 @@
-import type { PopoverSurfaceProps } from './PopoverSurface.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-/**
- * PopoverSurface component renders react children in a positioned box
- */
-export declare const PopoverSurface: ForwardRefComponent<PopoverSurfaceProps>;

package/lib-commonjs/components/PopoverSurface/PopoverSurface.types.d.ts

@@ -1,21 +0,0 @@
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-import type { PopoverContextValue } from '../../popoverContext';
-/**
- * PopoverSurface Props
- */
-export declare type PopoverSurfaceProps = ComponentProps<PopoverSurfaceSlots>;
-/**
- * Names of the slots in PopoverSurfaceProps
- */
-export declare type PopoverSurfaceSlots = {
-    root: Slot<'div'>;
-};
-/**
- * PopoverSurface State
- */
-export declare type PopoverSurfaceState = ComponentState<PopoverSurfaceSlots> & Pick<PopoverContextValue, 'mountNode' | 'noArrow' | 'size' | 'appearance' | 'arrowRef'> & {
-    /**
-     * CSS class for the arrow element
-     */
-    arrowClassName?: string;
-};

package/lib-commonjs/components/PopoverSurface/index.d.ts

@@ -1,5 +0,0 @@
-export * from './PopoverSurface';
-export * from './PopoverSurface.types';
-export * from './renderPopoverSurface';
-export * from './usePopoverSurface';
-export * from './usePopoverSurfaceStyles';

package/lib-commonjs/components/PopoverSurface/renderPopoverSurface.d.ts

@@ -1,5 +0,0 @@
-import type { PopoverSurfaceState } from './PopoverSurface.types';
-/**
- * Render the final JSX of PopoverSurface
- */
-export declare const renderPopoverSurface_unstable: (state: PopoverSurfaceState) => JSX.Element;

package/lib-commonjs/components/PopoverSurface/usePopoverSurface.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-import type { PopoverSurfaceProps, PopoverSurfaceState } from './PopoverSurface.types';
-/**
- * Create the state required to render PopoverSurface.
- *
- * The returned state can be modified with hooks such as usePopoverSurfaceStyles_unstable,
- * before being passed to renderPopoverSurface_unstable.
- *
- * @param props - props from this instance of PopoverSurface
- * @param ref - reference to root HTMLDivElement of PopoverSurface
- */
-export declare const usePopoverSurface_unstable: (props: PopoverSurfaceProps, ref: React.Ref<HTMLDivElement>) => PopoverSurfaceState;

package/lib-commonjs/components/PopoverSurface/usePopoverSurfaceStyles.d.ts

@@ -1,13 +0,0 @@
-import type { PopoverSize } from '../Popover/Popover.types';
-import type { PopoverSurfaceSlots, PopoverSurfaceState } from './PopoverSurface.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `popoverSurfaceClassNames.root` instead.
- */
-export declare const popoverSurfaceClassName = "fui-PopoverSurface";
-export declare const popoverSurfaceClassNames: SlotClassNames<PopoverSurfaceSlots>;
-export declare const arrowHeights: Record<PopoverSize, number>;
-/**
- * Apply styling to the PopoverSurface slots based on the state
- */
-export declare const usePopoverSurfaceStyles_unstable: (state: PopoverSurfaceState) => PopoverSurfaceState;

package/lib-commonjs/components/PopoverTrigger/PopoverTrigger.d.ts

@@ -1,7 +0,0 @@
-import * as React from 'react';
-import type { FluentTriggerComponent } from '@fluentui/react-utilities';
-import type { PopoverTriggerProps } from './PopoverTrigger.types';
-/**
- * Wraps a trigger element as an only child and adds the necessary event handling to open a popover.
- */
-export declare const PopoverTrigger: React.FC<PopoverTriggerProps> & FluentTriggerComponent;

package/lib-commonjs/components/PopoverTrigger/PopoverTrigger.types.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-/**
- * PopoverTrigger Props
- */
-export declare type PopoverTriggerProps = {
-    children: (React.ReactElement & {
-        ref?: React.Ref<unknown>;
-    }) | ((props: PopoverTriggerChildProps) => React.ReactElement | null);
-};
-/**
- * PopoverTrigger State
- */
-export declare type PopoverTriggerState = {
-    children: React.ReactElement | null;
-};
-export declare type PopoverTriggerChildProps = {
-    ref?: React.Ref<never>;
-} & Pick<React.HTMLAttributes<HTMLElement>, 'aria-haspopup' | 'onClick' | 'onMouseEnter' | 'onKeyDown' | 'onMouseLeave' | 'onContextMenu'>;

package/lib-commonjs/components/PopoverTrigger/index.d.ts

@@ -1,4 +0,0 @@
-export * from './PopoverTrigger';
-export * from './PopoverTrigger.types';
-export * from './renderPopoverTrigger';
-export * from './usePopoverTrigger';

package/lib-commonjs/components/PopoverTrigger/renderPopoverTrigger.d.ts

@@ -1,5 +0,0 @@
-import type { PopoverTriggerState } from './PopoverTrigger.types';
-/**
- * Render the final JSX of PopoverTrigger
- */
-export declare const renderPopoverTrigger_unstable: (state: PopoverTriggerState) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;

package/lib-commonjs/components/PopoverTrigger/usePopoverTrigger.d.ts

@@ -1,10 +0,0 @@
-import type { PopoverTriggerProps, PopoverTriggerState } from './PopoverTrigger.types';
-/**
- * Create the state required to render PopoverTrigger.
- *
- * The returned state can be modified with hooks such as usePopoverTriggerStyles,
- * before being passed to renderPopoverTrigger_unstable.
- *
- * @param props - props from this instance of PopoverTrigger
- */
-export declare const usePopoverTrigger_unstable: (props: PopoverTriggerProps) => PopoverTriggerState;

package/lib-commonjs/index.d.ts

@@ -1,4 +0,0 @@
-export * from './Popover';
-export * from './PopoverSurface';
-export * from './popoverContext';
-export * from './PopoverTrigger';

package/lib-commonjs/popoverContext.d.ts

@@ -1,8 +0,0 @@
-import type { ContextSelector, Context } from '@fluentui/react-context-selector';
-import type { PopoverState } from './components/Popover/index';
-export declare const PopoverContext: Context<PopoverContextValue>;
-/**
- * Context shared between Popover and its children components
- */
-export declare type PopoverContextValue = Pick<PopoverState, 'toggleOpen' | 'setOpen' | 'triggerRef' | 'contentRef' | 'openOnHover' | 'openOnContext' | 'mountNode' | 'noArrow' | 'arrowRef' | 'size' | 'appearance' | 'trapFocus'>;
-export declare const usePopoverContext_unstable: <T>(selector: ContextSelector<PopoverContextValue, T>) => T;