@fluentui/react-utilities 9.0.0-alpha.55 → 9.0.0-alpha.56

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "@fluentui/react-utilities",
   "entries": [
     {
-      "date": "Fri, 01 Oct 2021 14:11:48 GMT",
+      "date": "Tue, 05 Oct 2021 09:26:55 GMT",
+      "tag": "@fluentui/react-utilities_v9.0.0-alpha.56",
+      "version": "9.0.0-alpha.56",
+      "comments": {
+        "prerelease": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "@fluentui/react-utilities",
+            "comment": "Add and use ForwardRefComponent helper type",
+            "commit": "3b16677a03035dcf03c1297268b85c6d4bd3f839"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 01 Oct 2021 14:13:08 GMT",
       "tag": "@fluentui/react-utilities_v9.0.0-alpha.55",
       "version": "9.0.0-alpha.55",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,21 @@
 # Change Log - @fluentui/react-utilities
 
-This log was last generated on Fri, 01 Oct 2021 14:11:48 GMT and should not be manually modified.
+This log was last generated on Tue, 05 Oct 2021 09:26:55 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## [9.0.0-alpha.56](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v9.0.0-alpha.56)
+
+Tue, 05 Oct 2021 09:26:55 GMT 
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.0.0-alpha.55..@fluentui/react-utilities_v9.0.0-alpha.56)
+
+### Changes
+
+- Add and use ForwardRefComponent helper type ([PR #20081](https://github.com/microsoft/fluentui/pull/20081) by elcraig@microsoft.com)
+
 ## [9.0.0-alpha.55](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v9.0.0-alpha.55)
 
-Fri, 01 Oct 2021 14:11:48 GMT 
+Fri, 01 Oct 2021 14:13:08 GMT 
 [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.0.0-alpha.53..@fluentui/react-utilities_v9.0.0-alpha.55)
 
 ### Changes

package/dist/react-utilities.d.ts

@@ -141,6 +141,11 @@ export declare const divProperties: Record<string, number>;
  */
 export declare const formProperties: Record<string, number>;
 
+/**
+ * Return type for `React.forwardRef`, including inference of the proper typing for the ref.
+ */
+export declare type ForwardRefComponent<Props> = ObscureEventName extends keyof Props ? Required<Props>[ObscureEventName] extends React_2.PointerEventHandler<infer Element> ? React_2.ForwardRefExoticComponent<Props & React_2.RefAttributes<Element>> : never : never;
+
 declare type GenericDictionary = Record<string, any>;
 
 declare type GenericDictionary_2 = Record<string, any>;
@@ -343,6 +348,20 @@ export declare type ObjectShorthandPropsCompat<TProps extends ComponentPropsComp
 
 export declare type ObjectShorthandPropsRecord = Record<string, DefaultObjectShorthandProps | undefined>;
 
+/**
+ * This is part of a hack to infer the element type from a native element *props* type.
+ * The only place the original element is found in a native props type (at least that's workable
+ * for inference) is in the event handlers, so some of the helper types use this event handler
+ * name to infer the original element type.
+ *
+ * Notes:
+ * - Using an extremely obscure event handler reduces the likelihood that its signature will be
+ *   modified in any component's props.
+ * - Inferring based on a single prop name instead of a larger type like `DOMAttributes<T>` should be
+ *   less expensive for typescript to evaluate and is less likely to result in type expansion in .d.ts.
+ */
+declare type ObscureEventName = 'onLostPointerCaptureCapture';
+
 /**
  * An array of OL tag properties and events.
  *

package/lib/compose/types.d.ts

@@ -84,6 +84,23 @@ export declare type ComponentState<Shorthands extends ObjectShorthandPropsRecord
         [Key in keyof Shorthands]-?: React.ComponentType<NonNullable<Shorthands[Key]> extends ObjectShorthandProps<infer P> ? P : NonNullable<Shorthands[Key]>> | (NonNullable<Shorthands[Key]> extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
     };
 } & Shorthands;
+/**
+ * This is part of a hack to infer the element type from a native element *props* type.
+ * The only place the original element is found in a native props type (at least that's workable
+ * for inference) is in the event handlers, so some of the helper types use this event handler
+ * name to infer the original element type.
+ *
+ * Notes:
+ * - Using an extremely obscure event handler reduces the likelihood that its signature will be
+ *   modified in any component's props.
+ * - Inferring based on a single prop name instead of a larger type like `DOMAttributes<T>` should be
+ *   less expensive for typescript to evaluate and is less likely to result in type expansion in .d.ts.
+ */
+declare type ObscureEventName = 'onLostPointerCaptureCapture';
+/**
+ * Return type for `React.forwardRef`, including inference of the proper typing for the ref.
+ */
+export declare type ForwardRefComponent<Props> = ObscureEventName extends keyof Props ? Required<Props>[ObscureEventName] extends React.PointerEventHandler<infer Element> ? React.ForwardRefExoticComponent<Props & React.RefAttributes<Element>> : never : never;
 export declare type ComponentPropsCompat = {
     as?: React.ElementType;
     className?: string;
@@ -125,3 +142,4 @@ export declare type RequiredPropsCompat<T, K extends keyof T> = Omit<T, K> & {
  * @template DefaultedPropNames - The keys of Props that will always have a default value provided
  */
 export declare type ComponentStateCompat<Props, ShorthandPropNames extends keyof Props = never, DefaultedPropNames extends keyof ResolvedShorthandPropsCompat<Props, ShorthandPropNames> = never> = RequiredPropsCompat<ResolvedShorthandPropsCompat<Props, ShorthandPropNames>, DefaultedPropNames>;
+export {};

package/lib-commonjs/compose/types.d.ts

@@ -84,6 +84,23 @@ export declare type ComponentState<Shorthands extends ObjectShorthandPropsRecord
         [Key in keyof Shorthands]-?: React.ComponentType<NonNullable<Shorthands[Key]> extends ObjectShorthandProps<infer P> ? P : NonNullable<Shorthands[Key]>> | (NonNullable<Shorthands[Key]> extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
     };
 } & Shorthands;
+/**
+ * This is part of a hack to infer the element type from a native element *props* type.
+ * The only place the original element is found in a native props type (at least that's workable
+ * for inference) is in the event handlers, so some of the helper types use this event handler
+ * name to infer the original element type.
+ *
+ * Notes:
+ * - Using an extremely obscure event handler reduces the likelihood that its signature will be
+ *   modified in any component's props.
+ * - Inferring based on a single prop name instead of a larger type like `DOMAttributes<T>` should be
+ *   less expensive for typescript to evaluate and is less likely to result in type expansion in .d.ts.
+ */
+declare type ObscureEventName = 'onLostPointerCaptureCapture';
+/**
+ * Return type for `React.forwardRef`, including inference of the proper typing for the ref.
+ */
+export declare type ForwardRefComponent<Props> = ObscureEventName extends keyof Props ? Required<Props>[ObscureEventName] extends React.PointerEventHandler<infer Element> ? React.ForwardRefExoticComponent<Props & React.RefAttributes<Element>> : never : never;
 export declare type ComponentPropsCompat = {
     as?: React.ElementType;
     className?: string;
@@ -125,3 +142,4 @@ export declare type RequiredPropsCompat<T, K extends keyof T> = Omit<T, K> & {
  * @template DefaultedPropNames - The keys of Props that will always have a default value provided
  */
 export declare type ComponentStateCompat<Props, ShorthandPropNames extends keyof Props = never, DefaultedPropNames extends keyof ResolvedShorthandPropsCompat<Props, ShorthandPropNames> = never> = RequiredPropsCompat<ResolvedShorthandPropsCompat<Props, ShorthandPropNames>, DefaultedPropNames>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluentui/react-utilities",
-  "version": "9.0.0-alpha.55",
+  "version": "9.0.0-alpha.56",
   "description": "A set of general React-specific utilities.",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",