@fluentui/react-utilities 9.0.0-rc.7 → 9.0.0

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

@@ -1,161 +0,0 @@
-import * as React from 'react';
-export declare type SlotRenderFunction<Props> = (Component: React.ElementType<Props>, props: Omit<Props, 'children' | 'as'>) => React.ReactNode;
-/**
- * Matches any component's Slots type (such as ButtonSlots).
- *
- * This should ONLY be used in type templates as in `extends SlotPropsRecord`;
- * it shouldn't be used as a component's Slots type.
- */
-export declare type SlotPropsRecord = Record<string, UnknownSlotProps | SlotShorthandValue | null | undefined>;
-/**
- * The shorthand value of a slot allows specifying its child
- */
-export declare type SlotShorthandValue = React.ReactChild | React.ReactNodeArray | React.ReactPortal;
-/**
- * Matches any slot props type.
- *
- * This should ONLY be used in type templates as in `extends UnknownSlotProps`;
- * it shouldn't be used as the type of a slot.
- */
-export declare type UnknownSlotProps = Pick<React.HTMLAttributes<HTMLElement>, 'children' | 'className' | 'style'> & {
-    as?: keyof JSX.IntrinsicElements;
-};
-/**
- * Helper type for {@link Slot}. Adds shorthand types that are assignable to the slot's `children`.
- */
-declare type WithSlotShorthandValue<Props extends {
-    children?: unknown;
-}> = Props | Extract<SlotShorthandValue, Props['children']>;
-/**
- * Helper type for {@link Slot}. Takes the props we want to support for a slot and adds the ability for `children`
- * to be a render function that takes those props.
- */
-declare type WithSlotRenderFunction<Props extends {
-    children?: unknown;
-}> = Props & {
-    children?: Props['children'] | SlotRenderFunction<Props>;
-};
-/**
- * HTML element types that are not allowed to have children.
- *
- * Reference: https://developer.mozilla.org/en-US/docs/Glossary/Empty_element
- */
-declare type EmptyIntrisicElements = 'area' | 'base' | 'br' | 'col' | 'embed' | 'hr' | 'img' | 'input' | 'link' | 'meta' | 'param' | 'source' | 'track' | 'wbr';
-/**
- * Helper type for {@link Slot}. Modifies `JSX.IntrinsicElements[Type]`:
- * * Removes legacy string ref.
- * * Disallows children for empty tags like 'img'.
- */
-declare type IntrisicElementProps<Type extends keyof JSX.IntrinsicElements> = React.PropsWithRef<JSX.IntrinsicElements[Type]> & (Type extends EmptyIntrisicElements ? {
-    children?: never;
-} : {});
-/**
- * The props type and shorthand value for a slot. Type is either a single intrinsic element like `'div'`,
- * or a component like `typeof Button`.
- *
- * If a slot needs to support multiple intrinsic element types, use the `AlternateAs` param (see examples below).
- *
- * By default, slots can be set to `null` to prevent them from being rendered. If a slot must always be rendered,
- * wrap with `NonNullable` (see examples below).
- *
- * @example
- * ```
- * // Intrinsic element examples:
- * Slot<'div'> // Slot is always div
- * Slot<'button', 'a'> // Defaults to button, but allows as="a" with anchor-specific props
- * Slot<'span', 'div' | 'pre'> // Defaults to span, but allows as="div" or as="pre"
- * NonNullable<Slot<'div'>> // Slot that will always be rendered (can't be set to null by the user)
- *
- * // Component examples:
- * Slot<typeof Button> // Slot is always a Button, and accepts all of Button's Props
- * NonNullable<Slot<typeof Label>> // Slot is a Label and will always be rendered (can't be set to null by the user)
- * ```
- */
-export declare type Slot<Type extends keyof JSX.IntrinsicElements | React.ComponentType | UnknownSlotProps, AlternateAs extends keyof JSX.IntrinsicElements = never> = IsSingleton<Extract<Type, string>> extends true ? WithSlotShorthandValue<Type extends keyof JSX.IntrinsicElements ? {
-    as?: Type;
-} & WithSlotRenderFunction<IntrisicElementProps<Type>> : Type extends React.ComponentType<infer Props> ? WithSlotRenderFunction<Props> : Type> | {
-    [As in AlternateAs]: {
-        as: As;
-    } & WithSlotRenderFunction<IntrisicElementProps<As>>;
-}[AlternateAs] | null : 'Error: First parameter to Slot must not be not a union of types. See documentation of Slot type.';
-/**
- * Evaluates to true if the given type contains exactly one string, or false if it is a union of strings.
- *
- * ```
- * IsSingleton<'a'> // true
- * IsSingleton<'a' | 'b' | 'c'> // false
- * ```
- */
-export declare type IsSingleton<T extends string> = {
-    [K in T]: Exclude<T, K> extends never ? true : false;
-}[T];
-/**
- * Helper type for inferring the type of the as prop from a Props type.
- *
- * For example:
- * ```
- * type Example<T> = T extends AsIntrinsicElement<infer As> ? As : never;
- * ```
- */
-export declare type AsIntrinsicElement<As extends keyof JSX.IntrinsicElements> = {
-    as?: As;
-};
-/**
- * Converts a union type (`A | B | C`) to an intersection type (`A & B & C`)
- */
-export declare type UnionToIntersection<U> = (U extends unknown ? (x: U) => U : never) extends (x: infer I) => U ? I : never;
-/**
- * Removes the 'ref' prop from the given Props type, leaving unions intact (such as the discriminated union created by
- * IntrinsicSlotProps). This allows IntrinsicSlotProps to be used with React.forwardRef.
- *
- * The conditional "extends unknown" (always true) exploits a quirk in the way TypeScript handles conditional
- * types, to prevent unions from being expanded.
- */
-export declare type PropsWithoutRef<P> = 'ref' extends keyof P ? (P extends unknown ? Omit<P, 'ref'> : P) : P;
-/**
- * Removes SlotShorthandValue and null from the slot type, extracting just the slot's Props object.
- */
-export declare type ExtractSlotProps<S> = Exclude<S, SlotShorthandValue | null | undefined>;
-/**
- * Defines the Props type for a component given its slots and the definition of which one is the primary slot,
- * defaulting to root if one is not provided.
- */
-export declare type ComponentProps<Slots extends SlotPropsRecord, Primary extends keyof Slots = 'root'> = Omit<Slots, Primary & 'root'> & PropsWithoutRef<ExtractSlotProps<Slots[Primary]>>;
-/**
- * If type T includes `null`, remove it and add `undefined` instead.
- */
-export declare type ReplaceNullWithUndefined<T> = T extends null ? Exclude<T, null> | undefined : T;
-/**
- * Defines the State object of a component given its slots.
- */
-export declare type ComponentState<Slots extends SlotPropsRecord> = {
-    components: {
-        [Key in keyof Slots]-?: React.ComponentType<ExtractSlotProps<Slots[Key]>> | (ExtractSlotProps<Slots[Key]> extends AsIntrinsicElement<infer As> ? As : keyof JSX.IntrinsicElements);
-    };
-} & {
-    [Key in keyof Slots]: ReplaceNullWithUndefined<Exclude<Slots[Key], SlotShorthandValue | (Key extends 'root' ? null : never)>>;
-};
-/**
- * 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;
-/**
- * Helper type to correctly define the slot class names object.
- */
-export declare type SlotClassNames<Slots> = {
-    [SlotName in keyof Slots]-?: string;
-};
-export {};

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

