Back to Fluentui

React Teaching Popover.Api

packages/react-components/react-teaching-popover/library/etc/react-teaching-popover.api.md

4.40.2-hotfix216.1 KB
Original Source

API Report File for "@fluentui/react-teaching-popover"

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

ts

import { ARIAButtonSlotProps } from '@fluentui/react-aria';
import { Button } from '@fluentui/react-button';
import { ButtonProps } from '@fluentui/react-button';
import { ButtonState } from '@fluentui/react-button';
import { ComponentProps } from '@fluentui/react-utilities';
import { ComponentState } from '@fluentui/react-utilities';
import { EventData } from '@fluentui/react-utilities';
import { EventHandler } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import { JSXElement } from '@fluentui/react-utilities';
import { PopoverContextValue } from '@fluentui/react-popover';
import type { PopoverProps } from '@fluentui/react-popover';
import { PopoverState } from '@fluentui/react-popover';
import { PopoverSurfaceSlots } from '@fluentui/react-popover';
import { PopoverSurfaceState } from '@fluentui/react-popover';
import { PopoverTriggerChildProps } from '@fluentui/react-popover';
import { PopoverTriggerProps } from '@fluentui/react-popover';
import { PopoverTriggerState } from '@fluentui/react-popover';
import * as React_2 from 'react';
import { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const renderTeachingPopover_unstable: (state: PopoverState) => JSXElement;

// @public
export const renderTeachingPopoverBody_unstable: (state: TeachingPopoverBodyState) => JSXElement;

// @public
export const renderTeachingPopoverCarousel_unstable: (state: TeachingPopoverCarouselState, contextValues: TeachingPopoverCarouselContextValues) => JSXElement;

// @public
export const renderTeachingPopoverCarouselCard_unstable: (state: TeachingPopoverCarouselCardState) => JSXElement;

// @public
export const renderTeachingPopoverCarouselFooter_unstable: (state: TeachingPopoverCarouselFooterState) => JSXElement;

// @public
export const renderTeachingPopoverCarouselFooterButton_unstable: (state: TeachingPopoverCarouselFooterButtonState) => JSXElement;

// @public
export const renderTeachingPopoverCarouselNav_unstable: (state: TeachingPopoverCarouselNavState) => JSXElement;

// @public
export const renderTeachingPopoverCarouselNavButton_unstable: (state: TeachingPopoverCarouselNavButtonState) => JSXElement;

// @public
export const renderTeachingPopoverCarouselPageCount_unstable: (state: TeachingPopoverCarouselPageCountState) => JSXElement;

// @public
export const renderTeachingPopoverFooter_unstable: (state: TeachingPopoverFooterState) => JSXElement;

// @public
export const renderTeachingPopoverHeader_unstable: (state: TeachingPopoverHeaderState) => JSXElement;

// @public
export const renderTeachingPopoverSurface_unstable: (state: TeachingPopoverSurfaceState) => JSXElement;

// @public
export const renderTeachingPopoverTitle_unstable: (state: TeachingPopoverTitleState) => JSXElement;

// @public
export const renderTeachingPopoverTrigger_unstable: (state: TeachingPopoverTriggerState) => JSXElement | null;

// @public
export const TeachingPopover: React_2.FC<TeachingPopoverProps>;

// @public
export const TeachingPopoverBody: ForwardRefComponent<TeachingPopoverBodyProps>;

// @public (undocumented)
export const teachingPopoverBodyClassNames: SlotClassNames<TeachingPopoverBodySlots>;

// @public (undocumented)
export type TeachingPopoverBodyProps = ComponentProps<TeachingPopoverBodySlots> & {
    mediaLength?: 'short' | 'medium' | 'tall';
};

// @public (undocumented)
export type TeachingPopoverBodySlots = {
    root: NonNullable<Slot<'div'>>;
    media?: Slot<'span'>;
};

// @public (undocumented)
export type TeachingPopoverBodyState = ComponentState<TeachingPopoverBodySlots> & Required<Pick<TeachingPopoverBodyProps, 'mediaLength'>>;

// @public
export const TeachingPopoverCarousel: ForwardRefComponent<TeachingPopoverCarouselProps>;

// @public
export const TeachingPopoverCarouselCard: ForwardRefComponent<TeachingPopoverCarouselCardProps>;

// @public (undocumented)
export const teachingPopoverCarouselCardClassNames: SlotClassNames<TeachingPopoverCarouselCardSlots>;

// @public (undocumented)
export type TeachingPopoverCarouselCardProps = ComponentProps<TeachingPopoverCarouselCardSlots> & {
    value: string;
};

// @public (undocumented)
export type TeachingPopoverCarouselCardSlots = {
    root: NonNullable<Slot<CarouselItemProps>>;
};

// @public (undocumented)
export type TeachingPopoverCarouselCardState = ComponentState<TeachingPopoverCarouselCardSlots> & Required<Pick<TeachingPopoverCarouselCardProps, 'value'>>;

// @public (undocumented)
export const teachingPopoverCarouselClassNames: SlotClassNames<TeachingPopoverCarouselSlots>;

// @public
export const TeachingPopoverCarouselFooter: ForwardRefComponent<TeachingPopoverCarouselFooterProps>;

// @public
export const TeachingPopoverCarouselFooterButton: ForwardRefComponent<TeachingPopoverCarouselFooterButtonProps>;

// @public (undocumented)
export const teachingPopoverCarouselFooterButtonClassNames: SlotClassNames<TeachingPopoverCarouselFooterButtonSlots>;

// @public
export type TeachingPopoverCarouselFooterButtonProps = ComponentProps<TeachingPopoverCarouselFooterButtonSlots> & ButtonProps & {
    navType: 'next' | 'prev';
    altText: React_2.ReactNode;
};

// @public (undocumented)
export type TeachingPopoverCarouselFooterButtonSlots = {
    root: NonNullable<Slot<ARIAButtonSlotProps<'a'>>>;
};

// @public
export type TeachingPopoverCarouselFooterButtonState = ButtonState & ComponentState<TeachingPopoverCarouselFooterButtonSlots> & Pick<TeachingPopoverCarouselFooterButtonProps, 'navType' | 'altText'> & {
    popoverAppearance: PopoverContextValue['appearance'];
};

// @public (undocumented)
export const teachingPopoverCarouselFooterClassNames: SlotClassNames<TeachingPopoverCarouselFooterSlots>;

// @public
export type TeachingPopoverCarouselFooterProps = ComponentProps<TeachingPopoverCarouselFooterSlots> & {
    layout?: TeachingPopoverCarouselFooterLayout;
    initialStepText: string;
    finalStepText: string;
};

// @public (undocumented)
export type TeachingPopoverCarouselFooterSlots = {
    root: NonNullable<Slot<'div'>>;
    previous?: Slot<TeachingPopoverCarouselFooterButtonProps>;
    next: NonNullable<Slot<TeachingPopoverCarouselFooterButtonProps>>;
};

// @public
export type TeachingPopoverCarouselFooterState = ComponentState<Required<TeachingPopoverCarouselFooterSlots>> & Pick<TeachingPopoverCarouselFooterProps, 'layout'>;

// @public
export const TeachingPopoverCarouselNav: ForwardRefComponent<TeachingPopoverCarouselNavProps>;

// @public
export const TeachingPopoverCarouselNavButton: ForwardRefComponent<TeachingPopoverCarouselNavButtonProps>;

// @public (undocumented)
export const teachingPopoverCarouselNavButtonClassNames: SlotClassNames<TeachingPopoverCarouselNavButtonSlots>;

// @public
export type TeachingPopoverCarouselNavButtonProps = ComponentProps<TeachingPopoverCarouselNavButtonSlots>;

// @public (undocumented)
export type TeachingPopoverCarouselNavButtonSlots = {
    root: NonNullable<Slot<ARIAButtonSlotProps<'a'>>>;
};

// @public
export type TeachingPopoverCarouselNavButtonState = ComponentState<TeachingPopoverCarouselNavButtonSlots> & {
    isSelected?: boolean;
} & Pick<PopoverContextValue, 'appearance'>;

// @public (undocumented)
export const teachingPopoverCarouselNavClassNames: SlotClassNames<TeachingPopoverCarouselNavSlots>;

// @public (undocumented)
export type TeachingPopoverCarouselNavProps = Omit<ComponentProps<Partial<TeachingPopoverCarouselNavSlots>>, 'children'> & {
    children: NavButtonRenderFunction;
};

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

// @public (undocumented)
export type TeachingPopoverCarouselNavState = ComponentState<TeachingPopoverCarouselNavSlots> & {
    values: string[];
    renderNavButton: NavButtonRenderFunction;
};

// @public
export const TeachingPopoverCarouselPageCount: ForwardRefComponent<TeachingPopoverCarouselPageCountProps>;

// @public (undocumented)
export const teachingPopoverCarouselPageCountClassNames: SlotClassNames<TeachingPopoverCarouselPageCountSlots>;

// @public
export type TeachingPopoverCarouselPageCountProps = Omit<ComponentProps<Partial<TeachingPopoverCarouselPageCountSlots>>, 'children'> & {
    children: TeachingPopoverCarouselPageCountRenderFunction;
};

// @public (undocumented)
export type TeachingPopoverCarouselPageCountRenderFunction = (currentPage: number, totalPages: number) => React_2.ReactNode;

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

// @public
export type TeachingPopoverCarouselPageCountState = ComponentState<TeachingPopoverCarouselPageCountSlots> & {
    currentIndex: number;
    totalPages: number;
    renderPageCount: TeachingPopoverCarouselPageCountRenderFunction;
};

// @public
export type TeachingPopoverCarouselProps = ComponentProps<TeachingPopoverCarouselSlots> & UseCarouselOptions;

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

// @public
export type TeachingPopoverCarouselState = ComponentState<Required<TeachingPopoverCarouselSlots>> & Partial<Pick<PopoverContextValue, 'appearance'>> & CarouselContextValue;

// @public
export const TeachingPopoverFooter: ForwardRefComponent<TeachingPopoverFooterProps>;

// @public (undocumented)
export const teachingPopoverFooterClassNames: SlotClassNames<TeachingPopoverFooterSlots>;

// @public (undocumented)
export type TeachingPopoverFooterProps = ComponentProps<TeachingPopoverFooterSlots> & Pick<TeachingPopoverFooterState, 'footerLayout'>;

// @public (undocumented)
export type TeachingPopoverFooterState = ComponentState<TeachingPopoverFooterSlots> & Pick<PopoverContextValue, 'appearance'> & {
    footerLayout?: 'horizontal' | 'vertical';
};

// @public
export const TeachingPopoverHeader: ForwardRefComponent<TeachingPopoverHeaderProps>;

// @public (undocumented)
export const teachingPopoverHeaderClassNames: SlotClassNames<TeachingPopoverHeaderSlots>;

// @public (undocumented)
export type TeachingPopoverHeaderProps = ComponentProps<TeachingPopoverHeaderSlots>;

// @public (undocumented)
export type TeachingPopoverHeaderSlots = {
    root: Slot<'div', 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'>;
    dismissButton?: Slot<'button'>;
    icon?: Slot<'div'>;
};

// @public (undocumented)
export type TeachingPopoverHeaderState = ComponentState<TeachingPopoverHeaderSlots> & Pick<PopoverContextValue, 'appearance'>;

// @public
export type TeachingPopoverProps = PopoverProps;

// @public
export type TeachingPopoverState = PopoverState;

// @public
export const TeachingPopoverSurface: ForwardRefComponent<TeachingPopoverSurfaceProps>;

// @public (undocumented)
export const teachingPopoverSurfaceClassNames: SlotClassNames<TeachingPopoverSurfaceSlots>;

// @public
export type TeachingPopoverSurfaceProps = ComponentProps<TeachingPopoverSurfaceSlots>;

// @public
export type TeachingPopoverSurfaceSlots = PopoverSurfaceSlots;

// @public
export type TeachingPopoverSurfaceState = PopoverSurfaceState;

// @public
export const TeachingPopoverTitle: ForwardRefComponent<TeachingPopoverTitleProps>;

// @public (undocumented)
export const teachingPopoverTitleClassNames: SlotClassNames<TeachingPopoverTitleSlots>;

// @public
export type TeachingPopoverTitleProps = ComponentProps<TeachingPopoverTitleSlots>;

// @public (undocumented)
export type TeachingPopoverTitleSlots = {
    root: Slot<'h2', 'h1' | 'h3' | 'h4' | 'h5' | 'h6' | 'div'>;
    dismissButton?: Slot<'button'>;
};

// @public
export type TeachingPopoverTitleState = ComponentState<TeachingPopoverTitleSlots> & Pick<PopoverContextValue, 'appearance'>;

// @public
export const TeachingPopoverTrigger: React_2.FC<TeachingPopoverTriggerProps>;

// @public
export type TeachingPopoverTriggerChildProps = PopoverTriggerChildProps;

// @public
export type TeachingPopoverTriggerProps = PopoverTriggerProps;

// @public
export type TeachingPopoverTriggerState = PopoverTriggerState;

// @public (undocumented)
export const useTeachingPopover_unstable: (props: TeachingPopoverProps) => TeachingPopoverState;

// @public
export const useTeachingPopoverBody_unstable: (props: TeachingPopoverBodyProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverBodyState;

// @public
export const useTeachingPopoverBodyStyles_unstable: (state: TeachingPopoverBodyState) => TeachingPopoverBodyState;

// @public (undocumented)
export const useTeachingPopoverCarousel_unstable: (props: TeachingPopoverCarouselProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverCarouselState;

// @public
export const useTeachingPopoverCarouselCard_unstable: (props: TeachingPopoverCarouselCardProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverCarouselCardState;

// @public
export const useTeachingPopoverCarouselCardStyles_unstable: (state: TeachingPopoverCarouselCardState) => TeachingPopoverCarouselCardState;

// @public (undocumented)
export function useTeachingPopoverCarouselContextValues_unstable(state: TeachingPopoverCarouselState): TeachingPopoverCarouselContextValues;

// @public (undocumented)
export const useTeachingPopoverCarouselFooter_unstable: (props: TeachingPopoverCarouselFooterProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverCarouselFooterState;

// @public
export const useTeachingPopoverCarouselFooterButton_unstable: (props: TeachingPopoverCarouselFooterButtonProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => TeachingPopoverCarouselFooterButtonState;

// @public
export const useTeachingPopoverCarouselFooterButtonStyles_unstable: (state: TeachingPopoverCarouselFooterButtonState) => TeachingPopoverCarouselFooterButtonState;

// @public
export const useTeachingPopoverCarouselFooterStyles_unstable: (state: TeachingPopoverCarouselFooterState) => TeachingPopoverCarouselFooterState;

// @public
export const useTeachingPopoverCarouselNav_unstable: (props: TeachingPopoverCarouselNavProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverCarouselNavState;

// @public
export const useTeachingPopoverCarouselNavButton_unstable: (props: TeachingPopoverCarouselNavButtonProps, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => TeachingPopoverCarouselNavButtonState;

// @public
export const useTeachingPopoverCarouselNavButtonStyles_unstable: (state: TeachingPopoverCarouselNavButtonState) => TeachingPopoverCarouselNavButtonState;

// @public
export const useTeachingPopoverCarouselNavStyles_unstable: (state: TeachingPopoverCarouselNavState) => TeachingPopoverCarouselNavState;

// @public
export const useTeachingPopoverCarouselPageCount_unstable: (props: TeachingPopoverCarouselPageCountProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverCarouselPageCountState;

// @public
export const useTeachingPopoverCarouselPageCountStyles_unstable: (state: TeachingPopoverCarouselPageCountState) => TeachingPopoverCarouselPageCountState;

// @public
export const useTeachingPopoverCarouselStyles_unstable: (state: TeachingPopoverCarouselState) => TeachingPopoverCarouselState;

// @public
export const useTeachingPopoverFooter_unstable: (props: TeachingPopoverFooterProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverFooterState;

// @public
export const useTeachingPopoverHeader_unstable: (props: TeachingPopoverHeaderProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverHeaderState;

// @public
export const useTeachingPopoverHeaderStyles_unstable: (state: TeachingPopoverHeaderState) => TeachingPopoverHeaderState;

// @public
export const useTeachingPopoverSurface_unstable: (props: TeachingPopoverSurfaceProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverSurfaceState;

// @public
export const useTeachingPopoverSurfaceStyles_unstable: (state: TeachingPopoverSurfaceState) => TeachingPopoverSurfaceState;

// @public
export const useTeachingPopoverTitle_unstable: (props: TeachingPopoverTitleProps, ref: React_2.Ref<HTMLDivElement>) => TeachingPopoverTitleState;

// @public
export const useTeachingPopoverTitleStyles_unstable: (state: TeachingPopoverTitleState) => TeachingPopoverTitleState;

// @public
export const useTeachingPopoverTrigger_unstable: (props: TeachingPopoverTriggerProps) => TeachingPopoverTriggerState;

// (No @packageDocumentation comment for this package)