@fluentui/react-utilities 0.0.0-nightlya9c3d10d9520220113.1 → 0.0.0-nightlyb8663b78ad20220207.1

package/lib-commonjs/utils/getReactCallbackName.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getReactCallbackName = void 0;
+/**
+ * React.SyntheticEvent contains name of a callback that should be fired, this function returns it.
+ *
+ * Ideally, it should also distinguish regular and "capture" callbacks, but it's possible only with React 17 as
+ * ".eventPhase" there has proper value, see https://github.com/facebook/react/pull/19244. In React 16 all events
+ * are handled in bubble phase.
+ */
+
+function getReactCallbackName(event) {
+  if (event._reactName) {
+    return event._reactName;
+  }
+
+  if (event.dispatchConfig) {
+    if (event.dispatchConfig.registrationName) {
+      return event.dispatchConfig.registrationName;
+    }
+
+    return event.dispatchConfig.phasedRegistrationNames.bubbled;
+  }
+
+  if (process.env.NODE_ENV !== 'production') {
+    // eslint-disable-next-line no-console
+    console.error(['Passed React.SyntheticEvent does not contain ".dispatchConfig" or "._reactName".', 'This should not happen, please report it to https://github.com/microsoft/fluentui']);
+  }
+}
+
+exports.getReactCallbackName = getReactCallbackName;
+//# sourceMappingURL=getReactCallbackName.js.map

package/lib-commonjs/utils/getReactCallbackName.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/getReactCallbackName.ts"],"names":[],"mappings":";;;;;;AAwBA;;;;;;AAMG;;AACH,SAAgB,oBAAhB,CAAqC,KAArC,EAA+D;AAC7D,MAAI,KAAK,CAAC,UAAV,EAAsB;AACpB,WAAO,KAAK,CAAC,UAAb;AACD;;AAED,MAAI,KAAK,CAAC,cAAV,EAA0B;AACxB,QAAI,KAAK,CAAC,cAAN,CAAqB,gBAAzB,EAA2C;AACzC,aAAO,KAAK,CAAC,cAAN,CAAqB,gBAA5B;AACD;;AAED,WAAO,KAAK,CAAC,cAAN,CAAqB,uBAArB,CAA6C,OAApD;AACD;;AAED,MAAI,OAAO,CAAC,GAAR,CAAY,QAAZ,KAAyB,YAA7B,EAA2C;AACzC;AACA,IAAA,OAAO,CAAC,KAAR,CAAc,CACZ,kFADY,EAEZ,mFAFY,CAAd;AAID;AACF;;AApBD,OAAA,CAAA,oBAAA,GAAA,oBAAA","sourceRoot":""}

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

@@ -0,0 +1,22 @@
+import * as React from 'react';
+/**
+ * Gets the trigger element of a FluentTriggerComponent (such as Tooltip or MenuTrigger).
+ *
+ * In the case where the immediate child is itself a FluentTriggerComponent and/or React Fragment,
+ * it returns the first descendant that is _not_ a FluentTriggerComponent or Fragment.
+ * This allows multiple triggers to be stacked, and still apply their props to the actual trigger element.
+ *
+ * For example, the following returns `<div id="child" />`:
+ * ```jsx
+ * getTriggerChild(
+ *   <Tooltip>
+ *     <MenuTrigger>
+ *       <div id="child" />
+ *     </MenuTrigger>
+ *   </Tooltip>
+ * );
+ * ```
+ */
+export declare const getTriggerChild: (children: React.ReactNode) => React.ReactElement & {
+    ref?: React.Ref<unknown>;
+};

package/lib-commonjs/utils/getTriggerChild.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTriggerChild = void 0;
+
+const React = /*#__PURE__*/require("react");
+
+const isFluentTrigger_1 = /*#__PURE__*/require("./isFluentTrigger");
+/**
+ * Gets the trigger element of a FluentTriggerComponent (such as Tooltip or MenuTrigger).
+ *
+ * In the case where the immediate child is itself a FluentTriggerComponent and/or React Fragment,
+ * it returns the first descendant that is _not_ a FluentTriggerComponent or Fragment.
+ * This allows multiple triggers to be stacked, and still apply their props to the actual trigger element.
+ *
+ * For example, the following returns `<div id="child" />`:
+ * ```jsx
+ * getTriggerChild(
+ *   <Tooltip>
+ *     <MenuTrigger>
+ *       <div id="child" />
+ *     </MenuTrigger>
+ *   </Tooltip>
+ * );
+ * ```
+ */
+
+
+const getTriggerChild = children => {
+  const child = React.Children.only(children);
+  return isFluentTrigger_1.isFluentTrigger(child) ? exports.getTriggerChild(child.props.children) : child;
+};
+
+exports.getTriggerChild = getTriggerChild;
+//# sourceMappingURL=getTriggerChild.js.map

