@fluentui/react-utilities 9.0.0-rc.8 → 9.0.0-rc.9

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/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/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/clamp.d.ts

@@ -1,8 +0,0 @@
-/**
- * Clamps `value` to a number between the min and max.
- *
- * @param value - the value to be clamped
- * @param min - the lowest valid value
- * @param max - the highest valid value
- */
-export declare const clamp: (value: number, min: number, max: number) => number;

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

@@ -1,31 +0,0 @@
-import * as React from 'react';
-/**
- * Given an element tagname and user props, filters the props to only allowed props for the given
- * element type.
- * @param tagName - Tag name (e.g. "div")
- * @param props - Props object
- * @param excludedPropNames - List of props to disallow
- */
-export declare function getNativeElementProps<TAttributes extends React.HTMLAttributes<any>>(tagName: string, props: {}, excludedPropNames?: string[]): TAttributes;
-/**
- * Splits the native props into ones that go to the `root` slot, and ones that go to the primary slot.
- *
- * This function is only for use with components that have a primary slot other than `root`.
- * Most components should use {@link getNativeElementProps} for their root slot if it is the primary slot.
- *
- * @returns An object containing the native props for the `root` and primary slots.
- */
-export declare const getPartitionedNativeProps: <Props extends Pick<React.HTMLAttributes<HTMLElement>, "style" | "className">, ExcludedPropKeys extends Extract<keyof Props, string> = never>({ primarySlotTagName, props, excludedPropNames, }: {
-    /** The primary slot's element type (e.g. 'div') */
-    primarySlotTagName: keyof JSX.IntrinsicElements;
-    /** The component's props object */
-    props: Props;
-    /** List of native props to exclude from the returned value */
-    excludedPropNames?: ExcludedPropKeys[] | undefined;
-}) => {
-    root: {
-        style: React.CSSProperties | undefined;
-        className: string | undefined;
-    };
-    primary: Omit<Props, ExcludedPropKeys>;
-};

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

@@ -1,4 +0,0 @@
-/**
- * Finds and swaps a provided key for it's right to left format.
- */
-export declare const getRTLSafeKey: (key: string, dir: 'ltr' | 'rtl') => string;

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

@@ -1,25 +0,0 @@
-import * as React from 'react';
-interface ReactSyntheticEvent extends React.SyntheticEvent<unknown> {
-    _reactName?: string;
-    dispatchConfig?: {
-        registrationName: string;
-        phasedRegistrationNames: {
-            bubbled: string;
-            captured: string;
-        };
-    };
-}
-declare type NonUndefined<A> = A extends undefined ? never : A;
-declare type FunctionKeys<T extends object> = {
-    [K in keyof T]-?: NonUndefined<T[K]> extends Function ? K : never;
-}[keyof T];
-export declare type ReactCallbackName = FunctionKeys<React.DOMAttributes<unknown>>;
-/**
- * React.SyntheticEvent contains name of a callback that should be fired, this function returns it.
- *
- * Ideally, it should also distinguish regular and "capture" callbacks, but it's possible only with React 17 as
- * ".eventPhase" there has proper value, see https://github.com/facebook/react/pull/19244. In React 16 all events
- * are handled in bubble phase.
- */
-export declare function getReactCallbackName(event: ReactSyntheticEvent): ReactCallbackName | undefined;
-export {};

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

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

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

@@ -1,9 +0,0 @@
-export * from './applyTriggerPropsToChildren';
-export * from './clamp';
-export * from './getNativeElementProps';
-export * from './getRTLSafeKey';
-export * from './getTriggerChild';
-export * from './isFluentTrigger';
-export * from './omit';
-export * from './properties';
-export * from './shouldPreventDefaultOnKeyDown';

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

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

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

@@ -1,14 +0,0 @@
-/**
- * Tiny helper to do the minimal amount of work in duplicating an object but omitting some
- * props. This ends up faster than using object ...rest or reduce to filter.
- *
- * This behaves very much like filteredAssign, but does not merge many objects together,
- * uses an exclusion object map, and avoids spreads all for optimal performance.
- *
- * See perf test for background:
- * https://jsperf.com/omit-vs-rest-vs-reduce/1
- *
- * @param obj - The object to clone
- * @param exclusions - The array of keys to exclude
- */
-export declare function omit<TObj extends Record<string, any>, Exclusions extends (keyof TObj)[]>(obj: TObj, exclusions: Exclusions): Omit<TObj, Exclusions[number]>;

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

