packages/react-components/react-drawer/library/etc/react-drawer.api.md
Do not edit this file. It is a report generated by API Extractor.
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { DialogProps } from '@fluentui/react-dialog';
import type { DialogSurfaceProps } from '@fluentui/react-dialog';
import type { DialogSurfaceSlots } from '@fluentui/react-dialog';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import type { PresenceDirection } from '@fluentui/react-motion';
import type { PresenceMotionSlotProps } from '@fluentui/react-motion';
import { ProviderContextValue_unstable } from '@fluentui/react-shared-contexts';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';
// @public
export const Drawer: ForwardRefComponent<DrawerProps>;
// @public
export const DrawerBody: ForwardRefComponent<DrawerBodyProps>;
// @public (undocumented)
export const drawerBodyClassNames: SlotClassNames<DrawerBodySlots>;
// @public
export type DrawerBodyProps = ComponentProps<DrawerBodySlots>;
// @public (undocumented)
export type DrawerBodySlots = {
root: Slot<'div'>;
};
// @public
export type DrawerBodyState = ComponentState<DrawerBodySlots>;
// @public (undocumented)
export type DrawerContextValue = {
scrollState: DrawerScrollState;
setScrollState: (scrollState: DrawerScrollState) => void;
};
// @public
export const DrawerFooter: ForwardRefComponent<DrawerFooterProps>;
// @public (undocumented)
export const drawerFooterClassNames: SlotClassNames<DrawerFooterSlots>;
// @public
export type DrawerFooterProps = ComponentProps<DrawerFooterSlots>;
// @public (undocumented)
export type DrawerFooterSlots = {
root: Slot<'footer'>;
};
// @public
export type DrawerFooterState = ComponentState<DrawerFooterSlots> & {
scrollState: DrawerScrollState;
};
// @public
export const DrawerHeader: ForwardRefComponent<DrawerHeaderProps>;
// @public (undocumented)
export const drawerHeaderClassNames: SlotClassNames<DrawerHeaderSlots>;
// @public
export const DrawerHeaderNavigation: ForwardRefComponent<DrawerHeaderNavigationProps>;
// @public (undocumented)
export const drawerHeaderNavigationClassNames: SlotClassNames<DrawerHeaderNavigationSlots>;
// @public
export type DrawerHeaderNavigationProps = ComponentProps<DrawerHeaderNavigationSlots>;
// @public (undocumented)
export type DrawerHeaderNavigationSlots = {
root: Slot<'nav'>;
};
// @public
export type DrawerHeaderNavigationState = ComponentState<DrawerHeaderNavigationSlots>;
// @public
export type DrawerHeaderProps = ComponentProps<DrawerHeaderSlots>;
// @public (undocumented)
export type DrawerHeaderSlots = {
root: Slot<'header'>;
};
// @public
export type DrawerHeaderState = ComponentState<DrawerHeaderSlots> & {
scrollState: DrawerScrollState;
};
// @public
export const DrawerHeaderTitle: ForwardRefComponent<DrawerHeaderTitleProps>;
// @public (undocumented)
export const drawerHeaderTitleClassNames: SlotClassNames<DrawerHeaderTitleSlots>;
// @public
export type DrawerHeaderTitleProps = ComponentProps<DrawerHeaderTitleSlots>;
// @public (undocumented)
export type DrawerHeaderTitleSlots = {
root: Slot<'div'>;
heading?: Slot<'h2', 'h1' | 'h3' | 'h4' | 'h5' | 'h6' | 'div'>;
action?: Slot<'div'>;
};
// @public
export type DrawerHeaderTitleState = ComponentState<DrawerHeaderTitleSlots>;
// @public
export type DrawerProps = ComponentProps<DrawerSlots> & {
type?: 'inline' | 'overlay';
} & (OverlayDrawerProps | InlineDrawerProps);
// @public (undocumented)
export const DrawerProvider: React_2.Provider<DrawerContextValue | undefined>;
// @public (undocumented)
export type DrawerSlots = Pick<OverlayDrawerSlots, 'root'> | Pick<InlineDrawerSlots, 'root'>;
// @public
export type DrawerState = ComponentState<DrawerSlots>;
// @public
export const InlineDrawer: ForwardRefComponent<InlineDrawerProps>;
// @public (undocumented)
export const inlineDrawerClassNames: SlotClassNames<Omit<InlineDrawerSlots, 'surfaceMotion'>>;
// @public
export type InlineDrawerProps = ComponentProps<InlineDrawerSlots> & DrawerBaseProps & {
separator?: boolean;
};
// @public (undocumented)
export type InlineDrawerSlots = {
root: Slot<'div', 'aside'>;
surfaceMotion?: Slot<SurfaceMotionSlotProps>;
};
// @public
export type InlineDrawerState = Required<ComponentState<NonNullable<InlineDrawerSlots>> & DrawerBaseState & Pick<InlineDrawerProps, 'separator'> & {
animationDirection: PresenceDirection;
}>;
// @public
export const OverlayDrawer: ForwardRefComponent<OverlayDrawerProps>;
// @public (undocumented)
export const overlayDrawerClassNames: SlotClassNames<Omit<OverlayDrawerSurfaceSlots, 'backdropMotion'>>;
// @public
export type OverlayDrawerProps = ComponentProps<OverlayDrawerSlots> & Pick<DialogProps, 'modalType' | 'onOpenChange' | 'inertTrapFocus'> & DrawerBaseProps & {
defaultOpen?: boolean;
};
// @public
export type OverlayDrawerSlots = {
root: Slot<OverlayDrawerSurfaceProps>;
backdropMotion?: Slot<PresenceMotionSlotProps<OverlayDrawerSurfaceMotionParams>>;
surfaceMotion?: Slot<PresenceMotionSlotProps<DrawerMotionParams>>;
};
// @public
export type OverlayDrawerState = ComponentState<OverlayDrawerInternalSlots> & Required<DrawerBaseState> & Pick<OverlayDrawerProps, 'mountNode' | 'unmountOnClose'> & {
hasMountNodeElement: boolean;
};
// @public
export const renderDrawer_unstable: (state: DrawerState, contextValue: DrawerContextValue) => JSXElement;
// @public
export const renderDrawerBody_unstable: (state: DrawerBodyState) => JSXElement;
// @public
export const renderDrawerFooter_unstable: (state: DrawerFooterState) => JSXElement;
// @public
export const renderDrawerHeader_unstable: (state: DrawerHeaderState) => JSXElement;
// @public
export const renderDrawerHeaderNavigation_unstable: (state: DrawerHeaderNavigationState) => JSXElement;
// @public
export const renderDrawerHeaderTitle_unstable: (state: DrawerHeaderTitleState) => JSXElement;
// @public
export const renderInlineDrawer_unstable: (state: InlineDrawerState, contextValue: DrawerContextValue) => JSXElement;
// @public
export const renderOverlayDrawer_unstable: (state: OverlayDrawerState, contextValue: DrawerContextValue) => JSXElement;
// @public
export const useDrawer_unstable: (props: DrawerProps, ref: React_2.Ref<HTMLElement>) => DrawerState;
// @public
export const useDrawerBody_unstable: (props: DrawerBodyProps, ref: React_2.Ref<HTMLElement>) => DrawerBodyState;
// @public
export const useDrawerBodyStyles_unstable: (state: DrawerBodyState) => DrawerBodyState;
// @public (undocumented)
export const useDrawerContext_unstable: () => DrawerContextValue;
// @public (undocumented)
export const useDrawerContextValue: () => DrawerContextValue;
// @public
export const useDrawerFooter_unstable: (props: DrawerFooterProps, ref: React_2.Ref<HTMLElement>) => DrawerFooterState;
// @public
export const useDrawerFooterStyles_unstable: (state: DrawerFooterState) => DrawerFooterState;
// @public
export const useDrawerHeader_unstable: (props: DrawerHeaderProps, ref: React_2.Ref<HTMLElement>) => DrawerHeaderState;
// @public
export const useDrawerHeaderNavigation_unstable: (props: DrawerHeaderNavigationProps, ref: React_2.Ref<HTMLElement>) => DrawerHeaderNavigationState;
// @public
export const useDrawerHeaderNavigationStyles_unstable: (state: DrawerHeaderNavigationState) => DrawerHeaderNavigationState;
// @public
export const useDrawerHeaderStyles_unstable: (state: DrawerHeaderState) => DrawerHeaderState;
// @public
export const useDrawerHeaderTitle_unstable: (props: DrawerHeaderTitleProps, ref: React_2.Ref<HTMLDivElement>) => DrawerHeaderTitleState;
// @public
export const useDrawerHeaderTitleStyles_unstable: (state: DrawerHeaderTitleState) => DrawerHeaderTitleState;
// @public
export const useDrawerStyles_unstable: (state: DrawerState) => DrawerState;
// @public
export const useInlineDrawer_unstable: (props: InlineDrawerProps, ref: React_2.Ref<HTMLElement>) => InlineDrawerState;
// @public
export const useInlineDrawerStyles_unstable: (state: InlineDrawerState) => InlineDrawerState;
// @public
export const useOverlayDrawer_unstable: (props: OverlayDrawerProps, ref: React_2.Ref<HTMLElement>) => OverlayDrawerState;
// @public
export const useOverlayDrawerStyles_unstable: (state: OverlayDrawerState) => OverlayDrawerState;
// (No @packageDocumentation comment for this package)