package/lib-commonjs/utils/getTriggerChild.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/getTriggerChild.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;;AACA,MAAA,iBAAA,gBAAA,OAAA,CAAA,mBAAA,CAAA;AAEA;;;;;;;;;;;;;;;;;AAiBG;;;AACI,MAAM,eAAe,GAAI,QAAD,IAAiF;AAC9G,QAAM,KAAK,GAAG,KAAK,CAAC,QAAN,CAAe,IAAf,CAAoB,QAApB,CAAd;AACA,SAAO,iBAAA,CAAA,eAAA,CAAgB,KAAhB,IAAyB,OAAA,CAAA,eAAA,CAAgB,KAAK,CAAC,KAAN,CAAY,QAA5B,CAAzB,GAAiE,KAAxE;AACD,CAHM;;AAAM,OAAA,CAAA,eAAA,GAAe,eAAf","sourceRoot":""}

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

@@ -2,7 +2,8 @@ export * from './applyTriggerPropsToChildren';
 export * from './clamp';
 export * from './getNativeElementProps';
 export * from './getRTLSafeKey';
+export * from './getTriggerChild';
+export * from './isFluentTrigger';
 export * from './omit';
-export * from './onlyChild';
 export * from './properties';
 export * from './shouldPreventDefaultOnKeyDown';

package/lib-commonjs/utils/index.js

@@ -14,9 +14,11 @@ tslib_1.__exportStar(require("./getNativeElementProps"), exports);
 
 tslib_1.__exportStar(require("./getRTLSafeKey"), exports);
 
-tslib_1.__exportStar(require("./omit"), exports);
+tslib_1.__exportStar(require("./getTriggerChild"), exports);
+
+tslib_1.__exportStar(require("./isFluentTrigger"), exports);
 
-tslib_1.__exportStar(require("./onlyChild"), exports);
+tslib_1.__exportStar(require("./omit"), exports);
 
 tslib_1.__exportStar(require("./properties"), exports);
 

package/lib-commonjs/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,+BAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,SAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,yBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,iBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,QAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,aAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,cAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,iCAAA,CAAA,EAAA,OAAA","sourceRoot":""}
+{"version":3,"sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;AAAA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,+BAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,SAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,yBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,iBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,mBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,mBAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,QAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,cAAA,CAAA,EAAA,OAAA;;AACA,OAAA,CAAA,YAAA,CAAA,OAAA,CAAA,iCAAA,CAAA,EAAA,OAAA","sourceRoot":""}

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

@@ -0,0 +1,22 @@
+import * as React from 'react';
+/**
+ * Allows a component to be tagged as a FluentUI trigger component.
+ *
+ * Triggers are special-case components: they attach event listeners and other props on their child,
+ * and use them to trigger another component to show. Examples include `MenuTrigger` and `Tooltip`.
+ *
+ * A component can be tagged as a trigger as follows:
+ * ```ts
+ * const MyComponent: React.FC<MyComponentProps> & FluentTriggerComponent = ...;
+ *
+ * MyComponent.isFluentTriggerComponent = true; // MUST also set this to true
+ * ```
+ */
+export declare type FluentTriggerComponent = {
+    isFluentTriggerComponent?: boolean;
+};
+/**
+ * Checks if a given element is a FluentUI trigger (e.g. `MenuTrigger` or `Tooltip`).
+ * See the {@link FluentTriggerComponent} type for more info.
+ */
+export declare const isFluentTrigger: (element: React.ReactElement) => boolean | undefined;

package/lib-commonjs/utils/isFluentTrigger.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isFluentTrigger = void 0;
+/**
+ * Checks if a given element is a FluentUI trigger (e.g. `MenuTrigger` or `Tooltip`).
+ * See the {@link FluentTriggerComponent} type for more info.
+ */
+
+const isFluentTrigger = element => {
+  return element.type.isFluentTriggerComponent;
+};
+
+exports.isFluentTrigger = isFluentTrigger;
+//# sourceMappingURL=isFluentTrigger.js.map

package/lib-commonjs/utils/isFluentTrigger.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/isFluentTrigger.ts"],"names":[],"mappings":";;;;;;AAmBA;;;AAGG;;AACI,MAAM,eAAe,GAAI,OAAD,IAAgC;AAC7D,SAAQ,OAAO,CAAC,IAAR,CAAwC,wBAAhD;AACD,CAFM;;AAAM,OAAA,CAAA,eAAA,GAAe,eAAf","sourceRoot":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluentui/react-utilities",
-  "version": "0.0.0-nightlya9c3d10d9520220113.1",
+  "version": "0.0.0-nightlyb8663b78ad20220207.1",
   "description": "A set of general React-specific utilities.",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",
