@fluentui/react-positioning - npm Package Compare versions

Comparing version 9.0.0-alpha.40 to 9.0.0-alpha.41

CHANGELOG.json

@@ -5,3 +5,18 @@ {
     {
-      "date": "Fri, 06 Aug 2021 07:32:58 GMT",
+      "date": "Tue, 10 Aug 2021 07:32:53 GMT",
+      "tag": "@fluentui/react-positioning_v9.0.0-alpha.41",
+      "version": "9.0.0-alpha.41",
+      "comments": {
+        "prerelease": [
+          {
+            "comment": "cleanup types, do not export PopperOptions",
+            "author": "[e-mail]",
+            "commit": "57a2bc1f8a6ec7859bf4a3509696681d39602561",
+            "package": "@fluentui/react-positioning"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 06 Aug 2021 07:35:14 GMT",
       "tag": "@fluentui/react-positioning_v9.0.0-alpha.40",
@@ -8,0 +23,0 @@ "version": "9.0.0-alpha.40",

CHANGELOG.md

 # Change Log - @fluentui/react-positioning
 
-This log was last generated on Fri, 06 Aug 2021 07:32:58 GMT and should not be manually modified.
+This log was last generated on Tue, 10 Aug 2021 07:32:53 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## [9.0.0-alpha.41](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v9.0.0-alpha.41)
+
+Tue, 10 Aug 2021 07:32:53 GMT 
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-alpha.40..@fluentui/react-positioning_v9.0.0-alpha.41)
+
+### Changes
+
+- cleanup types, do not export PopperOptions ([PR #19230](https://github.com/microsoft/fluentui/pull/19230) by [e-mail])
+
 ## [9.0.0-alpha.40](https://github.com/microsoft/fluentui/tree/@fluentui/react-positioning_v9.0.0-alpha.40)
 
-Fri, 06 Aug 2021 07:32:58 GMT 
+Fri, 06 Aug 2021 07:35:14 GMT 
 [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-positioning_v9.0.0-alpha.39..@fluentui/react-positioning_v9.0.0-alpha.40)
@@ -11,0 +20,0 @@

dist/react-positioning.d.ts

@@ -26,3 +26,3 @@ import * as PopperJs from '@popperjs/core';
 
-export declare interface PopperOptions extends PositioningProps {
+declare interface PopperOptions extends PositioningProps {
     /**
@@ -33,6 +33,2 @@ * If false, delays Popper's creation.
     enabled?: boolean;
-    /**
-     * Array of conditions to be met in order to trigger a subsequent render to reposition the elements.
-     */
-    positioningDependencies?: React_2.DependencyList;
     onStateUpdate?: (state: Partial<PopperJs.State>) => void;
@@ -50,5 +46,3 @@ }
 export declare interface PositioningProps {
-    /**
-     * Alignment for the component.
-     */
+    /** Alignment for the component. */
     align?: Alignment;
@@ -60,3 +54,3 @@ /** The element which will define the boundaries of the popper position for the flip behavior. */
     /** An imperative handle to Popper methods. */
-    containerRef?: React_2.Ref<PopperRefHandle>;
+    popperRef?: React_2.Ref<PopperRefHandle>;
     /**
@@ -63,0 +57,0 @@ * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')

etc/react-positioning.api.md

@@ -36,10 +36,2 @@ ## API Report File for "@fluentui/react-positioning"
 // @public (undocumented)
-export interface PopperOptions extends PositioningProps {
-    enabled?: boolean;
-    // (undocumented)
-    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
-    positioningDependencies?: React_2.DependencyList;
-}
-
-// @public (undocumented)
 export type PopperRefHandle = {
@@ -60,3 +52,2 @@ updatePosition: () => void;
     autoSize?: AutoSize;
-    containerRef?: React_2.Ref<PopperRefHandle>;
     coverTarget?: boolean;
@@ -66,2 +57,3 @@ flipBoundary?: Boundary;
     overflowBoundary?: Boundary;
+    popperRef?: React_2.Ref<PopperRefHandle>;
     position?: Position;
@@ -74,2 +66,4 @@ positionFixed?: boolean;
 
+// Warning: (ae-forgotten-export) The symbol "PopperOptions" needs to be exported by the entry point index.d.ts
+//
 // @public
@@ -85,5 +79,4 @@ export function usePopper(options?: PopperOptions): {
 
-
 // (No @packageDocumentation comment for this package)
 
 ```

lib-amd/types.d.ts

@@ -19,5 +19,3 @@ import * as PopperJs from '@popperjs/core';
 export interface PositioningProps {
-    /**
-     * Alignment for the component.
-     */
+    /** Alignment for the component. */
     align?: Alignment;
@@ -29,3 +27,3 @@ /** The element which will define the boundaries of the popper position for the flip behavior. */
     /** An imperative handle to Popper methods. */
-    containerRef?: React.Ref<PopperRefHandle>;
+    popperRef?: React.Ref<PopperRefHandle>;
     /**
@@ -81,13 +79,1 @@ * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')
 }
-export interface PopperOptions extends PositioningProps {
-    /**
-     * If false, delays Popper's creation.
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Array of conditions to be met in order to trigger a subsequent render to reposition the elements.
-     */
-    positioningDependencies?: React.DependencyList;
-    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
-}

lib-amd/usePopper.d.ts

@@ -0,3 +1,12 @@
+import * as PopperJs from '@popperjs/core';
 import * as React from 'react';
-import { PopperOptions } from './types';
+import { PositioningProps } from './types';
+interface PopperOptions extends PositioningProps {
+    /**
+     * If false, delays Popper's creation.
+     * @default true
+     */
+    enabled?: boolean;
+    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
+}
 /**
@@ -16,1 +25,2 @@ * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
 };
+export {};

lib-amd/usePopper.js

@@ -291,3 +291,3 @@ define(["require", "exports", "@fluentui/react-utilities", "@fluentui/react-shared-contexts", "./utils/index", "@popperjs/core", "react"], function (require, exports, react_utilities_1, react_shared_contexts_1, index_1, PopperJs, React) {
         var arrowRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
-        React.useImperativeHandle(options.containerRef, function () { return ({
+        React.useImperativeHandle(options.popperRef, function () { return ({
             updatePosition: function () {
@@ -294,0 +294,0 @@ var _a;

lib-commonjs/types.d.ts

@@ -19,5 +19,3 @@ import * as PopperJs from '@popperjs/core';
 export interface PositioningProps {
-    /**
-     * Alignment for the component.
-     */
+    /** Alignment for the component. */
     align?: Alignment;
@@ -29,3 +27,3 @@ /** The element which will define the boundaries of the popper position for the flip behavior. */
     /** An imperative handle to Popper methods. */
-    containerRef?: React.Ref<PopperRefHandle>;
+    popperRef?: React.Ref<PopperRefHandle>;
     /**
@@ -81,13 +79,1 @@ * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')
 }
-export interface PopperOptions extends PositioningProps {
-    /**
-     * If false, delays Popper's creation.
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Array of conditions to be met in order to trigger a subsequent render to reposition the elements.
-     */
-    positioningDependencies?: React.DependencyList;
-    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
-}

lib-commonjs/usePopper.d.ts

@@ -0,3 +1,12 @@
+import * as PopperJs from '@popperjs/core';
 import * as React from 'react';
-import { PopperOptions } from './types';
+import { PositioningProps } from './types';
+interface PopperOptions extends PositioningProps {
+    /**
+     * If false, delays Popper's creation.
+     * @default true
+     */
+    enabled?: boolean;
+    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
+}
 /**
@@ -16,1 +25,2 @@ * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
 };
+export {};

lib-commonjs/usePopper.js

@@ -295,3 +295,3 @@ "use strict";
     var arrowRef = index_1.useCallbackRef(null, handlePopperUpdate, true);
-    React.useImperativeHandle(options.containerRef, function () { return ({
+    React.useImperativeHandle(options.popperRef, function () { return ({
         updatePosition: function () {
@@ -298,0 +298,0 @@ var _a;

lib/types.d.ts

@@ -19,5 +19,3 @@ import * as PopperJs from '@popperjs/core';
 export interface PositioningProps {
-    /**
-     * Alignment for the component.
-     */
+    /** Alignment for the component. */
     align?: Alignment;
@@ -29,3 +27,3 @@ /** The element which will define the boundaries of the popper position for the flip behavior. */
     /** An imperative handle to Popper methods. */
-    containerRef?: React.Ref<PopperRefHandle>;
+    popperRef?: React.Ref<PopperRefHandle>;
     /**
@@ -81,13 +79,1 @@ * Position for the component. Position has higher priority than align. If position is vertical ('above' | 'below')
 }
-export interface PopperOptions extends PositioningProps {
-    /**
-     * If false, delays Popper's creation.
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Array of conditions to be met in order to trigger a subsequent render to reposition the elements.
-     */
-    positioningDependencies?: React.DependencyList;
-    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
-}

lib/usePopper.d.ts

@@ -0,3 +1,12 @@
+import * as PopperJs from '@popperjs/core';
 import * as React from 'react';
-import { PopperOptions } from './types';
+import { PositioningProps } from './types';
+interface PopperOptions extends PositioningProps {
+    /**
+     * If false, delays Popper's creation.
+     * @default true
+     */
+    enabled?: boolean;
+    onStateUpdate?: (state: Partial<PopperJs.State>) => void;
+}
 /**
@@ -16,1 +25,2 @@ * Exposes Popper positioning API via React hook. Contains few important differences between an official "react-popper"
 };
+export {};

lib/usePopper.js

@@ -292,3 +292,3 @@ import { useEventCallback, useIsomorphicLayoutEffect, useFirstMount, canUseDOM } from '@fluentui/react-utilities';
     var arrowRef = useCallbackRef(null, handlePopperUpdate, true);
-    React.useImperativeHandle(options.containerRef, function () { return ({
+    React.useImperativeHandle(options.popperRef, function () { return ({
         updatePosition: function () {
@@ -295,0 +295,0 @@ var _a;

package.json

 {
   "name": "@fluentui/react-positioning",
-  "version": "9.0.0-alpha.40",
+  "version": "9.0.0-alpha.41",
   "description": "A react wrapper around Popper.js for Fluent UI",
@@ -5,0 +5,0 @@ "main": "lib-commonjs/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1016518

decreased by-0.04%

Lines of code

5831

decreased by-0.05%

No dependency changes