Back to Fluentui

React Menu Grid Preview.Api

packages/react-components/react-menu-grid-preview/library/etc/react-menu-grid-preview.api.md

4.40.2-hotfix27.1 KB
Original Source

API Report File for "@fluentui/react-menu-grid-preview"

Do not edit this file. It is a report generated by API Extractor.

ts

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import type { MenuListContextValue } from '@fluentui/react-menu';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';
import { TabsterDOMAttribute } from '@fluentui/react-tabster';

// @public
export const MenuGrid: ForwardRefComponent<MenuGridProps>;

// @public
export const MenuGridCell: ForwardRefComponent<MenuGridCellProps>;

// @public (undocumented)
export const menuGridCellClassNames: SlotClassNames<MenuGridCellSlots>;

// @public (undocumented)
export type MenuGridCellProps = ComponentProps<MenuGridCellSlots> & {
    visuallyHidden?: boolean;
};

// @public (undocumented)
export type MenuGridCellSlots = {
    root: Slot<'div'>;
};

// @public (undocumented)
export type MenuGridCellState = ComponentState<MenuGridCellSlots> & Pick<MenuGridCellProps, 'visuallyHidden'>;

// @public (undocumented)
export const menuGridClassNames: SlotClassNames<MenuGridSlots>;

// @public (undocumented)
export const MenuGridContextProvider: React_2.Provider<MenuGridContextValue>;

// @public
export type MenuGridContextValue = {
    tableRowTabsterAttribute: TabsterDOMAttribute | null;
};

// @public (undocumented)
export type MenuGridContextValues = {
    menuGrid: MenuGridContextValue;
    menuList: MenuListContextValue;
};

// @public
export const MenuGridGroup: ForwardRefComponent<MenuGridGroupProps>;

// @public (undocumented)
export const menuGridGroupClassNames: SlotClassNames<MenuGridGroupSlots>;

// @public (undocumented)
export const MenuGridGroupContextProvider: React_2.Provider<MenuGridGroupContextValue>;

// @public
export type MenuGridGroupContextValue = {
    headerId: string;
};

// @public (undocumented)
export type MenuGridGroupContextValues = {
    menuGridGroup: MenuGridGroupContextValue;
};

// @public
export const MenuGridGroupHeader: ForwardRefComponent<MenuGridGroupHeaderProps>;

// @public (undocumented)
export const menuGridGroupHeaderClassNames: SlotClassNames<MenuGridGroupHeaderSlots>;

// @public (undocumented)
export type MenuGridGroupHeaderProps = ComponentProps<MenuGridGroupHeaderSlots>;

// @public (undocumented)
export type MenuGridGroupHeaderSlots = {
    root: Slot<'div'>;
};

// @public (undocumented)
export type MenuGridGroupHeaderState = ComponentState<MenuGridGroupHeaderSlots>;

// @public (undocumented)
export type MenuGridGroupProps = ComponentProps<MenuGridGroupSlots>;

// @public (undocumented)
export type MenuGridGroupSlots = {
    root: Slot<'div'>;
};

// @public (undocumented)
export type MenuGridGroupState = ComponentState<MenuGridGroupSlots> & {
    headerId: string;
};

// @public
export const MenuGridItem: ForwardRefComponent<MenuGridItemProps>;

// @public (undocumented)
export const menuGridItemClassNames: SlotClassNames<MenuGridItemSlots>;

// @public (undocumented)
export type MenuGridItemProps = ComponentProps<Partial<MenuGridItemSlots>>;

// @public (undocumented)
export type MenuGridItemSlots = {
    root: Slot<MenuGridRowProps>;
    icon?: Slot<MenuGridCellProps>;
    content?: Slot<MenuGridCellProps>;
    subText?: Slot<'span'>;
    firstSubAction?: Slot<MenuGridCellProps>;
    secondSubAction?: Slot<MenuGridCellProps>;
};

