@fluentui/react-utilities 0.0.0-nightlyfc5cfdc52420220215.1 → 0.0.0

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 (219) hide show
  1. package/CHANGELOG.json +232 -7
  2. package/CHANGELOG.md +159 -73
  3. package/dist/{react-utilities.d.ts → index.d.ts} +39 -272
  4. package/{lib → dist}/tsdoc-metadata.json +0 -0
  5. package/lib/compose/getSlots.js.map +1 -1
  6. package/lib/compose/index.js.map +1 -1
  7. package/lib/compose/resolveShorthand.js.map +1 -1
  8. package/lib/compose/types.js +1 -5
  9. package/lib/compose/types.js.map +1 -1
  10. package/lib/hooks/index.js +1 -5
  11. package/lib/hooks/index.js.map +1 -1
  12. package/lib/hooks/useControllableState.js +3 -2
  13. package/lib/hooks/useControllableState.js.map +1 -1
  14. package/lib/hooks/useEventCallback.js +1 -0
  15. package/lib/hooks/useEventCallback.js.map +1 -1
  16. package/lib/hooks/useFirstMount.js +1 -0
  17. package/lib/hooks/useFirstMount.js.map +1 -1
  18. package/lib/hooks/useForceUpdate.js +1 -0
  19. package/lib/hooks/useForceUpdate.js.map +1 -1
  20. package/lib/hooks/useId.js +9 -5
  21. package/lib/hooks/useId.js.map +1 -1
  22. package/lib/hooks/useIsomorphicLayoutEffect.js +1 -0
  23. package/lib/hooks/useIsomorphicLayoutEffect.js.map +1 -1
  24. package/lib/hooks/useMergedEventCallbacks.js +1 -0
  25. package/lib/hooks/useMergedEventCallbacks.js.map +1 -1
  26. package/lib/hooks/useMergedRefs.js +1 -0
  27. package/lib/hooks/useMergedRefs.js.map +1 -1
  28. package/lib/hooks/useOnClickOutside.js +2 -1
  29. package/lib/hooks/useOnClickOutside.js.map +1 -1
  30. package/lib/hooks/useOnScrollOutside.js +1 -0
  31. package/lib/hooks/useOnScrollOutside.js.map +1 -1
  32. package/lib/hooks/usePrevious.js +4 -0
  33. package/lib/hooks/usePrevious.js.map +1 -1
  34. package/lib/hooks/useTimeout.js +2 -2
  35. package/lib/hooks/useTimeout.js.map +1 -1
  36. package/lib/index.js +5 -4
  37. package/lib/index.js.map +1 -1
  38. package/lib/ssr/SSRContext.js.map +1 -1
  39. package/lib/ssr/canUseDOM.js.map +1 -1
  40. package/lib/ssr/index.js.map +1 -1
  41. package/lib/{utils → trigger}/applyTriggerPropsToChildren.js +1 -0
  42. package/lib/trigger/applyTriggerPropsToChildren.js.map +1 -0
  43. package/lib/{utils → trigger}/getTriggerChild.js +2 -0
  44. package/lib/trigger/getTriggerChild.js.map +1 -0
  45. package/lib/trigger/index.js +5 -0
  46. package/lib/trigger/index.js.map +1 -0
  47. package/lib/{utils → trigger}/isFluentTrigger.js +0 -0
  48. package/lib/trigger/isFluentTrigger.js.map +1 -0
  49. package/lib/trigger/types.js +2 -0
  50. package/lib/trigger/types.js.map +1 -0
  51. package/lib/utils/clamp.js +1 -0
  52. package/lib/utils/clamp.js.map +1 -1
  53. package/lib/utils/getNativeElementProps.js +4 -2
  54. package/lib/utils/getNativeElementProps.js.map +1 -1
  55. package/lib/utils/getRTLSafeKey.js +1 -0
  56. package/lib/utils/getRTLSafeKey.js.map +1 -1
  57. package/lib/utils/getReactCallbackName.js.map +1 -1
  58. package/lib/utils/index.js +0 -3
  59. package/lib/utils/index.js.map +1 -1
  60. package/lib/utils/omit.js.map +1 -1
  61. package/lib/utils/properties.js +18 -6
  62. package/lib/utils/properties.js.map +1 -1
  63. package/lib/utils/shouldPreventDefaultOnKeyDown.js +5 -0
  64. package/lib/utils/shouldPreventDefaultOnKeyDown.js.map +1 -1
  65. package/lib-commonjs/compose/getSlots.js.map +1 -1
  66. package/lib-commonjs/compose/index.js.map +1 -1
  67. package/lib-commonjs/compose/resolveShorthand.js.map +1 -1
  68. package/lib-commonjs/compose/types.js +1 -5
  69. package/lib-commonjs/compose/types.js.map +1 -1
  70. package/lib-commonjs/hooks/index.js +2 -10
  71. package/lib-commonjs/hooks/index.js.map +1 -1
  72. package/lib-commonjs/hooks/useControllableState.js +3 -3
  73. package/lib-commonjs/hooks/useControllableState.js.map +1 -1
  74. package/lib-commonjs/hooks/useEventCallback.js +1 -0
  75. package/lib-commonjs/hooks/useEventCallback.js.map +1 -1
  76. package/lib-commonjs/hooks/useFirstMount.js +1 -0
  77. package/lib-commonjs/hooks/useFirstMount.js.map +1 -1
  78. package/lib-commonjs/hooks/useForceUpdate.js +1 -0
  79. package/lib-commonjs/hooks/useForceUpdate.js.map +1 -1
  80. package/lib-commonjs/hooks/useId.js +9 -5
  81. package/lib-commonjs/hooks/useId.js.map +1 -1
  82. package/lib-commonjs/hooks/useIsomorphicLayoutEffect.js +1 -0
  83. package/lib-commonjs/hooks/useIsomorphicLayoutEffect.js.map +1 -1
  84. package/lib-commonjs/hooks/useMergedEventCallbacks.js +1 -0
  85. package/lib-commonjs/hooks/useMergedEventCallbacks.js.map +1 -1
  86. package/lib-commonjs/hooks/useMergedRefs.js +1 -0
  87. package/lib-commonjs/hooks/useMergedRefs.js.map +1 -1
  88. package/lib-commonjs/hooks/useOnClickOutside.js +2 -1
  89. package/lib-commonjs/hooks/useOnClickOutside.js.map +1 -1
  90. package/lib-commonjs/hooks/useOnScrollOutside.js +1 -0
  91. package/lib-commonjs/hooks/useOnScrollOutside.js.map +1 -1
  92. package/lib-commonjs/hooks/usePrevious.js +4 -0
  93. package/lib-commonjs/hooks/usePrevious.js.map +1 -1
  94. package/lib-commonjs/hooks/useTimeout.js +2 -3
  95. package/lib-commonjs/hooks/useTimeout.js.map +1 -1
  96. package/lib-commonjs/index.js +161 -5
  97. package/lib-commonjs/index.js.map +1 -1
  98. package/lib-commonjs/ssr/SSRContext.js.map +1 -1
  99. package/lib-commonjs/ssr/canUseDOM.js.map +1 -1
  100. package/lib-commonjs/ssr/index.js.map +1 -1
  101. package/lib-commonjs/{utils → trigger}/applyTriggerPropsToChildren.js +1 -0
  102. package/lib-commonjs/trigger/applyTriggerPropsToChildren.js.map +1 -0
  103. package/lib-commonjs/{utils → trigger}/getTriggerChild.js +2 -0
  104. package/lib-commonjs/trigger/getTriggerChild.js.map +1 -0
  105. package/lib-commonjs/trigger/index.js +16 -0
  106. package/lib-commonjs/trigger/index.js.map +1 -0
  107. package/lib-commonjs/{utils → trigger}/isFluentTrigger.js +0 -0
  108. package/lib-commonjs/trigger/isFluentTrigger.js.map +1 -0
  109. package/lib-commonjs/trigger/types.js +6 -0
  110. package/lib-commonjs/trigger/types.js.map +1 -0
  111. package/lib-commonjs/utils/clamp.js +1 -0
  112. package/lib-commonjs/utils/clamp.js.map +1 -1
  113. package/lib-commonjs/utils/getNativeElementProps.js +3 -1
  114. package/lib-commonjs/utils/getNativeElementProps.js.map +1 -1
  115. package/lib-commonjs/utils/getRTLSafeKey.js +1 -0
  116. package/lib-commonjs/utils/getRTLSafeKey.js.map +1 -1
  117. package/lib-commonjs/utils/getReactCallbackName.js.map +1 -1
  118. package/lib-commonjs/utils/index.js +0 -6
  119. package/lib-commonjs/utils/index.js.map +1 -1
  120. package/lib-commonjs/utils/omit.js.map +1 -1
  121. package/lib-commonjs/utils/properties.js +19 -7
  122. package/lib-commonjs/utils/properties.js.map +1 -1
  123. package/lib-commonjs/utils/shouldPreventDefaultOnKeyDown.js +5 -0
  124. package/lib-commonjs/utils/shouldPreventDefaultOnKeyDown.js.map +1 -1
  125. package/package.json +13 -13
  126. package/lib/compose/getSlots.d.ts +0 -30
  127. package/lib/compose/index.d.ts +0 -3
  128. package/lib/compose/resolveShorthand.d.ts +0 -16
  129. package/lib/compose/types.d.ts +0 -155
  130. package/lib/hooks/index.d.ts +0 -16
  131. package/lib/hooks/useBoolean.d.ts +0 -17
  132. package/lib/hooks/useBoolean.js +0 -28
  133. package/lib/hooks/useBoolean.js.map +0 -1
  134. package/lib/hooks/useConst.d.ts +0 -12
  135. package/lib/hooks/useConst.js +0 -30
  136. package/lib/hooks/useConst.js.map +0 -1
  137. package/lib/hooks/useControllableState.d.ts +0 -31
  138. package/lib/hooks/useEventCallback.d.ts +0 -13
  139. package/lib/hooks/useFirstMount.d.ts +0 -11
  140. package/lib/hooks/useForceUpdate.d.ts +0 -4
  141. package/lib/hooks/useId.d.ts +0 -15
  142. package/lib/hooks/useIsomorphicLayoutEffect.d.ts +0 -11
  143. package/lib/hooks/useMergedEventCallbacks.d.ts +0 -18
  144. package/lib/hooks/useMergedRefs.d.ts +0 -13
  145. package/lib/hooks/useMount.d.ts +0 -6
  146. package/lib/hooks/useMount.js +0 -17
  147. package/lib/hooks/useMount.js.map +0 -1
  148. package/lib/hooks/useOnClickOutside.d.ts +0 -29
  149. package/lib/hooks/useOnScrollOutside.d.ts +0 -5
  150. package/lib/hooks/usePrevious.d.ts +0 -1
  151. package/lib/hooks/useTimeout.d.ts +0 -8
  152. package/lib/hooks/useUnmount.d.ts +0 -6
  153. package/lib/hooks/useUnmount.js +0 -17
  154. package/lib/hooks/useUnmount.js.map +0 -1
  155. package/lib/index.d.ts +0 -4
  156. package/lib/ssr/SSRContext.d.ts +0 -33
  157. package/lib/ssr/canUseDOM.d.ts +0 -4
  158. package/lib/ssr/index.d.ts +0 -2
  159. package/lib/utils/applyTriggerPropsToChildren.d.ts +0 -5
  160. package/lib/utils/applyTriggerPropsToChildren.js.map +0 -1
  161. package/lib/utils/clamp.d.ts +0 -8
  162. package/lib/utils/getNativeElementProps.d.ts +0 -31
  163. package/lib/utils/getRTLSafeKey.d.ts +0 -4
  164. package/lib/utils/getReactCallbackName.d.ts +0 -25
  165. package/lib/utils/getTriggerChild.d.ts +0 -22
  166. package/lib/utils/getTriggerChild.js.map +0 -1
  167. package/lib/utils/index.d.ts +0 -9
  168. package/lib/utils/isFluentTrigger.d.ts +0 -22
  169. package/lib/utils/isFluentTrigger.js.map +0 -1
  170. package/lib/utils/omit.d.ts +0 -14
  171. package/lib/utils/properties.d.ts +0 -148
  172. package/lib/utils/shouldPreventDefaultOnKeyDown.d.ts +0 -7
  173. package/lib-commonjs/compose/getSlots.d.ts +0 -30
  174. package/lib-commonjs/compose/index.d.ts +0 -3
  175. package/lib-commonjs/compose/resolveShorthand.d.ts +0 -16
  176. package/lib-commonjs/compose/types.d.ts +0 -155
  177. package/lib-commonjs/hooks/index.d.ts +0 -16
  178. package/lib-commonjs/hooks/useBoolean.d.ts +0 -17
  179. package/lib-commonjs/hooks/useBoolean.js +0 -39
  180. package/lib-commonjs/hooks/useBoolean.js.map +0 -1
  181. package/lib-commonjs/hooks/useConst.d.ts +0 -12
  182. package/lib-commonjs/hooks/useConst.js +0 -40
  183. package/lib-commonjs/hooks/useConst.js.map +0 -1
  184. package/lib-commonjs/hooks/useControllableState.d.ts +0 -31
  185. package/lib-commonjs/hooks/useEventCallback.d.ts +0 -13
  186. package/lib-commonjs/hooks/useFirstMount.d.ts +0 -11
  187. package/lib-commonjs/hooks/useForceUpdate.d.ts +0 -4
  188. package/lib-commonjs/hooks/useId.d.ts +0 -15
  189. package/lib-commonjs/hooks/useIsomorphicLayoutEffect.d.ts +0 -11
  190. package/lib-commonjs/hooks/useMergedEventCallbacks.d.ts +0 -18
  191. package/lib-commonjs/hooks/useMergedRefs.d.ts +0 -13
  192. package/lib-commonjs/hooks/useMount.d.ts +0 -6
  193. package/lib-commonjs/hooks/useMount.js +0 -27
  194. package/lib-commonjs/hooks/useMount.js.map +0 -1
  195. package/lib-commonjs/hooks/useOnClickOutside.d.ts +0 -29
  196. package/lib-commonjs/hooks/useOnScrollOutside.d.ts +0 -5
  197. package/lib-commonjs/hooks/usePrevious.d.ts +0 -1
  198. package/lib-commonjs/hooks/useTimeout.d.ts +0 -8
  199. package/lib-commonjs/hooks/useUnmount.d.ts +0 -6
  200. package/lib-commonjs/hooks/useUnmount.js +0 -27
  201. package/lib-commonjs/hooks/useUnmount.js.map +0 -1
  202. package/lib-commonjs/index.d.ts +0 -4
  203. package/lib-commonjs/ssr/SSRContext.d.ts +0 -33
  204. package/lib-commonjs/ssr/canUseDOM.d.ts +0 -4
  205. package/lib-commonjs/ssr/index.d.ts +0 -2
  206. package/lib-commonjs/utils/applyTriggerPropsToChildren.d.ts +0 -5
  207. package/lib-commonjs/utils/applyTriggerPropsToChildren.js.map +0 -1
  208. package/lib-commonjs/utils/clamp.d.ts +0 -8
  209. package/lib-commonjs/utils/getNativeElementProps.d.ts +0 -31
  210. package/lib-commonjs/utils/getRTLSafeKey.d.ts +0 -4
  211. package/lib-commonjs/utils/getReactCallbackName.d.ts +0 -25
  212. package/lib-commonjs/utils/getTriggerChild.d.ts +0 -22
  213. package/lib-commonjs/utils/getTriggerChild.js.map +0 -1
  214. package/lib-commonjs/utils/index.d.ts +0 -9
  215. package/lib-commonjs/utils/isFluentTrigger.d.ts +0 -22
  216. package/lib-commonjs/utils/isFluentTrigger.js.map +0 -1
  217. package/lib-commonjs/utils/omit.d.ts +0 -14
  218. package/lib-commonjs/utils/properties.d.ts +0 -148
  219. package/lib-commonjs/utils/shouldPreventDefaultOnKeyDown.d.ts +0 -7