@@ -1,16 +0,0 @@
-export * from './useBoolean';
-export * from './useConst';
-export * from './useControllableState';
-export * from './useEventCallback';
-export * from './useFirstMount';
-export * from './useForceUpdate';
-export * from './useId';
-export * from './useIsomorphicLayoutEffect';
-export * from './useMergedEventCallbacks';
-export * from './useMergedRefs';
-export * from './useMount';
-export * from './useOnClickOutside';
-export * from './useOnScrollOutside';
-export * from './usePrevious';
-export * from './useTimeout';
-export * from './useUnmount';

package/lib-commonjs/hooks/useBoolean.d.ts

@@ -1,17 +0,0 @@
-/** Updater callbacks returned by `useBoolean`. */
-export declare type UseBooleanCallbacks = {
-    /** Set the value to true. Always has the same identity. */
-    setTrue: () => void;
-    /** Set the value to false. Always has the same identity. */
-    setFalse: () => void;
-    /** Toggle the value. Always has the same identity. */
-    toggle: () => void;
-};
-/**
- * Hook to store a value and generate callbacks for setting the value to true or false.
- * The identity of the callbacks will always stay the same.
- *
- * @param initialState - Initial value
- * @returns Array with the current value and an object containing the updater callbacks.
- */
-export declare function useBoolean(initialState: boolean): [boolean, UseBooleanCallbacks];