@@ -1,160 +0,0 @@
-/**
- * An array of events that are allowed on every html element type.
- *
- * @public
- */
-export declare const baseElementEvents: Record<string, number>;
-/**
- * An array of element attributes which are allowed on every html element type.
- *
- * @public
- */
-export declare const baseElementProperties: Record<string, number>;
-/**
- * An array of HTML element properties and events.
- *
- * @public
- */
-export declare const htmlElementProperties: Record<string, number>;
-/**
- * An array of LABEL tag properties and events.
- *
- * @public
- */
-export declare const labelProperties: Record<string, number>;
-/**
- * An array of AUDIO tag properties and events.
-
- * @public
- */
-export declare const audioProperties: Record<string, number>;
-/**
- * An array of VIDEO tag properties and events.
- *
- * @public
- */
-export declare const videoProperties: Record<string, number>;
-/**
- * An array of OL tag properties and events.
- *
- * @public
- */
-export declare const olProperties: Record<string, number>;
-/**
- * An array of LI tag properties and events.
- *
- * @public
- */
-export declare const liProperties: Record<string, number>;
-/**
- * An array of A tag properties and events.
- *
- * @public
- */
-export declare const anchorProperties: Record<string, number>;
-/**
- * An array of TIME tag properties and events.
- *
- * @public
- */
-export declare const timeProperties: Record<string, number>;
-/**
- * An array of BUTTON tag properties and events.
- *
- * @public
- */
-export declare const buttonProperties: Record<string, number>;
-/**
- * An array of INPUT tag properties and events.
- *
- * @public
- */
-export declare const inputProperties: Record<string, number>;
-/**
- * An array of TEXTAREA tag properties and events.
- *
- * @public
- */
-export declare const textAreaProperties: Record<string, number>;
-/**
- * An array of SELECT tag properties and events.
- *
- * @public
- */
-export declare const selectProperties: Record<string, number>;
-export declare const optionProperties: Record<string, number>;
-/**
- * An array of TABLE tag properties and events.
- *
- * @public
- */
-export declare const tableProperties: Record<string, number>;
-/**
- * An array of TR tag properties and events.
- *
- * @public
- */
-export declare const trProperties: Record<string, number>;
-/**
- * An array of TH tag properties and events.
- *
- * @public
- */
-export declare const thProperties: Record<string, number>;
-/**
- * An array of TD tag properties and events.
- *
- * @public
- */
-export declare const tdProperties: Record<string, number>;
-export declare const colGroupProperties: Record<string, number>;
-export declare const colProperties: Record<string, number>;
-/**
- * An array of FIELDSET tag properties and events.
- *
- * @public
- */
-export declare const fieldsetProperties: Record<string, number>;
-/**
- * An array of FORM tag properties and events.
- *
- * @public
- */
-export declare const formProperties: Record<string, number>;
-/**
- * An array of IFRAME tag properties and events.
- *
- * @public
- */
-export declare const iframeProperties: Record<string, number>;
-/**
- * An array of IMAGE tag properties and events.
- *
- * @public
- */
-export declare const imgProperties: Record<string, number>;
-/**
- * @deprecated Use imgProperties for img elements.
- */
-export declare const imageProperties: Record<string, number>;
-/**
- * An array of DIV tag properties and events.
- *
- * @public
- */
-export declare const divProperties: Record<string, number>;
-/**
- * Gets native supported props for an html element provided the allowance set. Use one of the property
- * sets defined (divProperties, buttonPropertes, etc) to filter out supported properties from a given
- * props set. Note that all data- and aria- prefixed attributes will be allowed.
- * NOTE: getNativeProps should always be applied first when adding props to a react component. The
- * non-native props should be applied second. This will prevent getNativeProps from overriding your custom props.
- * For example, if props passed to getNativeProps has an onClick function and getNativeProps is added to
- * the component after an onClick function is added, then the getNativeProps onClick will override it.
- *
- * @public
- * @param props - The unfiltered input props
- * @param allowedPropsNames - The array or record of allowed prop names.
- * @returns The filtered props
- */
-export declare function getNativeProps<T extends Record<string, any>>(props: Record<string, any>, allowedPropNames: string[] | Record<string, number>, excludedPropNames?: string[]): T;

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

@@ -1,7 +0,0 @@
-import * as React from 'react';
-/**
- * Checks if the keyboard event should preventDefault() for Enter and Spacebar keys
- *
- * Useful for situations where a keydown needs to be transformed to a click event
- */
-export declare function shouldPreventDefaultOnKeyDown(e: KeyboardEvent | React.KeyboardEvent): boolean;