@fluentui/react-utilities 0.0.0-nightlyf8be6a7c6520220106.1 → 0.0.0-nightlyff78d1e27a20220217.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/CHANGELOG.json +93 -6
  2. package/CHANGELOG.md +25 -6
  3. package/dist/react-utilities.d.ts +193 -78
  4. package/lib/compose/getSlots.d.ts +7 -8
  5. package/lib/compose/getSlots.js +3 -4
  6. package/lib/compose/getSlots.js.map +1 -1
  7. package/lib/compose/index.d.ts +0 -1
  8. package/lib/compose/index.js +0 -1
  9. package/lib/compose/index.js.map +1 -1
  10. package/lib/compose/resolveShorthand.d.ts +10 -6
  11. package/lib/compose/resolveShorthand.js +5 -5
  12. package/lib/compose/resolveShorthand.js.map +1 -1
  13. package/lib/compose/types.d.ts +86 -34
  14. package/lib/compose/types.js.map +1 -1
  15. package/lib/hooks/index.d.ts +1 -0
  16. package/lib/hooks/index.js +1 -0
  17. package/lib/hooks/index.js.map +1 -1
  18. package/lib/hooks/useBoolean.js.map +1 -1
  19. package/lib/hooks/useConst.js.map +1 -1
  20. package/lib/hooks/useControllableState.js.map +1 -1
  21. package/lib/hooks/useEventCallback.js.map +1 -1
  22. package/lib/hooks/useFirstMount.js.map +1 -1
  23. package/lib/hooks/useForceUpdate.js.map +1 -1
  24. package/lib/hooks/useId.js.map +1 -1
  25. package/lib/hooks/useIsomorphicLayoutEffect.js.map +1 -1
  26. package/lib/hooks/useMergedEventCallbacks.d.ts +18 -0
  27. package/lib/hooks/useMergedEventCallbacks.js +26 -0
  28. package/lib/hooks/useMergedEventCallbacks.js.map +1 -0
  29. package/lib/hooks/useMergedRefs.js.map +1 -1
  30. package/lib/hooks/useMount.js.map +1 -1
  31. package/lib/hooks/useOnClickOutside.js.map +1 -1
  32. package/lib/hooks/useOnScrollOutside.js.map +1 -1
  33. package/lib/hooks/usePrevious.js.map +1 -1
  34. package/lib/hooks/useTimeout.js.map +1 -1
  35. package/lib/hooks/useUnmount.js.map +1 -1
  36. package/lib/index.js.map +1 -1
  37. package/lib/ssr/SSRContext.js.map +1 -1
  38. package/lib/ssr/canUseDOM.js.map +1 -1
  39. package/lib/ssr/index.js.map +1 -1
  40. package/lib/utils/applyTriggerPropsToChildren.d.ts +1 -1
  41. package/lib/utils/applyTriggerPropsToChildren.js +23 -3
  42. package/lib/utils/applyTriggerPropsToChildren.js.map +1 -1
  43. package/lib/utils/clamp.js.map +1 -1
  44. package/lib/utils/getNativeElementProps.d.ts +4 -4
  45. package/lib/utils/getNativeElementProps.js.map +1 -1
  46. package/lib/utils/getRTLSafeKey.js.map +1 -1
  47. package/lib/utils/getReactCallbackName.d.ts +25 -0
  48. package/lib/utils/getReactCallbackName.js +26 -0
  49. package/lib/utils/getReactCallbackName.js.map +1 -0
  50. package/lib/utils/getTriggerChild.d.ts +22 -0
  51. package/lib/utils/getTriggerChild.js +26 -0
  52. package/lib/utils/getTriggerChild.js.map +1 -0
  53. package/lib/utils/index.d.ts +2 -1
  54. package/lib/utils/index.js +2 -1
  55. package/lib/utils/index.js.map +1 -1
  56. package/lib/utils/isFluentTrigger.d.ts +22 -0
  57. package/lib/utils/isFluentTrigger.js +8 -0
  58. package/lib/utils/isFluentTrigger.js.map +1 -0
  59. package/lib/utils/omit.js.map +1 -1
  60. package/lib/utils/properties.js.map +1 -1
  61. package/lib/utils/shouldPreventDefaultOnKeyDown.js.map +1 -1
  62. package/lib-commonjs/compose/getSlots.d.ts +7 -8
  63. package/lib-commonjs/compose/getSlots.js +3 -5
  64. package/lib-commonjs/compose/getSlots.js.map +1 -1
  65. package/lib-commonjs/compose/index.d.ts +0 -1
  66. package/lib-commonjs/compose/index.js +0 -2
  67. package/lib-commonjs/compose/index.js.map +1 -1
  68. package/lib-commonjs/compose/resolveShorthand.d.ts +10 -6
  69. package/lib-commonjs/compose/resolveShorthand.js +5 -5
  70. package/lib-commonjs/compose/resolveShorthand.js.map +1 -1
  71. package/lib-commonjs/compose/types.d.ts +86 -34
  72. package/lib-commonjs/compose/types.js.map +1 -1
  73. package/lib-commonjs/hooks/index.d.ts +1 -0
  74. package/lib-commonjs/hooks/index.js +2 -0
  75. package/lib-commonjs/hooks/index.js.map +1 -1
  76. package/lib-commonjs/hooks/useBoolean.js.map +1 -1
  77. package/lib-commonjs/hooks/useConst.js.map +1 -1
  78. package/lib-commonjs/hooks/useControllableState.js.map +1 -1
  79. package/lib-commonjs/hooks/useEventCallback.js.map +1 -1
  80. package/lib-commonjs/hooks/useFirstMount.js.map +1 -1
  81. package/lib-commonjs/hooks/useForceUpdate.js.map +1 -1
  82. package/lib-commonjs/hooks/useId.js.map +1 -1
  83. package/lib-commonjs/hooks/useIsomorphicLayoutEffect.js.map +1 -1
  84. package/lib-commonjs/hooks/useMergedEventCallbacks.d.ts +18 -0
  85. package/lib-commonjs/hooks/useMergedEventCallbacks.js +36 -0
  86. package/lib-commonjs/hooks/useMergedEventCallbacks.js.map +1 -0
  87. package/lib-commonjs/hooks/useMergedRefs.js.map +1 -1
  88. package/lib-commonjs/hooks/useMount.js.map +1 -1
  89. package/lib-commonjs/hooks/useOnClickOutside.js.map +1 -1
  90. package/lib-commonjs/hooks/useOnScrollOutside.js.map +1 -1
  91. package/lib-commonjs/hooks/usePrevious.js.map +1 -1
  92. package/lib-commonjs/hooks/useTimeout.js.map +1 -1
  93. package/lib-commonjs/hooks/useUnmount.js.map +1 -1
  94. package/lib-commonjs/index.js.map +1 -1
  95. package/lib-commonjs/ssr/SSRContext.js.map +1 -1
  96. package/lib-commonjs/ssr/canUseDOM.js.map +1 -1
  97. package/lib-commonjs/ssr/index.js.map +1 -1
  98. package/lib-commonjs/utils/applyTriggerPropsToChildren.d.ts +1 -1
  99. package/lib-commonjs/utils/applyTriggerPropsToChildren.js +24 -4
  100. package/lib-commonjs/utils/applyTriggerPropsToChildren.js.map +1 -1
  101. package/lib-commonjs/utils/clamp.js.map +1 -1
  102. package/lib-commonjs/utils/getNativeElementProps.d.ts +4 -4
  103. package/lib-commonjs/utils/getNativeElementProps.js.map +1 -1
  104. package/lib-commonjs/utils/getRTLSafeKey.js.map +1 -1
  105. package/lib-commonjs/utils/getReactCallbackName.d.ts +25 -0
  106. package/lib-commonjs/utils/getReactCallbackName.js +35 -0
  107. package/lib-commonjs/utils/getReactCallbackName.js.map +1 -0
  108. package/lib-commonjs/utils/getTriggerChild.d.ts +22 -0
  109. package/lib-commonjs/utils/getTriggerChild.js +37 -0
  110. package/lib-commonjs/utils/getTriggerChild.js.map +1 -0
  111. package/lib-commonjs/utils/index.d.ts +2 -1
  112. package/lib-commonjs/utils/index.js +4 -2
  113. package/lib-commonjs/utils/index.js.map +1 -1
  114. package/lib-commonjs/utils/isFluentTrigger.d.ts +22 -0
  115. package/lib-commonjs/utils/isFluentTrigger.js +17 -0
  116. package/lib-commonjs/utils/isFluentTrigger.js.map +1 -0
  117. package/lib-commonjs/utils/omit.js.map +1 -1
  118. package/lib-commonjs/utils/properties.js.map +1 -1
  119. package/lib-commonjs/utils/shouldPreventDefaultOnKeyDown.js.map +1 -1
  120. package/package.json +3 -3
  121. package/lib/compose/nullRender.d.ts +0 -4
  122. package/lib/compose/nullRender.js +0 -5
  123. package/lib/compose/nullRender.js.map +0 -1
  124. package/lib/utils/onlyChild.d.ts +0 -5
  125. package/lib/utils/onlyChild.js +0 -13
  126. package/lib/utils/onlyChild.js.map +0 -1
  127. package/lib-commonjs/compose/nullRender.d.ts +0 -4
  128. package/lib-commonjs/compose/nullRender.js +0 -14
  129. package/lib-commonjs/compose/nullRender.js.map +0 -1
  130. package/lib-commonjs/utils/onlyChild.d.ts +0 -5
  131. package/lib-commonjs/utils/onlyChild.js +0 -23
  132. package/lib-commonjs/utils/onlyChild.js.map +0 -1