package/lib-commonjs/hooks/useBoolean.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useBoolean = void 0;
-
-const React = /*#__PURE__*/require("react");
-
-const useConst_1 = /*#__PURE__*/require("./useConst");
-/**
- * Hook to store a value and generate callbacks for setting the value to true or false.
- * The identity of the callbacks will always stay the same.
- *
- * @param initialState - Initial value
- * @returns Array with the current value and an object containing the updater callbacks.
- */
-
-
-function useBoolean(initialState) {
-  const [value, setValue] = React.useState(initialState);
-  const setTrue = useConst_1.useConst(() => () => {
-    setValue(true);
-  });
-  const setFalse = useConst_1.useConst(() => () => {
-    setValue(false);
-  });
-  const toggle = useConst_1.useConst(() => () => {
-    setValue(currentValue => !currentValue);
-  });
-  return [value, {
-    setTrue,
-    setFalse,
-    toggle
-  }];
-}
-
-exports.useBoolean = useBoolean;
-//# sourceMappingURL=useBoolean.js.map

package/lib-commonjs/hooks/useBoolean.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["hooks/useBoolean.ts"],"names":[],"mappings":";;;;;;;AAAA,MAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;;AACA,MAAA,UAAA,gBAAA,OAAA,CAAA,YAAA,CAAA;AAYA;;;;;;AAMG;;;AACH,SAAgB,UAAhB,CAA2B,YAA3B,EAAgD;AAC9C,QAAM,CAAC,KAAD,EAAQ,QAAR,IAAoB,KAAK,CAAC,QAAN,CAAe,YAAf,CAA1B;AAEA,QAAM,OAAO,GAAG,UAAA,CAAA,QAAA,CAAS,MAAM,MAAK;AAClC,IAAA,QAAQ,CAAC,IAAD,CAAR;AACD,GAFe,CAAhB;AAGA,QAAM,QAAQ,GAAG,UAAA,CAAA,QAAA,CAAS,MAAM,MAAK;AACnC,IAAA,QAAQ,CAAC,KAAD,CAAR;AACD,GAFgB,CAAjB;AAGA,QAAM,MAAM,GAAG,UAAA,CAAA,QAAA,CAAS,MAAM,MAAK;AACjC,IAAA,QAAQ,CAAC,YAAY,IAAI,CAAC,YAAlB,CAAR;AACD,GAFc,CAAf;AAIA,SAAO,CAAC,KAAD,EAAQ;AAAE,IAAA,OAAF;AAAW,IAAA,QAAX;AAAqB,IAAA;AAArB,GAAR,CAAP;AACD;;AAdD,OAAA,CAAA,UAAA,GAAA,UAAA","sourcesContent":["import * as React from 'react';\nimport { useConst } from './useConst';\n\n/** Updater callbacks returned by `useBoolean`. */\nexport type UseBooleanCallbacks = {\n  /** Set the value to true. Always has the same identity. */\n  setTrue: () => void;\n  /** Set the value to false. Always has the same identity. */\n  setFalse: () => void;\n  /** Toggle the value. Always has the same identity. */\n  toggle: () => void;\n};\n\n/**\n * Hook to store a value and generate callbacks for setting the value to true or false.\n * The identity of the callbacks will always stay the same.\n *\n * @param initialState - Initial value\n * @returns Array with the current value and an object containing the updater callbacks.\n */\nexport function useBoolean(initialState: boolean): [boolean, UseBooleanCallbacks] {\n  const [value, setValue] = React.useState(initialState);\n\n  const setTrue = useConst(() => () => {\n    setValue(true);\n  });\n  const setFalse = useConst(() => () => {\n    setValue(false);\n  });\n  const toggle = useConst(() => () => {\n    setValue(currentValue => !currentValue);\n  });\n\n  return [value, { setTrue, setFalse, toggle }];\n}\n"],"sourceRoot":"../src/"}

