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

package/lib-commonjs/types.d.ts

@@ -1,89 +0,0 @@
-import * as PopperJs from '@popperjs/core';
-import * as React from 'react';
-export declare type OffsetFunctionParam = {
-    popper: PopperJs.Rect;
-    reference: PopperJs.Rect;
-    placement: PopperJs.Placement;
-};
-export declare type OffsetFunction = (param: OffsetFunctionParam) => [number | null | undefined, number | null | undefined];
-export declare type Offset = OffsetFunction | [number | null | undefined, number | null | undefined];
-export declare type Position = 'above' | 'below' | 'before' | 'after';
-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 | PopperVirtualElement) => void;
-};
-export declare type PopperVirtualElement = PopperJs.VirtualElement;
-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;
-    /**
-     * 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'
-     * and 'start' | 'end' respectively),
-     * 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
-     * position according to some custom logic.
-     */
-    offset?: Offset;
-    /**
-     * Defines padding between the corner of the popup element and the arrow.
-     * Use to prevent the arrow from overlapping a rounded corner, for example.
-     */
-    arrowPadding?: number;
-    /**
-     * Applies max-height and max-width on popper to fit it within the available space in viewport.
-     * true enables this for both width and height when overflow happens.
-     * 'always' applies `max-height`/`max-width` regardless of overflow.
-     * 'height' applies `max-height` when overflow happens, and 'width' for `max-width`
-     * `height-always` applies `max-height` regardless of overflow, and 'width-always' for always applying `max-width`
-     */
-    autoSize?: AutoSize;
-    /**
-     * Modifies position and alignment to cover the target
-     */
-    coverTarget?: boolean;
-    /**
-     * Disables automatic repositioning of the component; it will always be placed according to the values of `align` and
-     * `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-commonjs/usePopper.d.ts

@@ -1,23 +0,0 @@
-import * as React from 'react';
-import type { PositioningProps } from './types';
-interface UsePopperOptions extends PositioningProps {
-    /**
-     * If false, delays Popper's creation.
-     * @default true
-     */
-    enabled?: boolean;
-}
-/**
- * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
- * package:
- * - style attributes are applied directly on DOM to avoid re-renders
- * - refs changes and resolution is handled properly without re-renders
- * - 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?: UsePopperOptions): {
-    targetRef: React.MutableRefObject<any>;
-    containerRef: React.MutableRefObject<any>;
-    arrowRef: React.MutableRefObject<any>;
-};
-export {};

package/lib-commonjs/usePopperMouseTarget.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-import * as PopperJs from '@popperjs/core';
-/**
- * A state hook that manages a popper virtual element from mouseevents.
- * Useful for scenarios where a component needs to be positioned by mouse click (e.g. contextmenu)
- * React synthetic events are not persisted by this hook
- *
- * @param initialState - initializes a user provided state similare to useState
- * @returns state and dispatcher for a Popper virtual element that uses native/synthetic mouse events
- */
-export declare const usePopperMouseTarget: (initialState?: PopperJs.VirtualElement | (() => PopperJs.VirtualElement) | undefined) => readonly [PopperJs.VirtualElement | undefined, (event: React.MouseEvent | MouseEvent | undefined | null) => void];

package/lib-commonjs/utils/getBasePlacement.d.ts

@@ -1,8 +0,0 @@
-import * as PopperJs from '@popperjs/core';
-/**
- * Returns the base placement value
- * @param placement - the popper placement (i.e. bottom-start)
- *
- * @returns bottom-start -> bottom
- */
-export declare function getBasePlacement(placement: PopperJs.Placement): PopperJs.BasePlacement;

package/lib-commonjs/utils/getBoundary.d.ts

@@ -1,6 +0,0 @@
-import * as PopperJs from '@popperjs/core';
-import type { Boundary } from '../types';
-/**
- * Allows to mimic a behavior from V1 of Popper and accept `window` and `scrollParent` as strings.
- */
-export declare function getBoundary(element: HTMLElement | null, boundary?: Boundary): PopperJs.Boundary | undefined;

