@fluentui/react-menu 0.0.0-nightly-20220429-0418.1 → 0.0.0-nightly-20220504-0420.1

package/lib-commonjs/components/MenuPopover/useMenuPopover.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-import { MenuPopoverProps, MenuPopoverState } from './MenuPopover.types';
-/**
- * Create the state required to render MenuPopover.
- *
- * The returned state can be modified with hooks such as useMenuPopoverStyles_unstable,
- * before being passed to renderMenuPopover_unstable.
- *
- * @param props - props from this instance of MenuPopover
- * @param ref - reference to root HTMLElement of MenuPopover
- */
-export declare const useMenuPopover_unstable: (props: MenuPopoverProps, ref: React.Ref<HTMLElement>) => MenuPopoverState;

package/lib-commonjs/components/MenuPopover/useMenuPopoverStyles.d.ts

@@ -1,11 +0,0 @@
-import type { MenuPopoverSlots, MenuPopoverState } from './MenuPopover.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `menuPopoverClassNames.root` instead.
- */
-export declare const menuPopoverClassName = "fui-MenuPopover";
-export declare const menuPopoverClassNames: SlotClassNames<MenuPopoverSlots>;
-/**
- * Apply styling to the Menu slots based on the state
- */
-export declare const useMenuPopoverStyles_unstable: (state: MenuPopoverState) => MenuPopoverState;

package/lib-commonjs/components/MenuSplitGroup/MenuSplitGroup.d.ts

@@ -1,6 +0,0 @@
-import type { MenuSplitGroupProps } from './MenuSplitGroup.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-/**
- * Layout wrapper that provides extra keyboard navigation behavior for two `MenuItem` components.
- */
-export declare const MenuSplitGroup: ForwardRefComponent<MenuSplitGroupProps>;

package/lib-commonjs/components/MenuSplitGroup/MenuSplitGroup.types.d.ts

@@ -1,14 +0,0 @@
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-export declare type MenuSplitGroupSlots = {
-    root: Slot<'div'>;
-};
-declare type MenuSplitGroupCommons = {};
-/**
- * MenuSplitGroup Props
- */
-export declare type MenuSplitGroupProps = ComponentProps<MenuSplitGroupSlots> & MenuSplitGroupCommons;
-/**
- * State used in rendering MenuSplitGroup
- */
-export declare type MenuSplitGroupState = ComponentState<MenuSplitGroupSlots> & MenuSplitGroupCommons;
-export {};

package/lib-commonjs/components/MenuSplitGroup/index.d.ts

@@ -1,5 +0,0 @@
-export * from './MenuSplitGroup';
-export * from './MenuSplitGroup.types';
-export * from './renderMenuSplitGroup';
-export * from './useMenuSplitGroup';
-export * from './useMenuSplitGroupStyles';

package/lib-commonjs/components/MenuSplitGroup/renderMenuSplitGroup.d.ts

@@ -1,5 +0,0 @@
-import type { MenuSplitGroupState } from './MenuSplitGroup.types';
-/**
- * Render the final JSX of MenuSplitGroup
- */
-export declare const renderMenuSplitGroup_unstable: (state: MenuSplitGroupState) => JSX.Element;

package/lib-commonjs/components/MenuSplitGroup/useMenuSplitGroup.d.ts

@@ -1,12 +0,0 @@
-import * as React from 'react';
-import type { MenuSplitGroupProps, MenuSplitGroupState } from './MenuSplitGroup.types';
-/**
- * Create the state required to render MenuSplitGroup.
- *
- * The returned state can be modified with hooks such as useMenuSplitGroupStyles_unstable,
- * before being passed to renderMenuSplitGroup_unstable.
- *
- * @param props - props from this instance of MenuSplitGroup
- * @param ref - reference to root HTMLElement of MenuSplitGroup
- */
-export declare const useMenuSplitGroup_unstable: (props: MenuSplitGroupProps, ref: React.Ref<HTMLElement>) => MenuSplitGroupState;

package/lib-commonjs/components/MenuSplitGroup/useMenuSplitGroupStyles.d.ts

@@ -1,11 +0,0 @@
-import type { MenuSplitGroupSlots, MenuSplitGroupState } from './MenuSplitGroup.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `menuSplitGroupClassNames.root` instead.
- */
-export declare const menuSplitGroupClassName = "fui-MenuSplitGroup";
-export declare const menuSplitGroupClassNames: SlotClassNames<MenuSplitGroupSlots>;
-/**
- * Apply styling to the MenuSplitGroup slots based on the state
- */
-export declare const useMenuSplitGroupStyles_unstable: (state: MenuSplitGroupState) => MenuSplitGroupState;

package/lib-commonjs/components/MenuTrigger/MenuTrigger.d.ts