package/lib-commonjs/hooks/useConst.d.ts

@@ -1,12 +0,0 @@
-/**
- * Hook to initialize and return a constant value. Unlike `React.useMemo`, this is guaranteed to
- * always return the same value (and if the initializer is a function, only call it once).
- * This is similar to setting a private member in a class constructor.
- *
- * If the value should ever change based on dependencies, use `React.useMemo` instead.
- *
- * @param initialValue - Initial value, or function to get the initial value. Similar to `useState`,
- * only the value/function passed in the first time this is called is respected.
- * @returns The value. The identity of this value will always be the same.
- */
-export declare function useConst<T>(initialValue: T | (() => T)): T;

package/lib-commonjs/hooks/useConst.js

@@ -1,40 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useConst = void 0;
-
-const React = /*#__PURE__*/require("react");
-/**
- * Hook to initialize and return a constant value. Unlike `React.useMemo`, this is guaranteed to
- * always return the same value (and if the initializer is a function, only call it once).
- * This is similar to setting a private member in a class constructor.
- *
- * If the value should ever change based on dependencies, use `React.useMemo` instead.
- *
- * @param initialValue - Initial value, or function to get the initial value. Similar to `useState`,
- * only the value/function passed in the first time this is called is respected.
- * @returns The value. The identity of this value will always be the same.
- */
-
-
-function useConst(initialValue) {
-  // Use useRef to store the value because it's the least expensive built-in hook that works here
-  // (we could also use `const [value] = React.useState(initialValue)` but that's more expensive
-  // internally due to reducer handling which we don't need)
-  const ref = React.useRef();
-
-  if (ref.current === undefined) {
-    // Box the value in an object so we can tell if it's initialized even if the initializer
-    // returns/is undefined
-    ref.current = {
-      value: typeof initialValue === 'function' ? initialValue() : initialValue
-    };
-  }
-
-  return ref.current.value;
-}
-
-exports.useConst = useConst;
-//# sourceMappingURL=useConst.js.map

package/lib-commonjs/hooks/useConst.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["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","sourcesContent":["import * as React from 'react';\n\n/**\n * Hook to initialize and return a constant value. Unlike `React.useMemo`, this is guaranteed to\n * always return the same value (and if the initializer is a function, only call it once).\n * This is similar to setting a private member in a class constructor.\n *\n * If the value should ever change based on dependencies, use `React.useMemo` instead.\n *\n * @param initialValue - Initial value, or function to get the initial value. Similar to `useState`,\n * only the value/function passed in the first time this is called is respected.\n * @returns The value. The identity of this value will always be the same.\n */\nexport function useConst<T>(initialValue: T | (() => T)): T {\n  // Use useRef to store the value because it's the least expensive built-in hook that works here\n  // (we could also use `const [value] = React.useState(initialValue)` but that's more expensive\n  // internally due to reducer handling which we don't need)\n  const ref = React.useRef<{ value: T }>();\n  if (ref.current === undefined) {\n    // Box the value in an object so we can tell if it's initialized even if the initializer\n    // returns/is undefined\n    ref.current = {\n      value: typeof initialValue === 'function' ? (initialValue as Function)() : initialValue,\n    };\n  }\n  return ref.current.value;\n}\n"],"sourceRoot":"../src/"}

package/lib-commonjs/hooks/useControllableState.d.ts