package/lib-commonjs/utils/getReactFiberFromNode.d.ts

@@ -1,108 +0,0 @@
-import * as React from 'react';
-declare type ReactEventResponder<E, C> = {
-    $$typeof: Symbol | number;
-    displayName: string;
-    targetEventTypes: null | string[];
-    rootEventTypes: null | string[];
-    getInitialState: null | ((props: Object) => Object);
-    onEvent: null | ((event: E, context: C, props: Object, state: Object) => void);
-    onRootEvent: null | ((event: E, context: C, props: Object, state: Object) => void);
-    onMount: null | ((context: C, props: Object, state: Object) => void);
-    onUnmount: null | ((context: C, props: Object, state: Object) => void);
-};
-declare type ReactEventResponderInstance<E, C> = {
-    fiber: Object;
-    props: Object;
-    responder: ReactEventResponder<E, C>;
-    rootEventTypes: null | Set<string>;
-    state: Object;
-};
-export declare type HookType = 'useState' | 'useReducer' | 'useContext' | 'useRef' | 'useEffect' | 'useLayoutEffect' | 'useCallback' | 'useMemo' | 'useImperativeHandle' | 'useDebugValue' | 'useResponder';
-declare type ReactProviderType<T> = {
-    $$typeof: Symbol | number;
-    _context: ReactContext<T>;
-};
-declare type ReactContext<T> = {
-    $$typeof: Symbol | number;
-    Consumer: ReactContext<T>;
-    Provider: ReactProviderType<T>;
-    _calculateChangedBits: ((a: T, b: T) => number) | null;
-    _currentValue: T;
-    _currentValue2: T;
-    _threadCount: number;
-    _currentRenderer?: Object | null;
-    _currentRenderer2?: Object | null;
-};
-declare type ContextDependency<T> = {
-    context: ReactContext<T>;
-    observedBits: number;
-    next: ContextDependency<any> | null;
-};
-declare enum WorkTag {
-    FunctionComponent = 0,
-    ClassComponent = 1,
-    IndeterminateComponent = 2,
-    HostRoot = 3,
-    HostPortal = 4,
-    HostComponent = 5,
-    HostText = 6,
-    Fragment = 7,
-    Mode = 8,
-    ContextConsumer = 9,
-    ContextProvider = 10,
-    ForwardRef = 11,
-    Profiler = 12,
-    SuspenseComponent = 13,
-    MemoComponent = 14,
-    SimpleMemoComponent = 15,
-    LazyComponent = 16,
-    IncompleteClassComponent = 17,
-    DehydratedFragment = 18,
-    SuspenseListComponent = 19,
-    FundamentalComponent = 20,
-    ScopeComponent = 21
-}
-declare type Source = {
-    fileName: string;
-    lineNumber: number;
-};
-declare type ExpirationTime = number;
-declare type Dependencies = {
-    expirationTime: ExpirationTime;
-    firstContext: ContextDependency<any> | null;
-    responders: Map<ReactEventResponder<any, any>, ReactEventResponderInstance<any, any>> | null;
-};
-export declare type Fiber = {
-    tag: WorkTag;
-    key: null | string;
-    elementType: any;
-    type: any;
-    stateNode: any;
-    return: Fiber | null;
-    child: Fiber | null;
-    sibling: Fiber | null;
-    index: number;
-    ref: React.Ref<any>;
-    pendingProps: any;
-    memoizedProps: any;
-    memoizedState: any;
-    dependencies: Dependencies | null;
-    nextEffect: Fiber | null;
-    firstEffect: Fiber | null;
-    lastEffect: Fiber | null;
-    expirationTime: ExpirationTime;
-    childExpirationTime: ExpirationTime;
-    alternate: Fiber | null;
-    actualDuration?: number;
-    actualStartTime?: number;
-    selfBaseDuration?: number;
-    treeBaseDuration?: number;
-    _debugID?: number;
-    _debugSource?: Source | null;
-    _debugOwner?: Fiber | null;
-    _debugIsCurrentlyTiming?: boolean;
-    _debugNeedsRemount?: boolean;
-    _debugHookTypes?: HookType[] | null;
-};
-export declare function getReactFiberFromNode(elm: Node | undefined): Fiber | null;
-export {};

