@fluentui/react-positioning 0.0.0-nightly9edaf68d4420211116.1 → 0.0.0-nightly9fe22334a320220214.1

package/lib/types.d.ts

@@ -12,18 +12,25 @@ export declare type Alignment = 'top' | 'bottom' | 'start' | 'end' | 'center';
 export declare type AutoSize = 'height' | 'height-always' | 'width' | 'width-always' | 'always' | boolean;
 export declare type Boundary = PopperJs.Boundary | 'scrollParent' | 'window';
 export declare type PopperRefHandle = {
+    /**
+     * Updates the position of the popper imperatively.
+     * Useful when the position of the target changes from other factors than scrolling of window resize.
+     */
     updatePosition: () => void;
+    /**
+     * Sets the target and updates positioning imperatively.
+     * Useful for avoiding double renders with the target option.
+     */
+    setTarget: (target: HTMLElement) => void;
 };
 export declare type PopperVirtualElement = PopperJs.VirtualElement;
-export interface PositioningProps {
+export interface PopperOptions {
     /** Alignment for the component. Only has an effect if used with the @see position option */
     align?: Alignment;
     /** The element which will define the boundaries of the popper position for the flip behavior. */
     flipBoundary?: Boundary;
     /** The element which will define the boundaries of the popper position for the overflow behavior. */
     overflowBoundary?: Boundary;
-    /** An imperative handle to Popper methods. */
-    popperRef?: React.Ref<PopperRefHandle>;
     /**
      * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')
      * and align is also vertical ('top' | 'bottom') or if both position and align are horizontal ('before' | 'after'
@@ -31,6 +38,11 @@ export interface PositioningProps {
      * then provided value for 'align' will be ignored and 'center' will be used instead.
      */
     position?: Position;
+    /**
+     * Enables the Popper box to position itself in 'fixed' mode (default value is position: 'absolute')
+     * @default false
+     */
+    positionFixed?: boolean;
     /**
      * Lets you displace a popper element from its reference element.
      * This can be useful if you need to apply some margin between them or if you need to fine tune the
@@ -50,10 +62,6 @@ export interface PositioningProps {
      * `height-always` applies `max-height` regardless of overflow, and 'width-always' for always applying `max-width`
      */
     autoSize?: AutoSize;
-    /**
-     * Manual override for popper target. Useful for scenarios where a component accepts user prop to override target
-     */
-    target?: HTMLElement | PopperVirtualElement | null;
     /**
      * Modifies position and alignment to cover the target
      */
@@ -63,6 +71,19 @@ export interface PositioningProps {
      * `position` props, regardless of the size of the component, the reference element or the viewport.
      */
     pinned?: boolean;
+    /**
+     * When the reference element or the viewport is outside viewport allows a popper element to be fully in viewport.
+     * "all" enables this behavior for all axis.
+     */
+    unstable_disableTether?: boolean | 'all';
+}
+export interface PositioningProps extends Omit<PopperOptions, 'positionFixed' | 'unstable_disableTether'> {
+    /** An imperative handle to Popper methods. */
+    popperRef?: React.Ref<PopperRefHandle>;
+    /**
+     * Manual override for popper target. Useful for scenarios where a component accepts user prop to override target
+     */
+    target?: HTMLElement | PopperVirtualElement | null;
 }
 export declare type PositioningShorthandValue = 'above' | 'above-start' | 'above-end' | 'below' | 'below-start' | 'below-end' | 'before' | 'before-top' | 'before-bottom' | 'after' | 'after-top' | 'after-bottom';
 export declare type PositioningShorthand = PositioningProps | PositioningShorthandValue;

package/lib/usePopper.d.ts

@@ -1,23 +1,11 @@
-import * as PopperJs from '@popperjs/core';
 import * as React from 'react';
 import type { PositioningProps } from './types';
-interface PopperOptions extends PositioningProps {
+interface UsePopperOptions extends PositioningProps {
     /**
      * If false, delays Popper's creation.
      * @default true
      */
     enabled?: boolean;
-    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
-    /**
-     * Enables the Popper box to position itself in 'fixed' mode (default value is position: 'absolute')
-     * @default false
-     */
-    positionFixed?: boolean;
-    /**
-     * When the reference element or the viewport is outside viewport allows a popper element to be fully in viewport.
-     * "all" enables this behavior for all axis.
-     */
-    unstable_disableTether?: boolean | 'all';
 }
 /**
  * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
@@ -27,7 +15,7 @@ interface PopperOptions extends PositioningProps {
  * - contains a specific to React fix related to initial positioning when containers have components with managed focus
  *   to avoid focus jumps
  */
-export declare function usePopper(options?: PopperOptions): {
+export declare function usePopper(options?: UsePopperOptions): {
     targetRef: React.MutableRefObject<any>;
     containerRef: React.MutableRefObject<any>;
     arrowRef: React.MutableRefObject<any>;