@@ -1,31 +0,0 @@
-import * as React from 'react';
-export declare type UseControllableStateOptions<State> = {
-    /**
-     * User-provided default state or initializer, for uncontrolled usage.
-     */
-    defaultState?: State | (() => State);
-    /**
-     * User-provided controlled state. `undefined` means internal state will be used.
-     */
-    state: State | undefined;
-    /**
-     * Used as the initial state if `state` and `defaultState` are both `undefined`.
-     * If `undefined` is the correct initial state, pass that here.
-     */
-    initialState: State;
-};
-/**
- * A `useState`-like hook to manage a value that could be either controlled or uncontrolled,
- * such as a checked state or text input string.
- *
- * Unlike `setState`, it's okay to call the returned updater (dispatch) function for either a
- * controlled or uncontrolled component. Calls will only be respected if the component is uncontrolled.
- *
- * @returns Same as [`useState`](https://reactjs.org/docs/hooks-reference.html#usestate): an array
- * of the current value and an updater (dispatch) function. The updater function is referentially
- * stable (won't change during the component's lifecycle). It can take either a new value, or a
- * function which is passed the previous value and returns the new value. Unlike `setState`, calls
- * to the updater function will only be respected if the component is uncontrolled.
- * @see https://reactjs.org/docs/uncontrolled-components.html
- */
-export declare const useControllableState: <State>(options: UseControllableStateOptions<State>) => [State, React.Dispatch<React.SetStateAction<State>>];

package/lib-commonjs/hooks/useEventCallback.d.ts

@@ -1,13 +0,0 @@
-/**
- * https://reactjs.org/docs/hooks-faq.html#how-to-read-an-often-changing-value-from-usecallback
- *
- * Modified `useCallback` that can be used when dependencies change too frequently. Can occur when
- * e.g. user props are dependencies which could change on every render
- * e.g. volatile values (i.e. useState/useDispatch) are dependencies which could change frequently
- *
- * This should not be used often, but can be a useful re-render optimization since the callback is a ref and
- * will not be invalidated between re-renders
- *
- * @param fn - The callback function that will be used
- */
-export declare const useEventCallback: <Args extends unknown[], Return>(fn: (...args: Args) => Return) => (...args: Args) => Return;

package/lib-commonjs/hooks/useFirstMount.d.ts

@@ -1,11 +0,0 @@
-/**
- * Checks if components was mounted the first time.
- * Since concurrent mode will be released in the future this needs to be verified
- * Currently (React 17) will always render the initial mount once
- * https://codesandbox.io/s/heuristic-brook-s4w0q?file=/src/App.jsx
- * https://codesandbox.io/s/holy-grass-8nieu?file=/src/App.jsx
- *
- * @example
- * const isFirstMount = useFirstMount();
- */
-export declare function useFirstMount(): boolean;

package/lib-commonjs/hooks/useForceUpdate.d.ts

@@ -1,4 +0,0 @@
-/**
- * Forces a re-render, similar to `forceUpdate` in class components.
- */
-export declare function useForceUpdate(): import("react").DispatchWithoutAction;

package/lib-commonjs/hooks/useId.d.ts

@@ -1,15 +0,0 @@
-/**
- * Resets generated IDs, should be used only in tests.
- *
- * @private
- */
-export declare function resetIdsForTests(): void;
-/**
- * Hook to generate a unique ID.
- *
- * @param prefix - Optional prefix for the ID. Defaults to 'fui-'.
- * @param providedId - Optional id provided by a parent component. Defaults to the provided value if present,
- *  without conditioning the hook call
- * @returns The ID
- */
-export declare function useId(prefix?: string, providedId?: string): string;

package/lib-commonjs/hooks/useIsomorphicLayoutEffect.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-/**
- * React currently throws a warning when using useLayoutEffect on the server. To get around it, we can conditionally
- * useEffect on the server (no-op) and useLayoutEffect in the browser. We occasionally need useLayoutEffect to
- * ensure we don't get a render flash for certain operations, but we may also need affected components to render on
- * the server.
- *
- * https://gist.github.com/gaearon/e7d97cdf38a2907924ea12e4ebdf3c85
- * https://github.com/reduxjs/react-redux/blob/master/src/utils/useIsomorphicLayoutEffect.js
- */
-export declare const useIsomorphicLayoutEffect: typeof React.useEffect;