@@ -1,8 +0,0 @@
-import * as React from 'react';
-import type { MenuTriggerProps } from './MenuTrigger.types';
-import type { FluentTriggerComponent } from '@fluentui/react-utilities';
-/**
- * Wraps a trigger element as an only child
- * and adds the necessary event handling to open a popup menu
- */
-export declare const MenuTrigger: React.FC<MenuTriggerProps> & FluentTriggerComponent;

package/lib-commonjs/components/MenuTrigger/MenuTrigger.types.d.ts

@@ -1,20 +0,0 @@
-import * as React from 'react';
-export declare type MenuTriggerProps = {
-    /**
-     * Explicitly require single child or render function
-     */
-    children: (React.ReactElement & {
-        ref?: React.Ref<unknown>;
-    }) | ((props: MenuTriggerChildProps) => React.ReactElement | null);
-};
-/**
- * Props that are passed to the child of the MenuTrigger when cloned to ensure correct behaviour for the Menu
- */
-export declare type MenuTriggerChildProps = Required<Pick<React.HTMLAttributes<HTMLElement>, 'onClick' | 'onMouseEnter' | 'onMouseLeave' | 'onMouseMove' | 'onContextMenu' | 'onKeyDown' | 'aria-haspopup' | 'id'>> & {
-    ref?: React.Ref<never>;
-    'aria-expanded': boolean | undefined;
-};
-export declare type MenuTriggerState = {
-    children: React.ReactElement | null;
-    isSubmenu: boolean;
-};

package/lib-commonjs/components/MenuTrigger/index.d.ts

@@ -1,4 +0,0 @@
-export * from './MenuTrigger';
-export * from './MenuTrigger.types';
-export * from './renderMenuTrigger';
-export * from './useMenuTrigger';

package/lib-commonjs/components/MenuTrigger/renderMenuTrigger.d.ts

@@ -1,7 +0,0 @@
-import type { MenuTriggerState } from './MenuTrigger.types';
-/**
- * Render the final JSX of MenuTrigger
- *
- * Only renders children
- */
-export declare const renderMenuTrigger_unstable: (state: MenuTriggerState) => JSX.Element;

package/lib-commonjs/components/MenuTrigger/useMenuTrigger.d.ts

@@ -1,8 +0,0 @@
-import { MenuTriggerProps, MenuTriggerState } from './MenuTrigger.types';
-/**
- * Create the state required to render MenuTrigger.
- * Clones the only child component and adds necessary event handling behaviours to open a popup menu
- *
- * @param props - props from this instance of MenuTrigger
- */
-export declare const useMenuTrigger_unstable: (props: MenuTriggerProps) => MenuTriggerState;

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

@@ -1,2 +0,0 @@
-export * from './MenuItem/index';
-export * from './MenuList/index';

package/lib-commonjs/contexts/menuContext.d.ts

@@ -1,16 +0,0 @@
-import * as React from 'react';
-import type { ContextSelector, Context } from '@fluentui/react-context-selector';
-import type { MenuListProps } from '../components/index';
-import type { MenuState } from '../components/Menu/index';
-export declare const MenuContext: Context<MenuContextValue>;
-/**
- * Context shared between Menu and its children components
- *
- * Extends and drills down MenuList props to simplify API
- */
-export declare type MenuContextValue = MenuListProps & Pick<MenuState, 'openOnHover' | 'openOnContext' | 'triggerRef' | 'menuPopoverRef' | 'setOpen' | 'isSubmenu' | 'triggerId' | 'hasIcons' | 'hasCheckmarks' | 'persistOnItemClick' | 'inline'> & {
-    open: boolean;
-    triggerId: string;
-};
-export declare const MenuProvider: React.Provider<MenuContextValue> & React.FC<React.ProviderProps<MenuContextValue>>;
-export declare const useMenuContext_unstable: <T>(selector: ContextSelector<MenuContextValue, T>) => T;

package/lib-commonjs/contexts/menuGroupContext.d.ts

@@ -1,13 +0,0 @@
-import * as React from 'react';
-/**
- * Context used to guarantee correct aria-relationship between header
- * and group information
- */
-export declare type MenuGroupContextValue = {
-    /**
-     * Element id applied to the `MenuGroupHeader` component
-     */
-    headerId: string;
-};
-export declare const MenuGroupContextProvider: React.Provider<MenuGroupContextValue>;
-export declare const useMenuGroupContext_unstable: () => MenuGroupContextValue;

package/lib-commonjs/contexts/menuListContext.d.ts

