react-message-bar.api.md

API Report File for "@fluentui/react-message-bar"

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

import type { ButtonContextValue } from '@fluentui/react-button';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { DistributiveOmit } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const MessageBar: ForwardRefComponent<MessageBarProps>;

// @public
export const MessageBarActions: ForwardRefComponent<MessageBarActionsProps>;

// @public (undocumented)
export const messageBarActionsClassNames: SlotClassNames<MessageBarActionsSlots>;

// @public (undocumented)
export type MessageBarActionsContextValues = {
    button: ButtonContextValue;
};

// @public
export type MessageBarActionsProps = ComponentProps<MessageBarActionsSlots>;

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

// @public
export type MessageBarActionsState = ComponentState<MessageBarActionsSlots> & Pick<Required<MessageBarContextValue>, 'layout'> & {
    hasActions: boolean;
};

// @public (undocumented)
export type MessageBarBaseProps = DistributiveOmit<MessageBarProps, 'shape'>;

// @public (undocumented)
export type MessageBarBaseState = DistributiveOmit<MessageBarState, 'shape'>;

// @public
export const MessageBarBody: ForwardRefComponent<MessageBarBodyProps>;

// @public (undocumented)
export const messageBarBodyClassNames: SlotClassNames<MessageBarBodySlots>;

// @public
export type MessageBarBodyProps = ComponentProps<MessageBarBodySlots>;

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

// @public
export type MessageBarBodyState = ComponentState<MessageBarBodySlots>;

// @public (undocumented)
export const messageBarClassNames: SlotClassNames<MessageBarSlots>;

// @public (undocumented)
export const messageBarContextDefaultValue: MessageBarContextValue;

// @public (undocumented)
export const MessageBarContextProvider: React_2.Provider<MessageBarContextValue | undefined>;

// @public (undocumented)
export type MessageBarContextValue = {
    layout: 'multiline' | 'singleline' | 'auto';
    actionsRef: React_2.MutableRefObject<HTMLDivElement | null>;
    bodyRef: React_2.MutableRefObject<HTMLDivElement | null>;
    titleId: string;
};

// @public (undocumented)
export type MessageBarContextValues = {
    messageBar: MessageBarContextValue;
};

// @public
export const MessageBarGroup: ForwardRefComponent<MessageBarGroupProps>;

// @public (undocumented)
export const messageBarGroupClassNames: SlotClassNames<MessageBarGroupSlots>;

// @public
export type MessageBarGroupProps = ComponentProps<MessageBarGroupSlots> & {
    children: React_2.ReactElement[] | React_2.ReactElement;
    animate?: 'exit-only' | 'both';
};

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

// @public
export type MessageBarGroupState = ComponentState<MessageBarGroupSlots> & Pick<MessageBarGroupProps, 'animate'> & {
    enterStyles: string;
    exitStyles: string;
    children: React_2.ReactElement[];
};

// @public (undocumented)
export type MessageBarIntent = 'info' | 'success' | 'warning' | 'error';

// @public
export type MessageBarProps = ComponentProps<MessageBarSlots> & Pick<Partial<MessageBarContextValue>, 'layout'> & {
    intent?: MessageBarIntent;
    politeness?: 'assertive' | 'polite';
    shape?: 'square' | 'rounded';
};

// @public (undocumented)
export type MessageBarSlots = {
    root: Slot<'div'>;
    icon?: Slot<'div'>;
    bottomReflowSpacer?: Slot<'div'>;
};

// @public
export type MessageBarState = ComponentState<MessageBarSlots> & Required<Pick<MessageBarProps, 'layout' | 'intent' | 'shape'>> & Pick<MessageBarContextValue, 'actionsRef' | 'bodyRef' | 'titleId'> & {
    transitionClassName: string;
};

// @public
export const MessageBarTitle: ForwardRefComponent<MessageBarTitleProps>;

// @public (undocumented)
export const messageBarTitleClassNames: SlotClassNames<MessageBarTitleSlots>;

// @public
export type MessageBarTitleProps = ComponentProps<MessageBarTitleSlots>;

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

// @public
export type MessageBarTitleState = ComponentState<MessageBarTitleSlots>;

// @internal (undocumented)
export const messageBarTransitionContextDefaultValue: MessageBarTransitionContextValue;

// @internal
export const MessageBarTransitionContextProvider: React_2.Provider<MessageBarTransitionContextValue | undefined>;

// @public (undocumented)
export type MessageBarTransitionContextValue = {
    className: string;
    nodeRef: React_2.Ref<HTMLDivElement | null>;
};

// @public
export const renderMessageBar_unstable: (state: MessageBarBaseState, contexts: MessageBarContextValues) => JSXElement;

// @public
export const renderMessageBarActions_unstable: (state: MessageBarActionsState, contexts: MessageBarActionsContextValues) => JSXElement;

// @public
export const renderMessageBarBody_unstable: (state: MessageBarBodyState, contextValues: MessageBarBodyContextValues) => JSXElement;

// @public
export const renderMessageBarGroup_unstable: (state: MessageBarGroupState) => JSXElement;

// @public
export const renderMessageBarTitle_unstable: (state: MessageBarTitleState) => JSXElement;

// @public
export const useMessageBar_unstable: (props: MessageBarProps, ref: React_2.Ref<HTMLDivElement>) => MessageBarState;

// @public
export const useMessageBarActions_unstable: (props: MessageBarActionsProps, ref: React_2.Ref<HTMLDivElement>) => MessageBarActionsState;

// @public (undocumented)
export function useMessageBarActionsContextValue_unstable(): MessageBarActionsContextValues;

// @public
export const useMessageBarActionsStyles_unstable: (state: MessageBarActionsState) => MessageBarActionsState;

// @public
export const useMessageBarBase_unstable: (props: MessageBarBaseProps, ref: React_2.Ref<HTMLDivElement>) => MessageBarBaseState;

// @public
export const useMessageBarBody_unstable: (props: MessageBarBodyProps, ref: React_2.Ref<HTMLDivElement>) => MessageBarBodyState;

// @public
export const useMessageBarBodyStyles_unstable: (state: MessageBarBodyState) => MessageBarBodyState;

// @public (undocumented)
export const useMessageBarContext: () => MessageBarContextValue;

// @public (undocumented)
export function useMessageBarContextValue_unstable(state: MessageBarState): MessageBarContextValues;

// @public
export const useMessageBarGroup_unstable: (props: MessageBarGroupProps, ref: React_2.Ref<HTMLDivElement>) => MessageBarGroupState;

// @public
export const useMessageBarGroupStyles_unstable: (state: MessageBarGroupState) => MessageBarGroupState;

// @public
export const useMessageBarStyles_unstable: (state: MessageBarState) => MessageBarState;

// @public
export const useMessageBarTitle_unstable: (props: MessageBarTitleProps, ref: React_2.Ref<HTMLElement>) => MessageBarTitleState;

// @public
export const useMessageBarTitleStyles_unstable: (state: MessageBarTitleState) => MessageBarTitleState;

// @internal (undocumented)
export const useMessageBarTransitionContext: () => MessageBarTransitionContextValue;

// (No @packageDocumentation comment for this package)