package/lib-commonjs/hooks/useMergedEventCallbacks.d.ts

@@ -1,18 +0,0 @@
-/**
- * Combine two event callbacks into a single callback function that calls each one in order.
- *
- * This is useful to add an event listener to an existing element without overwriting the current listener, if any.
- *
- * For example:
- * ```ts
- * state.slot.onChange = useMergedCallbacks(state.slot.onChange, ev => {
- *   // Handle onChange
- * });
- * ```
- *
- * @param callback1 - The first callback to be called
- * @param callback2 - The second callback to be called
- *
- * @returns An event callback that calls the callbacks in order, and is stable between renders
- */
-export declare function useMergedEventCallbacks<Args extends unknown[]>(callback1: ((...args: Args) => void) | undefined, callback2: ((...args: Args) => void) | undefined): (...args: Args) => void;

package/lib-commonjs/hooks/useMergedRefs.d.ts

@@ -1,13 +0,0 @@
-import * as React from 'react';
-/**
- * A Ref function which can be treated like a ref object in that it has an attached
- * current property, which will be updated as the ref is evaluated.
- */
-export declare type RefObjectFunction<T> = React.RefObject<T> & ((value: T) => void);
-/**
- * React hook to merge multiple React refs (either MutableRefObjects or ref callbacks) into a single ref callback that
- * updates all provided refs
- * @param refs - Refs to collectively update with one ref value.
- * @returns A function with an attached "current" prop, so that it can be treated like a RefObject.
- */
-export declare function useMergedRefs<T>(...refs: (React.Ref<T> | undefined)[]): RefObjectFunction<T>;

package/lib-commonjs/hooks/useMount.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hook which asynchronously executes a callback once the component has been mounted.
- *
- * @param callback - Function to call before mount.
- */
-export declare const useMount: (callback: () => void) => void;

package/lib-commonjs/hooks/useMount.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useMount = void 0;
-
-const React = /*#__PURE__*/require("react");
-/**
- * Hook which asynchronously executes a callback once the component has been mounted.
- *
- * @param callback - Function to call before mount.
- */
-
-
-const useMount = callback => {
-  const mountRef = React.useRef(callback);
-  mountRef.current = callback;
-  React.useEffect(() => {
-    var _a;
-
-    (_a = mountRef.current) === null || _a === void 0 ? void 0 : _a.call(mountRef);
-  }, []);
-};
-
-exports.useMount = useMount;
-//# sourceMappingURL=useMount.js.map

package/lib-commonjs/hooks/useMount.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["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","sourcesContent":["import * as React from 'react';\n\n/**\n * Hook which asynchronously executes a callback once the component has been mounted.\n *\n * @param callback - Function to call before mount.\n */\nexport const useMount = (callback: () => void) => {\n  const mountRef = React.useRef(callback);\n  mountRef.current = callback;\n  React.useEffect(() => {\n    mountRef.current?.();\n  }, []);\n};\n"],"sourceRoot":"../src/"}

package/lib-commonjs/hooks/useOnClickOutside.d.ts

@@ -1,29 +0,0 @@
-import * as React from 'react';
-export declare type UseOnClickOrScrollOutsideOptions = {
-    /**
-     * The element to listen for the click event
-     */
-    element: Document | undefined;
-    /**
-     * Refs to elements that check if the click is outside
-     */
-    refs: React.MutableRefObject<HTMLElement | undefined | null>[];
-    /**
-     * By default uses element.contains, but custom contain function can be provided
-     * @param parentRef - provided parent ref
-     * @param child - event target element
-     */
-    contains?(parent: HTMLElement | null, child: HTMLElement): boolean;
-    /**
-     * Disables event listeners
-     */
-    disabled?: boolean;
-    /**
-     * Called if the click is outside the element refs
-     */
-    callback: (ev: MouseEvent | TouchEvent) => void;
-};
-/**
- * Utility to perform checks where a click/touch event was made outside a component
- */
-export declare const useOnClickOutside: (options: UseOnClickOrScrollOutsideOptions) => void;