@@ -1,12 +0,0 @@
1
- /**
2
- * Hook to initialize and return a constant value. Unlike `React.useMemo`, this is guaranteed to
3
- * always return the same value (and if the initializer is a function, only call it once).
4
- * This is similar to setting a private member in a class constructor.
5
- *
6
- * If the value should ever change based on dependencies, use `React.useMemo` instead.
7
- *
8
- * @param initialValue - Initial value, or function to get the initial value. Similar to `useState`,
9
- * only the value/function passed in the first time this is called is respected.
10
- * @returns The value. The identity of this value will always be the same.
11
- */
12
- export declare function useConst<T>(initialValue: T | (() => T)): T;
@@ -1,40 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.useConst = void 0;
7
-
8
- const React = /*#__PURE__*/require("react");
9
- /**
10
- * Hook to initialize and return a constant value. Unlike `React.useMemo`, this is guaranteed to
11
- * always return the same value (and if the initializer is a function, only call it once).
12
- * This is similar to setting a private member in a class constructor.
13
- *
14
- * If the value should ever change based on dependencies, use `React.useMemo` instead.
15
- *
16
- * @param initialValue - Initial value, or function to get the initial value. Similar to `useState`,
17
- * only the value/function passed in the first time this is called is respected.
18
- * @returns The value. The identity of this value will always be the same.
19
- */
20
-
21
-
22
- function useConst(initialValue) {
23
- // Use useRef to store the value because it's the least expensive built-in hook that works here
24
- // (we could also use `const [value] = React.useState(initialValue)` but that's more expensive
25
- // internally due to reducer handling which we don't need)
26
- const ref = React.useRef();
27
-
28
- if (ref.current === undefined) {
29
- // Box the value in an object so we can tell if it's initialized even if the initializer
30
- // returns/is undefined
31
- ref.current = {
32
- value: typeof initialValue === 'function' ? initialValue() : initialValue
33
- };
34
- }
35
-
36
- return ref.current.value;
37
- }
38
-
39
- exports.useConst = useConst;
40
- //# sourceMappingURL=useConst.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/hooks/useConst.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;AAEA;;;;;;;;;;AAUG;;;AACH,SAAgB,QAAhB,CAA4B,YAA5B,EAAuD;AACrD;AACA;AACA;AACA,QAAM,GAAG,GAAG,KAAK,CAAC,MAAN,EAAZ;;AACA,MAAI,GAAG,CAAC,OAAJ,KAAgB,SAApB,EAA+B;AAC7B;AACA;AACA,IAAA,GAAG,CAAC,OAAJ,GAAc;AACZ,MAAA,KAAK,EAAE,OAAO,YAAP,KAAwB,UAAxB,GAAsC,YAAyB,EAA/D,GAAoE;AAD/D,KAAd;AAGD;;AACD,SAAO,GAAG,CAAC,OAAJ,CAAY,KAAnB;AACD;;AAbD,OAAA,CAAA,QAAA,GAAA,QAAA","sourceRoot":""}
@@ -1,31 +0,0 @@
1
- import * as React from 'react';
2
- export declare type UseControllableStateOptions<State> = {
3
- /**
4
- * User-provided default state or initializer, for uncontrolled usage.
5
- */
6
- defaultState?: State | (() => State);
7
- /**
8
- * User-provided controlled state. `undefined` means internal state will be used.
9
- */
10
- state: State | undefined;
11
- /**
12
- * Used as the initial state if `state` and `defaultState` are both `undefined`.
13
- * If `undefined` is the correct initial state, pass that here.
14
- */
15
- initialState: State;
16
- };
17
- /**
18
- * A `useState`-like hook to manage a value that could be either controlled or uncontrolled,
19
- * such as a checked state or text input string.
20
- *
21
- * Unlike `setState`, it's okay to call the returned updater (dispatch) function for either a
22
- * controlled or uncontrolled component. Calls will only be respected if the component is uncontrolled.
23
- *
24
- * @returns Same as [`useState`](https://reactjs.org/docs/hooks-reference.html#usestate): an array
25
- * of the current value and an updater (dispatch) function. The updater function is referentially
26
- * stable (won't change during the component's lifecycle). It can take either a new value, or a
27
- * function which is passed the previous value and returns the new value. Unlike `setState`, calls
28
- * to the updater function will only be respected if the component is uncontrolled.
29
- * @see https://reactjs.org/docs/uncontrolled-components.html
30
- */
31
- export declare const useControllableState: <State>(options: UseControllableStateOptions<State>) => [State, React.Dispatch<React.SetStateAction<State>>];
@@ -1,13 +0,0 @@
1
- /**
2
- * https://reactjs.org/docs/hooks-faq.html#how-to-read-an-often-changing-value-from-usecallback
3
- *
4
- * Modified `useCallback` that can be used when dependencies change too frequently. Can occur when
5
- * e.g. user props are dependencies which could change on every render
6
- * e.g. volatile values (i.e. useState/useDispatch) are dependencies which could change frequently
7
- *
8
- * This should not be used often, but can be a useful re-render optimization since the callback is a ref and
9
- * will not be invalidated between re-renders
10
- *
11
- * @param fn - The callback function that will be used
12
- */
13
- export declare const useEventCallback: <Args extends unknown[], Return>(fn: (...args: Args) => Return) => (...args: Args) => Return;
@@ -1,11 +0,0 @@
1
- /**
2
- * Checks if components was mounted the first time.
3
- * Since concurrent mode will be released in the future this needs to be verified
4
- * Currently (React 17) will always render the initial mount once
5
- * https://codesandbox.io/s/heuristic-brook-s4w0q?file=/src/App.jsx
6
- * https://codesandbox.io/s/holy-grass-8nieu?file=/src/App.jsx
7
- *
8
- * @example
9
- * const isFirstMount = useFirstMount();
10
- */
11
- export declare function useFirstMount(): boolean;
@@ -1,4 +0,0 @@
1
- /**
2
- * Forces a re-render, similar to `forceUpdate` in class components.
3
- */
4
- export declare function useForceUpdate(): import("react").DispatchWithoutAction;
@@ -1,15 +0,0 @@
1
- /**
2
- * Resets generated IDs, should be used only in tests.
3
- *
4
- * @private
5
- */
6
- export declare function resetIdsForTests(): void;
7
- /**
8
- * Hook to generate a unique ID.
9
- *
10
- * @param prefix - Optional prefix for the ID
11
- * @param providedId - Optional id provided by a parent component. Defaults to the provided value if present,
12
- * without conditioning the hook call
13
- * @returns The ID
14
- */
15
- export declare function useId(prefix?: string, providedId?: string): string;
@@ -1,11 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * React currently throws a warning when using useLayoutEffect on the server. To get around it, we can conditionally
4
- * useEffect on the server (no-op) and useLayoutEffect in the browser. We occasionally need useLayoutEffect to
5
- * ensure we don't get a render flash for certain operations, but we may also need affected components to render on
6
- * the server.
7
- *
8
- * https://gist.github.com/gaearon/e7d97cdf38a2907924ea12e4ebdf3c85
9
- * https://github.com/reduxjs/react-redux/blob/master/src/utils/useIsomorphicLayoutEffect.js
10
- */
11
- export declare const useIsomorphicLayoutEffect: typeof React.useEffect;
@@ -1,18 +0,0 @@
1
- /**
2
- * Combine two event callbacks into a single callback function that calls each one in order.
3
- *
4
- * This is useful to add an event listener to an existing element without overwriting the current listener, if any.
5
- *
6
- * For example:
7
- * ```ts
8
- * state.slot.onChange = useMergedCallbacks(state.slot.onChange, ev => {
9
- * // Handle onChange
10
- * });
11
- * ```
12
- *
13
- * @param callback1 - The first callback to be called
14
- * @param callback2 - The second callback to be called
15
- *
16
- * @returns An event callback that calls the callbacks in order, and is stable between renders
17
- */
18
- export declare function useMergedEventCallbacks<Args extends unknown[]>(callback1: ((...args: Args) => void) | undefined, callback2: ((...args: Args) => void) | undefined): (...args: Args) => void;
@@ -1,13 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * A Ref function which can be treated like a ref object in that it has an attached
4
- * current property, which will be updated as the ref is evaluated.
5
- */
6
- export declare type RefObjectFunction<T> = React.RefObject<T> & ((value: T) => void);
7
- /**
8
- * React hook to merge multiple React refs (either MutableRefObjects or ref callbacks) into a single ref callback that
9
- * updates all provided refs
10
- * @param refs - Refs to collectively update with one ref value.
11
- * @returns A function with an attached "current" prop, so that it can be treated like a RefObject.
12
- */
13
- export declare function useMergedRefs<T>(...refs: (React.Ref<T> | undefined)[]): RefObjectFunction<T>;
@@ -1,6 +0,0 @@
1
- /**
2
- * Hook which asynchronously executes a callback once the component has been mounted.
3
- *
4
- * @param callback - Function to call before mount.
5
- */
6
- export declare const useMount: (callback: () => void) => void;
@@ -1,27 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.useMount = void 0;
7
-
8
- const React = /*#__PURE__*/require("react");
9
- /**
10
- * Hook which asynchronously executes a callback once the component has been mounted.
11
- *
12
- * @param callback - Function to call before mount.
13
- */
14
-
15
-
16
- const useMount = callback => {
17
- const mountRef = React.useRef(callback);
18
- mountRef.current = callback;
19
- React.useEffect(() => {
20
- var _a;
21
-
22
- (_a = mountRef.current) === null || _a === void 0 ? void 0 : _a.call(mountRef);
23
- }, []);
24
- };
25
-
26
- exports.useMount = useMount;
27
- //# sourceMappingURL=useMount.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/hooks/useMount.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;AAEA;;;;AAIG;;;AACI,MAAM,QAAQ,GAAI,QAAD,IAAyB;AAC/C,QAAM,QAAQ,GAAG,KAAK,CAAC,MAAN,CAAa,QAAb,CAAjB;AACA,EAAA,QAAQ,CAAC,OAAT,GAAmB,QAAnB;AACA,EAAA,KAAK,CAAC,SAAN,CAAgB,MAAK;;;AACnB,KAAA,EAAA,GAAA,QAAQ,CAAC,OAAT,MAAgB,IAAhB,IAAgB,EAAA,KAAA,KAAA,CAAhB,GAAgB,KAAA,CAAhB,GAAgB,EAAA,CAAA,IAAA,CAAhB,QAAgB,CAAhB;AACD,GAFD,EAEG,EAFH;AAGD,CANM;;AAAM,OAAA,CAAA,QAAA,GAAQ,QAAR","sourceRoot":""}
@@ -1,29 +0,0 @@
1
- import * as React from 'react';
2
- export declare type UseOnClickOrScrollOutsideOptions = {
3
- /**
4
- * The element to listen for the click event
5
- */
6
- element: Document | undefined;
7
- /**
8
- * Refs to elements that check if the click is outside
9
- */
10
- refs: React.MutableRefObject<HTMLElement | undefined | null>[];
11
- /**
12
- * By default uses element.contains, but custom contain function can be provided
13
- * @param parentRef - provided parent ref
14
- * @param child - event target element
15
- */
16
- contains?(parent: HTMLElement | null, child: HTMLElement): boolean;
17
- /**
18
- * Disables event listeners
19
- */
20
- disabled?: boolean;
21
- /**
22
- * Called if the click is outside the element refs
23
- */
24
- callback: (ev: MouseEvent | TouchEvent) => void;
25
- };
26
- /**
27
- * Utility to perform checks where a click/touch event was made outside a component
28
- */
29
- export declare const useOnClickOutside: (options: UseOnClickOrScrollOutsideOptions) => void;
@@ -1,5 +0,0 @@
1
- import type { UseOnClickOrScrollOutsideOptions } from './useOnClickOutside';
2
- /**
3
- * Utility to perform checks where a click/touch event was made outside a component
4
- */
5
- export declare const useOnScrollOutside: (options: UseOnClickOrScrollOutsideOptions) => void;
@@ -1 +0,0 @@
1
- export declare const usePrevious: <ValueType = unknown>(value: ValueType) => ValueType | null;
@@ -1,8 +0,0 @@
1
- /**
2
- * Helper to manage a browser timeout.
3
- * Ensures that the timeout isn't set multiple times at once,
4
- * and is cleaned up when the component is unloaded.
5
- *
6
- * @returns A pair of [setTimeout, clearTimeout] that are stable between renders.
7
- */
8
- export declare function useTimeout(): readonly [(fn: () => void, delay: number) => void, () => void];
@@ -1,6 +0,0 @@
1
- /**
2
- * Hook which synchronously executes a callback when the component is about to unmount.
3
- *
4
- * @param callback - Function to call during unmount.
5
- */
6
- export declare const useUnmount: (callback: () => void) => void;
@@ -1,27 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.useUnmount = void 0;
7
-
8
- const React = /*#__PURE__*/require("react");
9
- /**
10
- * Hook which synchronously executes a callback when the component is about to unmount.
11
- *
12
- * @param callback - Function to call during unmount.
13
- */
14
-
15
-
16
- const useUnmount = callback => {
17
- const unmountRef = React.useRef(callback);
18
- unmountRef.current = callback;
19
- React.useEffect(() => () => {
20
- var _a;
21
-
22
- (_a = unmountRef.current) === null || _a === void 0 ? void 0 : _a.call(unmountRef);
23
- }, []);
24
- };
25
-
26
- exports.useUnmount = useUnmount;
27
- //# sourceMappingURL=useUnmount.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/hooks/useUnmount.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;AAEA;;;;AAIG;;;AACI,MAAM,UAAU,GAAI,QAAD,IAAyB;AACjD,QAAM,UAAU,GAAG,KAAK,CAAC,MAAN,CAAa,QAAb,CAAnB;AACA,EAAA,UAAU,CAAC,OAAX,GAAqB,QAArB;AACA,EAAA,KAAK,CAAC,SAAN,CACE,MAAM,MAAK;;;AACT,KAAA,EAAA,GAAA,UAAU,CAAC,OAAX,MAAkB,IAAlB,IAAkB,EAAA,KAAA,KAAA,CAAlB,GAAkB,KAAA,CAAlB,GAAkB,EAAA,CAAA,IAAA,CAAlB,UAAkB,CAAlB;AACD,GAHH,EAIE,EAJF;AAMD,CATM;;AAAM,OAAA,CAAA,UAAA,GAAU,UAAV","sourceRoot":""}
@@ -1,4 +0,0 @@
1
- export * from './compose/index';
2
- export * from './hooks/index';
3
- export * from './ssr/index';
4
- export * from './utils/index';
@@ -1,33 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * To support SSR, the auto incrementing id counter is stored in a context. This allows it to be reset on every request
4
- * to ensure the client and server are consistent.
5
- *
6
- * @internal
7
- */
8
- export declare type SSRContextValue = {
9
- current: number;
10
- };
11
- /**
12
- * Default context value to use in case there is no SSRProvider. This is fine for client-only apps.
13
- *
14
- * @internal
15
- */
16
- export declare const defaultSSRContextValue: SSRContextValue;
17
- export declare const SSRContext: React.Context<SSRContextValue>;
18
- /**
19
- * @internal
20
- */
21
- export declare function useSSRContext(): SSRContextValue;
22
- /**
23
- * When using SSR with Fluent UI, applications must be wrapped in an SSRProvider. This ensures that auto generated ids
24
- * are consistent between the client and server.
25
- *
26
- * @public
27
- */
28
- export declare const SSRProvider: React.FC;
29
- /**
30
- * Returns whether the component is currently being server side rendered or hydrated on the client. Can be used to delay
31
- * browser-specific rendering until after hydration. May cause re-renders on a client when is used within SSRProvider.
32
- */
33
- export declare function useIsSSR(): boolean;
@@ -1,4 +0,0 @@
1
- /**
2
- * Verifies if an application can use DOM.
3
- */
4
- export declare function canUseDOM(): boolean;
@@ -1,2 +0,0 @@
1
- export * from './canUseDOM';
2
- export * from './SSRContext';
@@ -1,5 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * Apply the trigger props to the children, either by calling the render function, or cloning with the new props.
4
- */
5
- export declare const applyTriggerPropsToChildren: <TTriggerProps>(children: React.ReactElement<any, string | React.JSXElementConstructor<any>> | ((props: TTriggerProps) => React.ReactElement | null) | null | undefined, triggerProps: TTriggerProps) => React.ReactElement | null;
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/utils/applyTriggerPropsToChildren.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;;AACA,MAAA,iBAAA,gBAAA,OAAA,CAAA,mBAAA,CAAA;AAEA;;AAEG;;;AACI,MAAM,2BAA2B,GAAG,CACzC,QADyC,EAEzC,YAFyC,KAGZ;AAC7B,MAAI,OAAO,QAAP,KAAoB,UAAxB,EAAoC;AAClC,WAAO,QAAQ,CAAC,YAAD,CAAf;AACD,GAFD,MAEO,IAAI,QAAJ,EAAc;AACnB,WAAO,gBAAgB,CAAC,QAAD,EAAW,YAAX,CAAvB;AACD,GAL4B,CAO7B;AACA;AACA;;;AACA,SAAO,QAAQ,IAAI,IAAnB;AACD,CAdM;;AAAM,OAAA,CAAA,2BAAA,GAA2B,2BAA3B;AAgBb;;;AAGG;;AACH,MAAM,gBAAgB,GAAG,CAAgB,KAAhB,EAAwC,YAAxC,KAA2F;AAClH,MAAI,CAAC,KAAK,CAAC,cAAN,CAAqB,KAArB,CAAD,IAAgC,KAAK,CAAC,IAAN,KAAe,KAAK,CAAC,QAAzD,EAAmE;AACjE,UAAM,IAAI,KAAJ,CACJ,oEACE,sDAFE,CAAN;AAID;;AAED,MAAI,iBAAA,CAAA,eAAA,CAAgB,KAAhB,CAAJ,EAA4B;AAC1B,UAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAN,CAAY,QAAb,EAAuB,YAAvB,CAAnC;AACA,WAAO,KAAK,CAAC,YAAN,CAAmB,KAAnB,EAA0B,SAA1B,EAAqC,UAArC,CAAP;AACD,GAHD,MAGO;AACL,WAAO,KAAK,CAAC,YAAN,CAAmB,KAAnB,EAA0B,YAA1B,CAAP;AACD;AACF,CAdD","sourceRoot":""}
@@ -1,8 +0,0 @@
1
- /**
2
- * Clamps `value` to a number between the min and max.
3
- *
4
- * @param value - the value to be clamped
5
- * @param min - the lowest valid value
6
- * @param max - the highest valid value
7
- */
8
- export declare const clamp: (value: number, min: number, max: number) => number;
@@ -1,31 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * Given an element tagname and user props, filters the props to only allowed props for the given
4
- * element type.
5
- * @param tagName - Tag name (e.g. "div")
6
- * @param props - Props object
7
- * @param excludedPropNames - List of props to disallow
8
- */
9
- export declare function getNativeElementProps<TAttributes extends React.HTMLAttributes<any>>(tagName: string, props: {}, excludedPropNames?: string[]): TAttributes;
10
- /**
11
- * Splits the native props into ones that go to the `root` slot, and ones that go to the primary slot.
12
- *
13
- * This function is only for use with components that have a primary slot other than `root`.
14
- * Most components should use {@link getNativeElementProps} for their root slot if it is the primary slot.
15
- *
16
- * @returns An object containing the native props for the `root` and primary slots.
17
- */
18
- export declare const getPartitionedNativeProps: <Props extends Pick<React.HTMLAttributes<HTMLElement>, "style" | "className">, ExcludedPropKeys extends Extract<keyof Props, string> = never>({ primarySlotTagName, props, excludedPropNames, }: {
19
- /** The primary slot's element type (e.g. 'div') */
20
- primarySlotTagName: keyof JSX.IntrinsicElements;
21
- /** The component's props object */
22
- props: Props;
23
- /** List of native props to exclude from the returned value */
24
- excludedPropNames?: ExcludedPropKeys[] | undefined;
25
- }) => {
26
- root: {
27
- style: React.CSSProperties | undefined;
28
- className: string | undefined;
29
- };
30
- primary: Omit<Props, ExcludedPropKeys>;
31
- };
@@ -1,4 +0,0 @@
1
- /**
2
- * Finds and swaps a provided key for it's right to left format.
3
- */
4
- export declare const getRTLSafeKey: (key: string, dir: 'ltr' | 'rtl') => string;
@@ -1,25 +0,0 @@
1
- import * as React from 'react';
2
- interface ReactSyntheticEvent extends React.SyntheticEvent<unknown> {
3
- _reactName?: string;
4
- dispatchConfig?: {
5
- registrationName: string;
6
- phasedRegistrationNames: {
7
- bubbled: string;
8
- captured: string;
9
- };
10
- };
11
- }
12
- declare type NonUndefined<A> = A extends undefined ? never : A;
13
- declare type FunctionKeys<T extends object> = {
14
- [K in keyof T]-?: NonUndefined<T[K]> extends Function ? K : never;
15
- }[keyof T];
16
- export declare type ReactCallbackName = FunctionKeys<React.DOMAttributes<unknown>>;
17
- /**
18
- * React.SyntheticEvent contains name of a callback that should be fired, this function returns it.
19
- *
20
- * Ideally, it should also distinguish regular and "capture" callbacks, but it's possible only with React 17 as
21
- * ".eventPhase" there has proper value, see https://github.com/facebook/react/pull/19244. In React 16 all events
22
- * are handled in bubble phase.
23
- */
24
- export declare function getReactCallbackName(event: ReactSyntheticEvent): ReactCallbackName | undefined;
25
- export {};
@@ -1,22 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * Gets the trigger element of a FluentTriggerComponent (such as Tooltip or MenuTrigger).
4
- *
5
- * In the case where the immediate child is itself a FluentTriggerComponent and/or React Fragment,
6
- * it returns the first descendant that is _not_ a FluentTriggerComponent or Fragment.
7
- * This allows multiple triggers to be stacked, and still apply their props to the actual trigger element.
8
- *
9
- * For example, the following returns `<div id="child" />`:
10
- * ```jsx
11
- * getTriggerChild(
12
- * <Tooltip>
13
- * <MenuTrigger>
14
- * <div id="child" />
15
- * </MenuTrigger>
16
- * </Tooltip>
17
- * );
18
- * ```
19
- */
20
- export declare const getTriggerChild: (children: React.ReactNode) => React.ReactElement & {
21
- ref?: React.Ref<unknown>;
22
- };
@@ -1 +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":""}
@@ -1,9 +0,0 @@
1
- export * from './applyTriggerPropsToChildren';
2
- export * from './clamp';
3
- export * from './getNativeElementProps';
4
- export * from './getRTLSafeKey';
5
- export * from './getTriggerChild';
6
- export * from './isFluentTrigger';
7
- export * from './omit';
8
- export * from './properties';
9
- export * from './shouldPreventDefaultOnKeyDown';
@@ -1,22 +0,0 @@
1
- import * as React from 'react';
2
- /**
3
- * Allows a component to be tagged as a FluentUI trigger component.
4
- *
5
- * Triggers are special-case components: they attach event listeners and other props on their child,
6
- * and use them to trigger another component to show. Examples include `MenuTrigger` and `Tooltip`.
7
- *
8
- * A component can be tagged as a trigger as follows:
9
- * ```ts
10
- * const MyComponent: React.FC<MyComponentProps> & FluentTriggerComponent = ...;
11
- *
12
- * MyComponent.isFluentTriggerComponent = true; // MUST also set this to true
13
- * ```
14
- */
15
- export declare type FluentTriggerComponent = {
16
- isFluentTriggerComponent?: boolean;
17
- };
18
- /**
19
- * Checks if a given element is a FluentUI trigger (e.g. `MenuTrigger` or `Tooltip`).
20
- * See the {@link FluentTriggerComponent} type for more info.
21
- */
22
- export declare const isFluentTrigger: (element: React.ReactElement) => boolean | undefined;
@@ -1 +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":""}
@@ -1,14 +0,0 @@
1
- /**
2
- * Tiny helper to do the minimal amount of work in duplicating an object but omitting some
3
- * props. This ends up faster than using object ...rest or reduce to filter.
4
- *
5
- * This behaves very much like filteredAssign, but does not merge many objects together,
6
- * uses an exclusion object map, and avoids spreads all for optimal performance.
7
- *
8
- * See perf test for background:
9
- * https://jsperf.com/omit-vs-rest-vs-reduce/1
10
- *
11
- * @param obj - The object to clone
12
- * @param exclusions - The array of keys to exclude
13
- */
14
- export declare function omit<TObj extends Record<string, any>, Exclusions extends (keyof TObj)[]>(obj: TObj, exclusions: Exclusions): Omit<TObj, Exclusions[number]>;