package/CHANGELOG.json CHANGED
@@ -2,17 +2,92 @@
2
2
  "name": "@fluentui/react-utilities",
3
3
  "entries": [
4
4
  {
5
- "date": "Thu, 06 Jan 2022 04:30:11 GMT",
6
- "tag": "@fluentui/react-utilities_v0.0.0-nightlyf8be6a7c6520220106.1",
7
- "version": "0.0.0-nightlyf8be6a7c6520220106.1",
5
+ "date": "Thu, 17 Feb 2022 11:41:16 GMT",
6
+ "tag": "@fluentui/react-utilities_v0.0.0-nightlyff78d1e27a20220217.1",
7
+ "version": "0.0.0-nightlyff78d1e27a20220217.1",
8
8
  "comments": {
9
9
  "prerelease": [
10
10
  {
11
11
  "author": "email not defined",
12
12
  "package": "@fluentui/react-utilities",
13
- "commit": "9b6d690fccd3a42a9ce2fed55d90f3eeb80edaa8",
13
+ "commit": "966e16625ca79f990ad8ca408ba47857adc522b3",
14
14
  "comment": "Release nightly v9"
15
15
  },
16
+ {
17
+ "author": "beachball",
18
+ "package": "@fluentui/react-utilities",
19
+ "comment": "Bump @fluentui/keyboard-keys to v0.0.0-nightlyff78d1e27a20220217.1",
20
+ "commit": "966e16625ca79f990ad8ca408ba47857adc522b3"
21
+ }
22
+ ]
23
+ }
24
+ },
25
+ {
26
+ "date": "Thu, 10 Feb 2022 08:50:32 GMT",
27
+ "tag": "@fluentui/react-utilities_v9.0.0-rc.1",
28
+ "version": "9.0.0-rc.1",
29
+ "comments": {
30
+ "prerelease": [
31
+ {
32
+ "author": "behowell@microsoft.com",
33
+ "package": "@fluentui/react-utilities",
34
+ "commit": "317209bb5cd57c40f35bc42060acb7e3cce5ec95",
35
+ "comment": "Rename component hooks add the suffix _unstable, as their API has not been finalized yet"
36
+ },
37
+ {
38
+ "author": "behowell@microsoft.com",
39
+ "package": "@fluentui/react-utilities",
40
+ "commit": "7cc28ed8320b00f42d91c63882f10316db2205c5",
41
+ "comment": "getSlots: remove slotNames param, and infer from state.components instead"
42
+ },
43
+ {
44
+ "author": "olfedias@microsoft.com",
45
+ "package": "@fluentui/react-utilities",
46
+ "commit": "d2eb57808a403b70845a732a62b55aa64d66b2a0",
47
+ "comment": "add useTriggerElement() hook"
48
+ },
49
+ {
50
+ "author": "bsunderhus@microsoft.com",
51
+ "package": "@fluentui/react-utilities",
52
+ "commit": "c0d4e63ee58e60e2c6674efbacc0783cd520984e",
53
+ "comment": "Removes nullRender from react-utilities"
54
+ },
55
+ {
56
+ "author": "olfedias@microsoft.com",
57
+ "package": "@fluentui/react-utilities",
58
+ "commit": "aa6cfd8ac825b5a280206808101de549a91094fc",
59
+ "comment": "update applyTriggerPropsToChildren() to return React.ReactElement or null"
60
+ },
61
+ {
62
+ "author": "behowell@microsoft.com",
63
+ "package": "@fluentui/react-utilities",
64
+ "commit": "53b01d71e335715fda91b33e3d7bbd9d471d5ed3",
65
+ "comment": "Refactor component Slot typings"
66
+ },
67
+ {
68
+ "author": "Humberto.Morimoto@microsoft.com",
69
+ "package": "@fluentui/react-utilities",
70
+ "commit": "0bc161458eae5ae8d387172430496ce9829b1bb1",
71
+ "comment": "Adding ComponentSlotProps to allow ref to be passed in composite components."
72
+ },
73
+ {
74
+ "author": "Humberto.Morimoto@microsoft.com",
75
+ "package": "@fluentui/react-utilities",
76
+ "commit": "e0b8e1fa6980077e7b311fd1c72c28d3e4305db0",
77
+ "comment": "Renaming most *Shorthand* composition types to *SlotProps* so they better reflect what the types do."
78
+ },
79
+ {
80
+ "author": "lingfangao@hotmail.com",
81
+ "package": "@fluentui/react-utilities",
82
+ "commit": "c00913d50e2dd15bbfbb0757cefe43b192ff1d7f",
83
+ "comment": "Bump Fluent UI packages to 9.0.0-rc"
84
+ },
85
+ {
86
+ "author": "behowell@microsoft.com",
87
+ "package": "@fluentui/react-utilities",
88
+ "commit": "f30e7585a8d2abd9db06c4076f39a779008b0eca",
89
+ "comment": "Update trigger utilities to handle nested triggers"
90
+ },
16
91
  {
17
92
  "author": "elcraig@microsoft.com",
18
93
  "package": "@fluentui/react-utilities",
@@ -22,8 +97,8 @@
22
97
  {
23
98
  "author": "beachball",
24
99
  "package": "@fluentui/react-utilities",
25
- "comment": "Bump @fluentui/keyboard-keys to v0.0.0-nightlyf8be6a7c6520220106.1",
26
- "commit": "9b6d690fccd3a42a9ce2fed55d90f3eeb80edaa8"
100
+ "comment": "Bump @fluentui/keyboard-keys to v9.0.0-rc.1",
101
+ "commit": "e6c855f6d9019d6c73668d15fc9bc3a13291a6c8"
27
102
  }
28
103
  ],
29
104
  "none": [
@@ -33,6 +108,18 @@
33
108
  "commit": "3360b45ec159250b1346c91afad7dce138e6bc20",
34
109
  "comment": "Update API file to version generated by typescript 4.3"
35
110
  },
111
+ {
112
+ "author": "olfedias@microsoft.com",
113
+ "package": "@fluentui/react-utilities",
114
+ "commit": "c061e98be4b4a718c72a144a1f60bb5515824612",
115
+ "comment": "remove inline-style-expand-shorthand from tsconfigs"
116
+ },
117
+ {
118
+ "author": "martinhochel@microsoft.com",
119
+ "package": "@fluentui/react-utilities",
120
+ "commit": "8dfa712156b70414205b87b5b6d099367b0c297d",
121
+ "comment": "chore: use storybook runner for all vNext packages"
122
+ },
36
123
  {
37
124
  "author": "seanmonahan@microsoft.com",
38
125
  "package": "@fluentui/react-utilities",
package/CHANGELOG.md CHANGED
@@ -1,19 +1,38 @@
1
1
  # Change Log - @fluentui/react-utilities
2
2
 
3
- This log was last generated on Thu, 06 Jan 2022 04:30:11 GMT and should not be manually modified.
3
+ This log was last generated on Thu, 17 Feb 2022 11:41:16 GMT and should not be manually modified.
4
4
 
5
5
  <!-- Start content -->
6
6
 
7
- ## [0.0.0-nightlyf8be6a7c6520220106.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v0.0.0-nightlyf8be6a7c6520220106.1)
7
+ ## [0.0.0-nightlyff78d1e27a20220217.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v0.0.0-nightlyff78d1e27a20220217.1)
8
8
 
9
- Thu, 06 Jan 2022 04:30:11 GMT
10
- [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.0.0-beta.4..@fluentui/react-utilities_v0.0.0-nightlyf8be6a7c6520220106.1)
9
+ Thu, 17 Feb 2022 11:41:16 GMT
10
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.0.0-rc.1..@fluentui/react-utilities_v0.0.0-nightlyff78d1e27a20220217.1)
11
11
 
12
12
  ### Changes
13
13
 
14
- - Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/9b6d690fccd3a42a9ce2fed55d90f3eeb80edaa8) by email not defined)
14
+ - Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/966e16625ca79f990ad8ca408ba47857adc522b3) by email not defined)
15
+ - Bump @fluentui/keyboard-keys to v0.0.0-nightlyff78d1e27a20220217.1 ([commit](https://github.com/microsoft/fluentui/commit/966e16625ca79f990ad8ca408ba47857adc522b3) by beachball)
16
+
17
+ ## [9.0.0-rc.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v9.0.0-rc.1)
18
+
19
+ Thu, 10 Feb 2022 08:50:32 GMT
20
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-utilities_v9.0.0-beta.4..@fluentui/react-utilities_v9.0.0-rc.1)
21
+
22
+ ### Changes
23
+
24
+ - Rename component hooks add the suffix _unstable, as their API has not been finalized yet ([PR #21365](https://github.com/microsoft/fluentui/pull/21365) by behowell@microsoft.com)
25
+ - getSlots: remove slotNames param, and infer from state.components instead ([PR #21134](https://github.com/microsoft/fluentui/pull/21134) by behowell@microsoft.com)
26
+ - add useTriggerElement() hook ([PR #21225](https://github.com/microsoft/fluentui/pull/21225) by olfedias@microsoft.com)
27
+ - Removes nullRender from react-utilities ([PR #21576](https://github.com/microsoft/fluentui/pull/21576) by bsunderhus@microsoft.com)
28
+ - update applyTriggerPropsToChildren() to return React.ReactElement or null ([PR #21609](https://github.com/microsoft/fluentui/pull/21609) by olfedias@microsoft.com)
29
+ - Refactor component Slot typings ([PR #21518](https://github.com/microsoft/fluentui/pull/21518) by behowell@microsoft.com)
30
+ - Adding ComponentSlotProps to allow ref to be passed in composite components. ([PR #20890](https://github.com/microsoft/fluentui/pull/20890) by Humberto.Morimoto@microsoft.com)
31
+ - Renaming most *Shorthand* composition types to *SlotProps* so they better reflect what the types do. ([PR #20891](https://github.com/microsoft/fluentui/pull/20891) by Humberto.Morimoto@microsoft.com)
32
+ - Bump Fluent UI packages to 9.0.0-rc ([PR #21623](https://github.com/microsoft/fluentui/pull/21623) by lingfangao@hotmail.com)
33
+ - Update trigger utilities to handle nested triggers ([PR #21495](https://github.com/microsoft/fluentui/pull/21495) by behowell@microsoft.com)
15
34
  - [breaking] Remove useControllableValue hook (use useControllableState instead) ([PR #20865](https://github.com/microsoft/fluentui/pull/20865) by elcraig@microsoft.com)
16
- - Bump @fluentui/keyboard-keys to v0.0.0-nightlyf8be6a7c6520220106.1 ([commit](https://github.com/microsoft/fluentui/commit/9b6d690fccd3a42a9ce2fed55d90f3eeb80edaa8) by beachball)
35
+ - Bump @fluentui/keyboard-keys to v9.0.0-rc.1 ([commit](https://github.com/microsoft/fluentui/commit/e6c855f6d9019d6c73668d15fc9bc3a13291a6c8) by beachball)
17
36
 
18
37
  ## [9.0.0-beta.4](https://github.com/microsoft/fluentui/tree/@fluentui/react-utilities_v9.0.0-beta.4)
19
38
 
@@ -11,7 +11,7 @@ export declare const anchorProperties: Record<string, number>;
11
11
  /**
12
12
  * Apply the trigger props to the children, either by calling the render function, or cloning with the new props.
13
13
  */
14
- export declare const applyTriggerPropsToChildren: <TTriggerProps>(children: React_2.ReactElement<any, string | React_2.JSXElementConstructor<any>> | ((props: TTriggerProps) => React_2.ReactNode) | null | undefined, triggerProps: TTriggerProps) => React_2.ReactNode;
14
+ export declare const applyTriggerPropsToChildren: <TTriggerProps>(children: React_2.ReactElement<any, string | React_2.JSXElementConstructor<any>> | ((props: TTriggerProps) => React_2.ReactElement | null) | null | undefined, triggerProps: TTriggerProps) => React_2.ReactElement | null;
15
15
 
16
16
  /**
17
17
  * Helper type for inferring the type of the as prop from a Props type.
@@ -71,25 +71,22 @@ export declare const colGroupProperties: Record<string, number>;
71
71
 
72
72
  export declare const colProperties: Record<string, number>;
73
73
 
74
- export declare type ComponentProps<Shorthands extends ObjectShorthandPropsRecord, Primary extends keyof Shorthands = 'root'> = Omit<{
75
- [Key in keyof Shorthands]?: ShorthandProps<NonNullable<Shorthands[Key]>>;
76
- }, Primary & 'root'> & PropsWithoutRef<Shorthands[Primary]>;
77
-
78
- export declare type ComponentState<Shorthands extends ObjectShorthandPropsRecord> = {
79
- components?: {
80
- [Key in keyof Shorthands]-?: React_2.ComponentType<NonNullable<Shorthands[Key]> extends ObjectShorthandProps<infer P> ? P : NonNullable<Shorthands[Key]>> | (NonNullable<Shorthands[Key]> extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
81
- };
82
- } & Shorthands;
74
+ /**
75
+ * Defines the Props type for a component given its slots and the definition of which one is the primary slot,
76
+ * defaulting to root if one is not provided.
77
+ */
78
+ export declare type ComponentProps<Slots extends SlotPropsRecord, Primary extends keyof Slots = 'root'> = Omit<Slots, Primary & 'root'> & PropsWithoutRef<ExtractSlotProps<Slots[Primary]>>;
83
79
 
84
80
  /**
85
- * Matches any shorthand props type.
86
- *
87
- * This should ONLY be used in type templates as in `extends DefaultObjectShorthandProps`;
88
- * it shouldn't be used as the type of a slot.
81
+ * Defines the State object of a component given its slots.
89
82
  */
90
- export declare type DefaultObjectShorthandProps = ObjectShorthandProps<Pick<React_2.HTMLAttributes<HTMLElement>, 'children' | 'className' | 'style'> & {
91
- as?: keyof JSX.IntrinsicElements;
92
- }>;
83
+ export declare type ComponentState<Slots extends SlotPropsRecord> = {
84
+ components: {
85
+ [Key in keyof Slots]-?: React_2.ComponentType<ExtractSlotProps<Slots[Key]>> | (ExtractSlotProps<Slots[Key]> extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
86
+ };
87
+ } & {
88
+ [Key in keyof Slots]: ReplaceNullWithUndefined<Exclude<Slots[Key], SlotShorthandValue | (Key extends 'root' ? null : never)>>;
89
+ };
93
90
 
94
91
  /**
95
92
  * Default context value to use in case there is no SSRProvider. This is fine for client-only apps.
@@ -105,6 +102,35 @@ export declare const defaultSSRContextValue: SSRContextValue;
105
102
  */
106
103
  export declare const divProperties: Record<string, number>;
107
104
 
105
+ /**
106
+ * HTML element types that are not allowed to have children.
107
+ *
108
+ * Reference: https://developer.mozilla.org/en-US/docs/Glossary/Empty_element
109
+ */
110
+ declare type EmptyIntrisicElements = 'area' | 'base' | 'br' | 'col' | 'embed' | 'hr' | 'img' | 'input' | 'link' | 'meta' | 'param' | 'source' | 'track' | 'wbr';
111
+
112
+ /**
113
+ * Removes SlotShorthandValue and null from the slot type, extracting just the slot's Props object.
114
+ */
115
+ export declare type ExtractSlotProps<S> = Exclude<S, SlotShorthandValue | null | undefined>;
116
+
117
+ /**
118
+ * Allows a component to be tagged as a FluentUI trigger component.
119
+ *
120
+ * Triggers are special-case components: they attach event listeners and other props on their child,
121
+ * and use them to trigger another component to show. Examples include `MenuTrigger` and `Tooltip`.
122
+ *
123
+ * A component can be tagged as a trigger as follows:
124
+ * ```ts
125
+ * const MyComponent: React.FC<MyComponentProps> & FluentTriggerComponent = ...;
126
+ *
127
+ * MyComponent.isFluentTriggerComponent = true; // MUST also set this to true
128
+ * ```
129
+ */
130
+ export declare type FluentTriggerComponent = {
131
+ isFluentTriggerComponent?: boolean;
132
+ };
133
+
108
134
  /**
109
135
  * An array of FORM tag properties and events.
110
136
  *
@@ -150,19 +176,19 @@ export declare function getNativeProps<T extends Record<string, any>>(props: Rec
150
176
  *
151
177
  * @returns An object containing the native props for the `root` and primary slots.
152
178
  */
153
- export declare const getPartitionedNativeProps: ({ primarySlotTagName, props, excludedPropNames, }: {
179
+ export declare const getPartitionedNativeProps: <Props extends Pick<React_2.HTMLAttributes<HTMLElement>, "style" | "className">, ExcludedPropKeys extends Extract<keyof Props, string> = never>({ primarySlotTagName, props, excludedPropNames, }: {
154
180
  /** The primary slot's element type (e.g. 'div') */
155
181
  primarySlotTagName: keyof JSX.IntrinsicElements;
156
182
  /** The component's props object */
157
- props: Pick<React_2.HTMLAttributes<HTMLElement>, 'style' | 'className'>;
183
+ props: Props;
158
184
  /** List of native props to exclude from the returned value */
159
- excludedPropNames?: string[] | undefined;
185
+ excludedPropNames?: ExcludedPropKeys[] | undefined;
160
186
  }) => {
161
187
  root: {
162
188
  style: React_2.CSSProperties | undefined;
163
189
  className: string | undefined;
164
190
  };
165
- primary: React_2.HTMLAttributes<any>;
191
+ primary: Omit<Props, ExcludedPropKeys>;
166
192
  };
167
193
 
168
194
  /**
@@ -185,12 +211,33 @@ export declare const getRTLSafeKey: (key: string, dir: 'ltr' | 'rtl') => string;
185
211
  * runtime code filtering props in this function.
186
212
  *
187
213
  * @param state - State including slot definitions
188
- * @param slotNames - Name of which props are slots
189
214
  * @returns An object containing the `slots` map and `slotProps` map.
190
215
  */
191
- export declare function getSlots<R extends ObjectShorthandPropsRecord>(state: ComponentState<R>, slotNames?: (keyof R)[]): {
216
+ export declare function getSlots<R extends SlotPropsRecord>(state: ComponentState<R>): {
192
217
  slots: Slots<R>;
193
- slotProps: SlotProps<R>;
218
+ slotProps: ObjectSlotProps<R>;
219
+ };
220
+
221
+ /**
222
+ * Gets the trigger element of a FluentTriggerComponent (such as Tooltip or MenuTrigger).
223
+ *
224
+ * In the case where the immediate child is itself a FluentTriggerComponent and/or React Fragment,
225
+ * it returns the first descendant that is _not_ a FluentTriggerComponent or Fragment.
226
+ * This allows multiple triggers to be stacked, and still apply their props to the actual trigger element.
227
+ *
228
+ * For example, the following returns `<div id="child" />`:
229
+ * ```jsx
230
+ * getTriggerChild(
231
+ * <Tooltip>
232
+ * <MenuTrigger>
233
+ * <div id="child" />
234
+ * </MenuTrigger>
235
+ * </Tooltip>
236
+ * );
237
+ * ```
238
+ */
239
+ export declare const getTriggerChild: (children: React_2.ReactNode) => React_2.ReactElement & {
240
+ ref?: React_2.Ref<unknown>;
194
241
  };
195
242
 
196
243
  /**
@@ -227,25 +274,19 @@ export declare const imgProperties: Record<string, number>;
227
274
  export declare const inputProperties: Record<string, number>;
228
275
 
229
276
  /**
230
- * Define the slot arguments for a slot that supports one or more intrinsic element types, such as 'div'.
231
- * For slots that support custom components, use {@link ObjectShorthandProps} instead.
232
- *
233
- * The first param is the slot's default type if no `as` prop is specified.
234
- * The second param is an optional union of alternative types that can be specified for the `as` prop.
235
- *
236
- * ```
237
- * IntrinsicShorthandProps<'div'> // Slot is always div
238
- * IntrinsicShorthandProps<'button', 'a'> // Defaults to button, but allows as="a" with anchor-specific props
239
- * IntrinsicShorthandProps<'label', 'span' | 'div'>; // Defaults to label, but allows as="span" or as="div"
240
- * ```
277
+ * Helper type for {@link Slot}. Modifies `JSX.IntrinsicElements[Type]`:
278
+ * * Removes legacy string ref.
279
+ * * Disallows children for empty tags like 'img'.
241
280
  */
242
- export declare type IntrinsicShorthandProps<DefaultAs extends keyof JSX.IntrinsicElements, AlternateAs extends keyof JSX.IntrinsicElements = never> = IsSingleton<DefaultAs> extends false ? 'Error: first parameter to IntrinsicShorthandProps must be a single element type, not a union of types' : ({
243
- as?: DefaultAs;
244
- } & ObjectShorthandProps<React_2.PropsWithRef<JSX.IntrinsicElements[DefaultAs]>>) | {
245
- [As in AlternateAs]: {
246
- as: As;
247
- } & ObjectShorthandProps<React_2.PropsWithRef<JSX.IntrinsicElements[As]>>;
248
- }[AlternateAs];
281
+ declare type IntrisicElementProps<Type extends keyof JSX.IntrinsicElements> = React_2.PropsWithRef<JSX.IntrinsicElements[Type]> & (Type extends EmptyIntrisicElements ? {
282
+ children?: never;
283
+ } : {});
284
+
285
+ /**
286
+ * Checks if a given element is a FluentUI trigger (e.g. `MenuTrigger` or `Tooltip`).
287
+ * See the {@link FluentTriggerComponent} type for more info.
288
+ */
289
+ export declare const isFluentTrigger: (element: React_2.ReactElement) => boolean | undefined;
249
290
 
250
291
  /**
251
292
  * Evaluates to true if the given type contains exactly one string, or false if it is a union of strings.
@@ -273,24 +314,10 @@ export declare const labelProperties: Record<string, number>;
273
314
  */
274
315
  export declare const liProperties: Record<string, number>;
275
316
 
276
- /**
277
- * Simple constant function for returning null, used to render empty templates in JSX.
278
- */
279
- export declare const nullRender: () => null;
280
-
281
- /**
282
- * Defines the slot props for a slot that supports a Component type.
283
- *
284
- * For intrinsic elements like 'div', use {@link IntrinsicShorthandProps} instead.
285
- */
286
- export declare type ObjectShorthandProps<Props extends {
287
- children?: React_2.ReactNode;
288
- } = {}> = Props & {
289
- children?: Props['children'] | ShorthandRenderFunction<Props>;
317
+ declare type ObjectSlotProps<S extends SlotPropsRecord> = {
318
+ [K in keyof S]-?: ExtractSlotProps<S[K]> extends AsIntrinsicElement<infer As> ? UnionToIntersection<JSX.IntrinsicElements[As]> : ExtractSlotProps<S[K]> extends React_2.ComponentType<infer P> ? P : never;
290
319
  };
291
320
 
292
- export declare type ObjectShorthandPropsRecord = Record<string, DefaultObjectShorthandProps | undefined>;
293
-
294
321
  /**
295
322
  * This is part of a hack to infer the element type from a native element *props* type.
296
323
  * The only place the original element is found in a native props type (at least that's workable
@@ -327,16 +354,11 @@ export declare const olProperties: Record<string, number>;
327
354
  */
328
355
  export declare function omit<TObj extends Record<string, any>, Exclusions extends (keyof TObj)[]>(obj: TObj, exclusions: Exclusions): Omit<TObj, Exclusions[number]>;
329
356
 
330
- /**
331
- * Similar to React.Children.only, but drills into fragments rather than treating them as a single child
332
- */
333
- export declare const onlyChild: <P>(child: boolean | React_2.ReactText | React_2.ReactFragment | React_2.ReactPortal | React_2.ReactElement<P, string | React_2.JSXElementConstructor<any>> | null | undefined) => React_2.ReactElement<P, string | React_2.JSXElementConstructor<any>>;
334
-
335
357
  export declare const optionProperties: Record<string, number>;
336
358
 
337
359
  /**
338
360
  * Removes the 'ref' prop from the given Props type, leaving unions intact (such as the discriminated union created by
339
- * IntrinsicShorthandProps). This allows IntrinsicShorthandProps to be used with React.forwardRef.
361
+ * IntrinsicSlotProps). This allows IntrinsicSlotProps to be used with React.forwardRef.
340
362
  *
341
363
  * The conditional "extends unknown" (always true) exploits a quirk in the way TypeScript handles conditional
342
364
  * types, to prevent unions from being expanded.
@@ -349,6 +371,11 @@ export declare type PropsWithoutRef<P> = 'ref' extends keyof P ? (P extends unkn
349
371
  */
350
372
  export declare type RefObjectFunction<T> = React_2.RefObject<T> & ((value: T) => void);
351
373
 
374
+ /**
375
+ * If type T includes `null`, remove it and add `undefined` instead.
376
+ */
377
+ export declare type ReplaceNullWithUndefined<T> = T extends null ? Exclude<T, null> | undefined : T;
378
+
352
379
  /**
353
380
  * Resets generated IDs, should be used only in tests.
354
381
  *
@@ -357,14 +384,19 @@ export declare type RefObjectFunction<T> = React_2.RefObject<T> & ((value: T) =>
357
384
  export declare function resetIdsForTests(): void;
358
385
 
359
386
  /**
360
- * Resolves ShorthandProps into ObjectShorthandProps, to ensure normalization of the signature
387
+ * Resolves shorthands into slot props, to ensure normalization of the signature
361
388
  * being passed down to getSlots method
362
- * @param value - the base ShorthandProps
363
- * @param options - options to resolve ShorthandProps
389
+ * @param value - the base shorthand props
390
+ * @param options - options to resolve shorthand props
364
391
  */
365
- export declare function resolveShorthand<Props extends DefaultObjectShorthandProps, Required extends boolean = false>(value: ShorthandProps<Props>, options?: ResolveShorthandOptions<Props, Required>): Required extends false ? Props | undefined : Props;
392
+ export declare const resolveShorthand: ResolveShorthandFunction;
366
393
 
367
- export declare type ResolveShorthandOptions<Props extends Record<string, any>, Required extends boolean = false> = {
394
+ export declare type ResolveShorthandFunction<Props extends UnknownSlotProps = UnknownSlotProps> = {
395
+ <P extends Props | null>(value: P | SlotShorthandValue | undefined, options?: ResolveShorthandOptions<P, true>): ReplaceNullWithUndefined<P>;
396
+ <P extends Props | null>(value: P | SlotShorthandValue | undefined, options?: ResolveShorthandOptions<P, boolean>): ReplaceNullWithUndefined<P> | undefined;
397
+ };
398
+
399
+ export declare type ResolveShorthandOptions<Props, Required extends boolean = false> = {
368
400
  required?: Required;
369
401
  defaultProps?: Props;
370
402
  };
@@ -376,10 +408,6 @@ export declare type ResolveShorthandOptions<Props extends Record<string, any>, R
376
408
  */
377
409
  export declare const selectProperties: Record<string, number>;
378
410
 
379
- export declare type ShorthandProps<Props extends DefaultObjectShorthandProps> = React_2.ReactChild | React_2.ReactNodeArray | React_2.ReactPortal | number | null | undefined | Props;
380
-
381
- export declare type ShorthandRenderFunction<Props> = (Component: React_2.ElementType<Props>, props: Omit<Props, 'children' | 'as'>) => React_2.ReactNode;
382
-
383
411
  /**
384
412
  * Checks if the keyboard event should preventDefault() for Enter and Spacebar keys
385
413
  *
@@ -387,14 +415,55 @@ export declare type ShorthandRenderFunction<Props> = (Component: React_2.Element
387
415
  */
388
416
  export declare function shouldPreventDefaultOnKeyDown(e: KeyboardEvent | React_2.KeyboardEvent): boolean;
389
417
 
390
- declare type SlotProps<S extends ObjectShorthandPropsRecord> = {
391
- [K in keyof S]-?: NonNullable<S[K]> extends AsIntrinsicElement<infer As> ? UnionToIntersection<JSX.IntrinsicElements[As]> : NonNullable<S[K]> extends ObjectShorthandProps<infer P> ? P : never;
392
- };
418
+ /**
419
+ * The props type and shorthand value for a slot. Type is either a single intrinsic element like `'div'`,
420
+ * or a component like `typeof Button`.
421
+ *
422
+ * If a slot needs to support multiple intrinsic element types, use the `AlternateAs` param (see examples below).
423
+ *
424
+ * By default, slots can be set to `null` to prevent them from being rendered. If a slot must always be rendered,
425
+ * wrap with `NonNullable` (see examples below).
426
+ *
427
+ * @example
428
+ * ```
429
+ * // Intrinsic element examples:
430
+ * Slot<'div'> // Slot is always div
431
+ * Slot<'button', 'a'> // Defaults to button, but allows as="a" with anchor-specific props
432
+ * Slot<'span', 'div' | 'pre'> // Defaults to span, but allows as="div" or as="pre"
433
+ * NonNullable<Slot<'div'>> // Slot that will always be rendered (can't be set to null by the user)
434
+ *
435
+ * // Component examples:
436
+ * Slot<typeof Button> // Slot is always a Button, and accepts all of Button's Props
437
+ * NonNullable<Slot<typeof Label>> // Slot is a Label and will always be rendered (can't be set to null by the user)
438
+ * ```
439
+ */
440
+ export declare type Slot<Type extends keyof JSX.IntrinsicElements | React_2.ComponentType | UnknownSlotProps, AlternateAs extends keyof JSX.IntrinsicElements = never> = IsSingleton<Extract<Type, string>> extends true ? WithSlotShorthandValue<Type extends keyof JSX.IntrinsicElements ? {
441
+ as?: Type;
442
+ } & WithSlotRenderFunction<IntrisicElementProps<Type>> : Type extends React_2.ComponentType<infer Props> ? WithSlotRenderFunction<Props> : Type> | {
443
+ [As in AlternateAs]: {
444
+ as: As;
445
+ } & WithSlotRenderFunction<IntrisicElementProps<As>>;
446
+ }[AlternateAs] | null : 'Error: First parameter to Slot must not be not a union of types. See documentation of Slot type.';
447
+
448
+ /**
449
+ * Matches any component's Slots type (such as ButtonSlots).
450
+ *
451
+ * This should ONLY be used in type templates as in `extends SlotPropsRecord`;
452
+ * it shouldn't be used as a component's Slots type.
453
+ */
454
+ export declare type SlotPropsRecord = Record<string, UnknownSlotProps | SlotShorthandValue | null | undefined>;
393
455
 
394
- export declare type Slots<S extends ObjectShorthandPropsRecord> = {
395
- [K in keyof S]-?: NonNullable<S[K]> extends AsIntrinsicElement<infer As> ? As : S[K] extends ObjectShorthandProps<infer P> ? React_2.ElementType<NonNullable<P>> : React_2.ElementType<NonNullable<S[K]>>;
456
+ export declare type SlotRenderFunction<Props> = (Component: React_2.ElementType<Props>, props: Omit<Props, 'children' | 'as'>) => React_2.ReactNode;
457
+
458
+ export declare type Slots<S extends SlotPropsRecord> = {
459
+ [K in keyof S]: ExtractSlotProps<S[K]> extends AsIntrinsicElement<infer As> ? As : ExtractSlotProps<S[K]> extends React_2.ComponentType<infer P> ? React_2.ElementType<NonNullable<P>> : React_2.ElementType<ExtractSlotProps<S[K]>>;
396
460
  };
397
461
 
462
+ /**
463
+ * The shorthand value of a slot allows specifying its child
464
+ */
465
+ export declare type SlotShorthandValue = React_2.ReactChild | React_2.ReactNodeArray | React_2.ReactPortal;
466
+
398
467
  export declare const SSRContext: React_2.Context<SSRContextValue>;
399
468
 
400
469
  /**
@@ -455,6 +524,16 @@ export declare const trProperties: Record<string, number>;
455
524
  */
456
525
  export declare type UnionToIntersection<U> = (U extends unknown ? (x: U) => U : never) extends (x: infer I) => U ? I : never;
457
526
 
527
+ /**
528
+ * Matches any slot props type.
529
+ *
530
+ * This should ONLY be used in type templates as in `extends UnknownSlotProps`;
531
+ * it shouldn't be used as the type of a slot.
532
+ */
533
+ export declare type UnknownSlotProps = Pick<React_2.HTMLAttributes<HTMLElement>, 'children' | 'className' | 'style'> & {
534
+ as?: keyof JSX.IntrinsicElements;
535
+ };
536
+
458
537
  /**
459
538
  * Hook to store a value and generate callbacks for setting the value to true or false.
460
539
  * The identity of the callbacks will always stay the same.
@@ -577,6 +656,25 @@ export declare const useIsomorphicLayoutEffect: typeof React_2.useEffect;
577
656
  */
578
657
  export declare function useIsSSR(): boolean;
579
658
 
659
+ /**
660
+ * Combine two event callbacks into a single callback function that calls each one in order.
661
+ *
662
+ * This is useful to add an event listener to an existing element without overwriting the current listener, if any.
663
+ *
664
+ * For example:
665
+ * ```ts
666
+ * state.slot.onChange = useMergedCallbacks(state.slot.onChange, ev => {
667
+ * // Handle onChange
668
+ * });
669
+ * ```
670
+ *
671
+ * @param callback1 - The first callback to be called
672
+ * @param callback2 - The second callback to be called
673
+ *
674
+ * @returns An event callback that calls the callbacks in order, and is stable between renders
675
+ */
676
+ export declare function useMergedEventCallbacks<Args extends unknown[]>(callback1: ((...args: Args) => void) | undefined, callback2: ((...args: Args) => void) | undefined): (...args: Args) => void;
677
+
580
678
  /**
581
679
  * React hook to merge multiple React refs (either MutableRefObjects or ref callbacks) into a single ref callback that
582
680
  * updates all provided refs
@@ -657,4 +755,21 @@ export declare const useUnmount: (callback: () => void) => void;
657
755
  */
658
756
  export declare const videoProperties: Record<string, number>;
659
757
 
758
+ /**
759
+ * Helper type for {@link Slot}. Takes the props we want to support for a slot and adds the ability for `children`
760
+ * to be a render function that takes those props.
761
+ */
762
+ declare type WithSlotRenderFunction<Props extends {
763
+ children?: unknown;
764
+ }> = Props & {
765
+ children?: Props['children'] | SlotRenderFunction<Props>;
766
+ };
767
+
768
+ /**
769
+ * Helper type for {@link Slot}. Adds shorthand types that are assignable to the slot's `children`.
770
+ */
771
+ declare type WithSlotShorthandValue<Props extends {
772
+ children?: unknown;
773
+ }> = Props | Extract<SlotShorthandValue, Props['children']>;
774
+
660
775
  export { }
@@ -1,10 +1,10 @@
1
1
  import * as React from 'react';
2
- import { AsIntrinsicElement, ComponentState, ObjectShorthandPropsRecord, ObjectShorthandProps, UnionToIntersection } from './types';
3
- export declare type Slots<S extends ObjectShorthandPropsRecord> = {
4
- [K in keyof S]-?: NonNullable<S[K]> extends AsIntrinsicElement<infer As> ? As : S[K] extends ObjectShorthandProps<infer P> ? React.ElementType<NonNullable<P>> : React.ElementType<NonNullable<S[K]>>;
2
+ import type { AsIntrinsicElement, ComponentState, ExtractSlotProps, SlotPropsRecord, UnionToIntersection } from './types';
3
+ export declare type Slots<S extends SlotPropsRecord> = {
4
+ [K in keyof S]: ExtractSlotProps<S[K]> extends AsIntrinsicElement<infer As> ? As : ExtractSlotProps<S[K]> extends React.ComponentType<infer P> ? React.ElementType<NonNullable<P>> : React.ElementType<ExtractSlotProps<S[K]>>;
5
5
  };
6
- declare type SlotProps<S extends ObjectShorthandPropsRecord> = {
7
- [K in keyof S]-?: NonNullable<S[K]> extends AsIntrinsicElement<infer As> ? UnionToIntersection<JSX.IntrinsicElements[As]> : NonNullable<S[K]> extends ObjectShorthandProps<infer P> ? P : never;
6
+ declare type ObjectSlotProps<S extends SlotPropsRecord> = {
7
+ [K in keyof S]-?: ExtractSlotProps<S[K]> extends AsIntrinsicElement<infer As> ? UnionToIntersection<JSX.IntrinsicElements[As]> : ExtractSlotProps<S[K]> extends React.ComponentType<infer P> ? P : never;
8
8
  };
9
9
  /**
10
10
  * Given the state and an array of slot names, will break out `slots` and `slotProps`
@@ -21,11 +21,10 @@ declare type SlotProps<S extends ObjectShorthandPropsRecord> = {
21
21
  * runtime code filtering props in this function.
22
22
  *
23
23
  * @param state - State including slot definitions
24
- * @param slotNames - Name of which props are slots
25
24
  * @returns An object containing the `slots` map and `slotProps` map.
26
25
  */
27
- export declare function getSlots<R extends ObjectShorthandPropsRecord>(state: ComponentState<R>, slotNames?: (keyof R)[]): {
26
+ export declare function getSlots<R extends SlotPropsRecord>(state: ComponentState<R>): {
28
27
  slots: Slots<R>;
29
- slotProps: SlotProps<R>;
28
+ slotProps: ObjectSlotProps<R>;
30
29
  };
31
30
  export {};
@@ -1,5 +1,4 @@
1
1
  import * as React from 'react';
2
- import { nullRender } from './nullRender';
3
2
  import { omit } from '../utils/omit';
4
3
  /**
5
4
  * Given the state and an array of slot names, will break out `slots` and `slotProps`
@@ -16,13 +15,13 @@ import { omit } from '../utils/omit';
16
15
  * runtime code filtering props in this function.
17
16
  *
18
17
  * @param state - State including slot definitions
19
- * @param slotNames - Name of which props are slots
20
18
  * @returns An object containing the `slots` map and `slotProps` map.
21
19
  */
22
20
 
23
- export function getSlots(state, slotNames = ['root']) {
21
+ export function getSlots(state) {
24
22
  const slots = {};
25
23
  const slotProps = {};
24
+ const slotNames = Object.keys(state.components);
26
25
 
27
26
  for (const slotName of slotNames) {
28
27
  const [slot, props] = getSlot(state, slotName);
@@ -40,7 +39,7 @@ function getSlot(state, slotName) {
40
39
  var _a, _b, _c;
41
40
 
42
41
  if (state[slotName] === undefined) {
43
- return [nullRender, undefined];
42
+ return [null, undefined];
44
43
  }
45
44
 
46
45
  const {