package/lib-commonjs/hooks/useOnScrollOutside.d.ts

@@ -1,5 +0,0 @@
-import type { UseOnClickOrScrollOutsideOptions } from './useOnClickOutside';
-/**
- * Utility to perform checks where a click/touch event was made outside a component
- */
-export declare const useOnScrollOutside: (options: UseOnClickOrScrollOutsideOptions) => void;

package/lib-commonjs/hooks/usePrevious.d.ts

@@ -1 +0,0 @@
-export declare const usePrevious: <ValueType = unknown>(value: ValueType) => ValueType | null;

package/lib-commonjs/hooks/useTimeout.d.ts

@@ -1,8 +0,0 @@
-/**
- * Helper to manage a browser timeout.
- * Ensures that the timeout isn't set multiple times at once,
- * and is cleaned up when the component is unloaded.
- *
- * @returns A pair of [setTimeout, clearTimeout] that are stable between renders.
- */
-export declare function useTimeout(): readonly [(fn: () => void, delay: number) => void, () => void];

package/lib-commonjs/hooks/useUnmount.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hook which synchronously executes a callback when the component is about to unmount.
- *
- * @param callback - Function to call during unmount.
- */
-export declare const useUnmount: (callback: () => void) => void;

package/lib-commonjs/hooks/useUnmount.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useUnmount = void 0;
-
-const React = /*#__PURE__*/require("react");
-/**
- * Hook which synchronously executes a callback when the component is about to unmount.
- *
- * @param callback - Function to call during unmount.
- */
-
-
-const useUnmount = callback => {
-  const unmountRef = React.useRef(callback);
-  unmountRef.current = callback;
-  React.useEffect(() => () => {
-    var _a;
-
-    (_a = unmountRef.current) === null || _a === void 0 ? void 0 : _a.call(unmountRef);
-  }, []);
-};
-
-exports.useUnmount = useUnmount;
-//# sourceMappingURL=useUnmount.js.map

package/lib-commonjs/hooks/useUnmount.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["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","sourcesContent":["import * as React from 'react';\n\n/**\n * Hook which synchronously executes a callback when the component is about to unmount.\n *\n * @param callback - Function to call during unmount.\n */\nexport const useUnmount = (callback: () => void) => {\n  const unmountRef = React.useRef(callback);\n  unmountRef.current = callback;\n  React.useEffect(\n    () => () => {\n      unmountRef.current?.();\n    },\n    [],\n  );\n};\n"],"sourceRoot":"../src/"}

package/lib-commonjs/index.d.ts

@@ -1,8 +0,0 @@
-export { getSlots, resolveShorthand } from './compose/index';
-export type { AsIntrinsicElement, ComponentProps, ComponentState, ExtractSlotProps, ForwardRefComponent, IsSingleton, PropsWithoutRef, ReplaceNullWithUndefined, ResolveShorthandFunction, ResolveShorthandOptions, Slot, Slots, SlotClassNames, SlotPropsRecord, SlotRenderFunction, SlotShorthandValue, UnionToIntersection, UnknownSlotProps, } from './compose/index';
-export { resetIdsForTests, useBoolean, useConst, useControllableState, useEventCallback, useFirstMount, useForceUpdate, useId, useIsomorphicLayoutEffect, useMergedEventCallbacks, useMergedRefs, useMount, useOnClickOutside, useOnScrollOutside, usePrevious, useTimeout, useUnmount, } from './hooks/index';
-export type { RefObjectFunction, UseBooleanCallbacks, UseControllableStateOptions, UseOnClickOrScrollOutsideOptions, } from './hooks/index';
-export { canUseDOM, defaultSSRContextValue, useIsSSR, useSSRContext, SSRContext, SSRProvider } from './ssr/index';
-export type { SSRContextValue } from './ssr/index';
-export { anchorProperties, applyTriggerPropsToChildren, audioProperties, baseElementEvents, baseElementProperties, buttonProperties, clamp, colGroupProperties, colProperties, divProperties, fieldsetProperties, formProperties, getNativeElementProps, getNativeProps, getPartitionedNativeProps, getRTLSafeKey, getTriggerChild, htmlElementProperties, iframeProperties, imageProperties, imgProperties, inputProperties, isFluentTrigger, labelProperties, liProperties, olProperties, omit, optionProperties, selectProperties, shouldPreventDefaultOnKeyDown, tableProperties, tdProperties, textAreaProperties, thProperties, trProperties, videoProperties, } from './utils/index';
-export type { FluentTriggerComponent } from './utils/index';