@@ -1,15 +0,0 @@
-import * as React from 'react';
-import type { ContextSelector, Context } from '@fluentui/react-context-selector';
-import type { SelectableHandler } from '../selectable/index';
-import type { MenuListProps } from '../components/index';
-export declare const MenuListContext: Context<MenuListContextValue>;
-/**
- * Context shared between MenuList and its children components
- */
-export declare type MenuListContextValue = Pick<MenuListProps, 'checkedValues' | 'onCheckedValueChange' | 'hasIcons' | 'hasCheckmarks'> & {
-    setFocusByFirstCharacter?: (e: React.KeyboardEvent<HTMLElement>, itemEl: HTMLElement) => void;
-    toggleCheckbox?: SelectableHandler;
-    selectRadio?: SelectableHandler;
-};
-export declare const MenuListProvider: React.Provider<MenuListContextValue> & React.FC<React.ProviderProps<MenuListContextValue>>;
-export declare const useMenuListContext_unstable: <T>(selector: ContextSelector<MenuListContextValue, T>) => T;

package/lib-commonjs/contexts/menuTriggerContext.d.ts

@@ -1,3 +0,0 @@
-import * as React from 'react';
-export declare const MenuTriggerContextProvider: React.Provider<boolean>;
-export declare const useMenuTriggerContext_unstable: () => boolean;

package/lib-commonjs/index.d.ts

@@ -1,16 +0,0 @@
-export * from './contexts/menuContext';
-export * from './contexts/menuTriggerContext';
-export * from './contexts/menuGroupContext';
-export * from './contexts/menuListContext';
-export * from './Menu';
-export * from './MenuDivider';
-export * from './MenuGroup';
-export * from './MenuGroupHeader';
-export * from './MenuItem';
-export * from './MenuItemCheckbox';
-export * from './MenuItemRadio';
-export * from './MenuList';
-export * from './MenuPopover';
-export * from './MenuSplitGroup';
-export * from './MenuTrigger';
-export * from './selectable/index';

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

@@ -1,2 +0,0 @@
-export * from './useCheckmarkStyles';
-export * from './types';

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

@@ -1,34 +0,0 @@
-import * as React from 'react';
-export declare type SelectableHandler = (e: React.MouseEvent | React.KeyboardEvent, name: string, value: string, checked: boolean) => void;
-/**
- * Props for selecatble menu items
- */
-export declare type MenuItemSelectableProps = {
-    /**
-     * Follows input convention
-     * https://www.w3schools.com/jsref/prop_checkbox_name.asp
-     */
-    name: string;
-    /**
-     * Follows input convention
-     * https://www.w3schools.com/jsref/prop_checkbox_value.asp
-     */
-    value: string;
-};
-/**
- * State for selectable menu items
- */
-export declare type MenuItemSelectableState = MenuItemSelectableProps & {
-    /**
-     * Checked items for a value with `name`
-     */
-    checkedItems: string[];
-    /**
-     * Callback when checked items changes for a given value with `name`
-     */
-    onCheckedValueChange: (e: React.MouseEvent | React.KeyboardEvent, name: string, checkedItems: string[]) => void;
-    /**
-     * Selectable is checked
-     */
-    checked: boolean;
-};

package/lib-commonjs/selectable/useCheckmarkStyles.d.ts

@@ -1,8 +0,0 @@
-import type { MenuItemSelectableState } from './types';
-import type { MenuItemState } from '../components/MenuItem/MenuItem.types';
-/**
- * Applies styles to a checkmark slot for selectable menu items
- *
- * @param state - should contain a `checkmark` slot
- */
-export declare const useCheckmarkStyles_unstable: (state: MenuItemSelectableState & Pick<MenuItemState, 'checkmark'>) => void;

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

@@ -1 +0,0 @@
-export * from './useOnMenuEnter';

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

@@ -1,9 +0,0 @@
-/**
- * A component can be a part of a submenu whether its menu context `isSubmenu` flag is true
- * or whether it is a part of a `MenuList`
- *
- * A simple hook to check box contexts easily
- *
- * @returns whether the component is part of a submenu
- */
-export declare function useIsSubmenu(): boolean;

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

@@ -1,23 +0,0 @@
-import type { UseOnClickOrScrollOutsideOptions } from '@fluentui/react-utilities';
-/**
- * Name of the custom event
- */
-export declare const MENU_ENTER_EVENT = "fuimenuenter";
-/**
- * This hook works similarly to @see {useOnClickOutside}
- *
- * Problem: Trying to behave the same as system menus:
- * When the mouse leaves a stack of nested menus the stack should not dismiss.
- * However if the mouse leaves a stack of menus and enters a parent menu all its children menu should dismiss.
- *
- * We don't use the native mouseenter event because it would trigger too many times in the document
- * Instead, dispatch custom DOM event from the menu so that it can bubble
- * Each nested menu can use the listener to check if the event is from a child or parent menu
- */
-export declare const useOnMenuMouseEnter: (options: UseOnClickOrScrollOutsideOptions) => void;
-/**
- * Dispatches the custom MouseEvent enter event. Similar to calling `el.click()`
- * @param el element for the event target
- * @param nativeEvent the native mouse event this is mapped to
- */
-export declare const dispatchMenuEnterEvent: (el: HTMLElement, nativeEvent: MouseEvent) => void;