package/lib-commonjs/utils/getScrollParent.d.ts

@@ -1,12 +0,0 @@
-/**
- * Returns the parent node or the host of the node argument.
- * @param node - DOM node.
- * @returns - parent DOM node.
- */
-export declare const getParentNode: (node: HTMLElement) => HTMLElement;
-/**
- * Returns the first scrollable parent of the given element.
- * @param node - DOM node.
- * @returns - the first scrollable parent.
- */
-export declare const getScrollParent: (node: Document | HTMLElement | null) => HTMLElement;

package/lib-commonjs/utils/index.d.ts

@@ -1,8 +0,0 @@
-export * from './getBasePlacement';
-export * from './getBoundary';
-export * from './getReactFiberFromNode';
-export * from './getScrollParent';
-export * from './mergeArrowOffset';
-export * from './positioningHelper';
-export * from './resolvePositioningShorthand';
-export * from './useCallbackRef';

package/lib-commonjs/utils/mergeArrowOffset.d.ts

@@ -1,10 +0,0 @@
-import type { Offset } from '../types';
-/**
- * Generally when adding an arrow to popper, it's necessary to offset the position of the popper by the
- * height of the arrow. A simple utility to merge a provided offset with an arrow height to return the final offset
- *
- * @param userOffset - The offset provided by the user
- * @param arrowHeight - The height of the arrow in px
- * @returns User offset augmented with arrow height
- */
-export declare function mergeArrowOffset(userOffset: Offset | undefined | null, arrowHeight: number): Offset;

package/lib-commonjs/utils/positioningHelper.d.ts

@@ -1,7 +0,0 @@
-import * as PopperJs from '@popperjs/core';
-import type { Alignment, Offset, Position } from '../types';
-/**
- * @see positioninHelper.test.ts for expected placement values
- */
-export declare const getPlacement: (align?: Alignment | undefined, position?: Position | undefined, rtl?: boolean | undefined) => PopperJs.Placement;
-export declare const applyRtlToOffset: (offset: Offset | undefined) => Offset | undefined;

package/lib-commonjs/utils/resolvePositioningShorthand.d.ts

@@ -1,2 +0,0 @@
-import type { PositioningShorthand, PositioningProps } from '../types';
-export declare function resolvePositioningShorthand(shorthand: PositioningShorthand | undefined | null): Readonly<PositioningProps>;

package/lib-commonjs/utils/useCallbackRef.d.ts

@@ -1,19 +0,0 @@
-import * as React from 'react';
-/**
- * Creates a MutableRef with ref change callback. Is useful as React.useRef() doesn't notify you when its content
- * changes and mutating the .current property doesn't cause a re-render. An opt-out will be use a callback ref via
- * React.useState(), but it will cause re-renders always.
- *
- * https://reactjs.org/docs/hooks-reference.html#useref
- * https://github.com/theKashey/use-callback-ref#usecallbackref---to-replace-reactuseref
- *
- * @param initialValue - initial ref value
- * @param callback - a callback to run when value changes
- * @param skipInitialResolve - a flag to skip an initial ref report
- *
- * @example
- * const ref = useCallbackRef(0, (newValue, oldValue) => console.log(oldValue, '->', newValue);
- * ref.current = 1;
- * // prints 0 -> 1
- */
-export declare function useCallbackRef<T>(initialValue: T | null, callback: (newValue: T | null, lastValue: T | null) => void, skipInitialResolve?: boolean): React.MutableRefObject<T | null>;