package/lib-commonjs/ssr/SSRContext.d.ts

@@ -1,33 +0,0 @@
-import * as React from 'react';
-/**
- * To support SSR, the auto incrementing id counter is stored in a context. This allows it to be reset on every request
- * to ensure the client and server are consistent.
- *
- * @internal
- */
-export declare type SSRContextValue = {
-    current: number;
-};
-/**
- * Default context value to use in case there is no SSRProvider. This is fine for client-only apps.
- *
- * @internal
- */
-export declare const defaultSSRContextValue: SSRContextValue;
-export declare const SSRContext: React.Context<SSRContextValue>;
-/**
- * @internal
- */
-export declare function useSSRContext(): SSRContextValue;
-/**
- * When using SSR with Fluent UI, applications must be wrapped in an SSRProvider. This ensures that auto generated ids
- * are consistent between the client and server.
- *
- * @public
- */
-export declare const SSRProvider: React.FC;
-/**
- * Returns whether the component is currently being server side rendered or hydrated on the client. Can be used to delay
- * browser-specific rendering until after hydration. May cause re-renders on a client when is used within SSRProvider.
- */
-export declare function useIsSSR(): boolean;

package/lib-commonjs/ssr/canUseDOM.d.ts

@@ -1,4 +0,0 @@
-/**
- * Verifies if an application can use DOM.
- */
-export declare function canUseDOM(): boolean;

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

@@ -1,2 +0,0 @@
-export * from './canUseDOM';
-export * from './SSRContext';

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

@@ -1,5 +0,0 @@
-import * as React from 'react';
-/**
- * Apply the trigger props to the children, either by calling the render function, or cloning with the new props.
- */
-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;

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

@@ -1 +0,0 @@
-{"version":3,"sources":["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","sourcesContent":["import * as React from 'react';\nimport { isFluentTrigger } from './isFluentTrigger';\n\n/**\n * Apply the trigger props to the children, either by calling the render function, or cloning with the new props.\n */\nexport const applyTriggerPropsToChildren = <TTriggerProps>(\n  children: React.ReactElement | ((props: TTriggerProps) => React.ReactElement | null) | null | undefined,\n  triggerProps: TTriggerProps,\n): React.ReactElement | null => {\n  if (typeof children === 'function') {\n    return children(triggerProps);\n  } else if (children) {\n    return cloneTriggerTree(children, triggerProps);\n  }\n\n  // Components in React should return either JSX elements or \"null\", otherwise React will throw:\n  //   Nothing was returned from render.\n  //   This usually means a return statement is missing. Or, to render nothing, return null.\n  return children || null;\n};\n\n/**\n * Clones a React element tree, and applies the given props to the first grandchild that is not\n * a FluentTriggerComponent or React Fragment (the same element returned by {@link getTriggerChild}).\n */\nconst cloneTriggerTree = <TTriggerProps>(child: React.ReactNode, triggerProps: TTriggerProps): React.ReactElement => {\n  if (!React.isValidElement(child) || child.type === React.Fragment) {\n    throw new Error(\n      'A trigger element must be a single element for this component. ' +\n        \"Please ensure that you're not using React Fragments.\",\n    );\n  }\n\n  if (isFluentTrigger(child)) {\n    const grandchild = cloneTriggerTree(child.props.children, triggerProps);\n    return React.cloneElement(child, undefined, grandchild);\n  } else {\n    return React.cloneElement(child, triggerProps);\n  }\n};\n"],"sourceRoot":"../src/"}