// @public (undocumented)
export type MenuGridItemState = ComponentState<MenuGridItemSlots>;

// @public (undocumented)
export type MenuGridProps = ComponentProps<MenuGridSlots> & {};

// @public
export const MenuGridRow: ForwardRefComponent<MenuGridRowProps>;

// @public (undocumented)
export const menuGridRowClassNames: SlotClassNames<MenuGridRowSlots>;

// @public (undocumented)
export type MenuGridRowProps = ComponentProps<Partial<MenuGridRowSlots>>;

// @public (undocumented)
export type MenuGridRowSlots = {
    root: Slot<'div'>;
};

// @public (undocumented)
export type MenuGridRowState = ComponentState<MenuGridRowSlots>;

// @public (undocumented)
export type MenuGridSlots = {
    root: Slot<'div'>;
};

// @public (undocumented)
export type MenuGridState = ComponentState<MenuGridSlots> & {
    tableRowTabsterAttribute: TabsterDOMAttribute | null;
};

// @public
export const renderMenuGrid_unstable: (state: MenuGridState, contextValues: MenuGridContextValues) => JSXElement;

// @public
export const renderMenuGridCell_unstable: (state: MenuGridCellState) => JSXElement;

// @public
export const renderMenuGridGroup_unstable: (state: MenuGridGroupState, contextValues: MenuGridGroupContextValues) => JSXElement;

// @public
export const renderMenuGridGroupHeader_unstable: (state: MenuGridGroupHeaderState) => JSXElement;

// @public
export const renderMenuGridItem_unstable: (state: MenuGridItemState) => JSXElement;

// @public
export const renderMenuGridRow_unstable: (state: MenuGridRowState) => JSXElement;

// @public
export const useMenuGrid_unstable: (props: MenuGridProps, ref: React_2.Ref<HTMLDivElement>) => MenuGridState;

// @public
export function useMenuGridCell_unstable(props: MenuGridCellProps, ref: React_2.Ref<HTMLDivElement>): MenuGridCellState;

// @public (undocumented)
export const useMenuGridCellStyles_unstable: (state: MenuGridCellState) => MenuGridCellState;

// @public (undocumented)
export const useMenuGridContext_unstable: () => MenuGridContextValue;

// @public (undocumented)
export function useMenuGridContextValues_unstable(state: MenuGridState): MenuGridContextValues;

// @public
export function useMenuGridGroup_unstable(props: MenuGridGroupProps, ref: React_2.Ref<HTMLDivElement>): MenuGridGroupState;

// @public (undocumented)
export const useMenuGridGroupContext_unstable: () => MenuGridGroupContextValue;

// @public (undocumented)
export function useMenuGridGroupContextValues_unstable(state: MenuGridGroupState): MenuGridGroupContextValues;

// @public
export function useMenuGridGroupHeader_unstable(props: MenuGridGroupHeaderProps, ref: React_2.Ref<HTMLDivElement>): MenuGridGroupHeaderState;

// @public (undocumented)
export const useMenuGridGroupHeaderStyles_unstable: (state: MenuGridGroupHeaderState) => MenuGridGroupHeaderState;

// @public (undocumented)
export const useMenuGridGroupStyles_unstable: (state: MenuGridGroupState) => MenuGridGroupState;

// @public
export function useMenuGridItem_unstable(props: MenuGridItemProps, ref: React_2.Ref<HTMLDivElement>): MenuGridItemState;

// @public (undocumented)
export const useMenuGridItemStyles_unstable: (state: MenuGridItemState) => MenuGridItemState;

// @public
export function useMenuGridRow_unstable(props: MenuGridRowProps, ref: React_2.Ref<HTMLDivElement>): MenuGridRowState;

// @public (undocumented)
export const useMenuGridRowStyles_unstable: (state: MenuGridRowState) => MenuGridRowState;

// @public
export const useMenuGridStyles_unstable: (state: MenuGridState) => MenuGridState;

// (No @packageDocumentation comment for this package)