@@ -18,7 +18,7 @@
     "code-style": "just-scripts code-style",
     "just": "just-scripts",
     "lint": "just-scripts lint",
-    "test": "jest",
+    "test": "jest --passWithNoTests",
     "docs": "api-extractor run --config=config/api-extractor.local.json --local",
     "build:local": "tsc -p ./tsconfig.lib.json --module esnext --emitDeclarationOnly && node ../../scripts/typescript/normalize-import --output ./dist/packages/react-utilities/src && yarn docs",
     "start": "yarn storybook",
@@ -33,7 +33,7 @@
     "react-test-renderer": "^16.3.0"
   },
   "dependencies": {
-    "@fluentui/keyboard-keys": "0.0.0-nightlya9c3d10d9520220113.1",
+    "@fluentui/keyboard-keys": "0.0.0-nightlyb8663b78ad20220207.1",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {

package/lib/utils/onlyChild.d.ts

@@ -1,5 +0,0 @@
-import * as React from 'react';
-/**
- * Similar to React.Children.only, but drills into fragments rather than treating them as a single child
- */
-export declare const onlyChild: <P>(child: boolean | React.ReactText | React.ReactFragment | React.ReactPortal | React.ReactElement<P, string | React.JSXElementConstructor<any>> | null | undefined) => React.ReactElement<P, string | React.JSXElementConstructor<any>>;

package/lib/utils/onlyChild.js

@@ -1,13 +0,0 @@
-import * as React from 'react';
-/**
- * Similar to React.Children.only, but drills into fragments rather than treating them as a single child
- */
-
-export const onlyChild = child => {
-  if (! /*#__PURE__*/React.isValidElement(child)) {
-    throw new Error(`Component's child must be a single element`);
-  }
-
-  return child.type === React.Fragment ? onlyChild(child.props.children) : child;
-};
-//# sourceMappingURL=onlyChild.js.map

package/lib/utils/onlyChild.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/onlyChild.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AAEA;;AAEG;;AACH,OAAO,MAAM,SAAS,GACpB,KADuB,IAEE;AACzB,MAAI,eAAC,KAAK,CAAC,cAAN,CAAqB,KAArB,CAAL,EAAkC;AAChC,UAAM,IAAI,KAAJ,CAAU,4CAAV,CAAN;AACD;;AAED,SAAO,KAAK,CAAC,IAAN,KAAe,KAAK,CAAC,QAArB,GAAgC,SAAS,CAAC,KAAK,CAAC,KAAN,CAAY,QAAb,CAAzC,GAAkE,KAAzE;AACD,CARM","sourceRoot":""}

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

@@ -1,5 +0,0 @@
-import * as React from 'react';
-/**
- * Similar to React.Children.only, but drills into fragments rather than treating them as a single child
- */
-export declare const onlyChild: <P>(child: boolean | React.ReactText | React.ReactFragment | React.ReactPortal | React.ReactElement<P, string | React.JSXElementConstructor<any>> | null | undefined) => React.ReactElement<P, string | React.JSXElementConstructor<any>>;

package/lib-commonjs/utils/onlyChild.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.onlyChild = void 0;
-
-const React = /*#__PURE__*/require("react");
-/**
- * Similar to React.Children.only, but drills into fragments rather than treating them as a single child
- */
-
-
-const onlyChild = child => {
-  if (!React.isValidElement(child)) {
-    throw new Error(`Component's child must be a single element`);
-  }
-
-  return child.type === React.Fragment ? exports.onlyChild(child.props.children) : child;
-};
-
-exports.onlyChild = onlyChild;
-//# sourceMappingURL=onlyChild.js.map

package/lib-commonjs/utils/onlyChild.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/onlyChild.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;AAEA;;AAEG;;;AACI,MAAM,SAAS,GACpB,KADuB,IAEE;AACzB,MAAI,CAAC,KAAK,CAAC,cAAN,CAAqB,KAArB,CAAL,EAAkC;AAChC,UAAM,IAAI,KAAJ,CAAU,4CAAV,CAAN;AACD;;AAED,SAAO,KAAK,CAAC,IAAN,KAAe,KAAK,CAAC,QAArB,GAAgC,OAAA,CAAA,SAAA,CAAU,KAAK,CAAC,KAAN,CAAY,QAAtB,CAAhC,GAAkE,KAAzE;AACD,CARM;;AAAM,OAAA,CAAA,SAAA,GAAS,SAAT","sourceRoot":""}