ContextQMD
Back to Fluentui

React Migration V0 V9.Api

packages/react-components/react-migration-v0-v9/library/etc/react-migration-v0-v9.api.md

4.40.2-hotfix211.5 KB
Original Source

API Report File for "@fluentui/react-migration-v0-v9"

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

ts

import { ButtonProps } from '@fluentui/react-components';
import { ComponentProps } from '@fluentui/react-components';
import type { ComponentProps as ComponentProps_2 } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import { GriffelStyle } from '@fluentui/react-components';
import type { JSXElement } from '@fluentui/react-utilities';
import type { JSXIntrinsicElement } from '@fluentui/react-utilities';
import type { JSXIntrinsicElementKeys } from '@fluentui/react-utilities';
import type { ObjectShorthandValue } from '@fluentui/react-northstar';
import * as React_2 from 'react';
import { SelectionHookParams } from '@fluentui/react-utilities';
import { SelectionItemId } from '@fluentui/react-utilities';
import type { SelectionMode as SelectionMode_2 } from '@fluentui/react-utilities';
import { Slot } from '@fluentui/react-components';
import { Slot as Slot_2 } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public (undocumented)
export const Attachment: React_2.ForwardRefExoticComponent<AttachmentProps & React_2.RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export const AttachmentAction: React_2.ForwardRefExoticComponent<ButtonProps & React_2.RefAttributes<HTMLButtonElement>>;

// @public (undocumented)
export const attachmentActionClassName = "fui-AttachmentAction";

// @public (undocumented)
export type AttachmentActionProps = ButtonProps;

// @public (undocumented)
export const AttachmentBody: React_2.FC<AttachmentBodyProps>;

// @public (undocumented)
export const attachmentBodyClassName = "fui-AttachmentBody";

// @public (undocumented)
export interface AttachmentBodyProps extends React_2.HTMLAttributes<HTMLDivElement> {
}

// @public (undocumented)
export const attachmentClassName = "fui-Attachment";

// @public (undocumented)
export const AttachmentDescription: React_2.FC<AttachmentDescriptionProps>;

// @public (undocumented)
export const attachmentDescriptionClassName = "fui-AttachmentDescription";

// @public (undocumented)
export interface AttachmentDescriptionProps extends React_2.HTMLAttributes<HTMLSpanElement> {
}

// @public (undocumented)
export const AttachmentHeader: React_2.FC<AttachmentHeaderProps>;

// @public (undocumented)
export const attachmentHeaderClassName = "fui-AttachmentHeader";

// @public (undocumented)
export interface AttachmentHeaderProps extends React_2.HTMLAttributes<HTMLSpanElement> {
}

// @public (undocumented)
export const AttachmentIcon: React_2.FC<AttachmentIconProps>;

// @public (undocumented)
export const attachmentIconClassName = "fui-AttachmentIcon";

// @public (undocumented)
export interface AttachmentIconProps extends React_2.HTMLAttributes<HTMLSpanElement> {
}

// @public (undocumented)
export const attachmentProgressBarClassName = "fui-Attachment__progress";

// @public (undocumented)
export const attachmentProgressContainerClassName = "fui-Attachment__progress-container";

// @public (undocumented)
export interface AttachmentProps extends React_2.HTMLAttributes<HTMLElement> {
    // (undocumented)
    actionable?: boolean;
    // (undocumented)
    disabled?: boolean;
    // (undocumented)
    onClick?: (event: React_2.MouseEvent<HTMLDivElement, MouseEvent>) => void;
    // (undocumented)
    progress?: string | number;
}

// @public (undocumented)
export const Flex: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLElement> & FlexProps & React_2.RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export const flexClassName = "fui-Flex";

// @public (undocumented)
export const flexItem: {
    align: (value: "auto" | "start" | "end" | "center" | "baseline" | "stretch") => GriffelStyle;
    size: (value: "half" | "quarter" | "small" | "medium" | "large") => GriffelStyle;
    grow: (flexGrow: boolean | number) => GriffelStyle | undefined;
    shrink: (flexShrink: boolean | number) => GriffelStyle | undefined;
    pushRow: () => GriffelStyle;
    pushColumn: () => GriffelStyle;
};

// @public (undocumented)
export const FormFieldShim: React_2.ForwardRefExoticComponent<{
    errorMessage?: WithContent;
    required?: boolean;
    control?: ObjectShorthandValue<{
        content?: React_2.ReactNode;
    }> & {
        error?: "true" | "false";
    };
    label?: WithContent;
} & {
    children?: React_2.ReactNode | undefined;
} & React_2.RefAttributes<HTMLInputElement>>;

// @public (undocumented)
export const grid: {
    columns: (template: string) => GriffelStyle;
    rows: (template: string) => GriffelStyle;
};

// @public (undocumented)
export const gridClassName = "fui-Grid";

// @public (undocumented)
export const GridShim: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLElement> & GridShimProps & React_2.RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export interface GridShimProps {
    columns?: 1 | 2 | 3;
    rows?: 1 | 2 | 3;
}

// @public (undocumented)
export const input: {
    error: () => GriffelStyle;
    errorIndicator: () => GriffelStyle;
    fluid: () => GriffelStyle;
    successIndicator: () => GriffelStyle;
};

// @public (undocumented)
export const ItemLayout: React_2.ForwardRefExoticComponent<Omit<ItemLayoutSlots, "root"> & Omit<{
    as?: "div" | undefined;
} & Omit<React_2.DetailedHTMLProps<React_2.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "children"> & {
    children?: any;
}, "ref"> & React_2.RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export const itemLayoutClassName = "fui-ItemLayout";

// @public (undocumented)
export const List: ForwardRefComponent<ListProps>;

// @public (undocumented)
export const listClassNames: SlotClassNames<ListSlots>;

// @public (undocumented)
export const ListItem: ForwardRefComponent<ListItemProps>;

// @public (undocumented)
export const listItemClassNames: SlotClassNames<ListItemSlots>;

// @public
export type ListItemProps = ComponentProps_2<ListItemSlots> & {
    value?: string | number;
    truncateHeader?: boolean;
    truncateContent?: boolean;
};

// @public (undocumented)
export type ListItemSlots = {
    root: NonNullable<Slot_2<'li', 'div'>>;
    media?: React_2.ComponentProps<typeof ItemLayout>['startMedia'];
    header?: React_2.ComponentProps<typeof ItemLayout>['header'];
    contentWrapper?: React_2.ComponentProps<typeof ItemLayout>['contentWrapper'];
    headerMedia?: React_2.ComponentProps<typeof ItemLayout>['headerMedia'];
    contentMedia?: React_2.ComponentProps<typeof ItemLayout>['contentMedia'];
    endMedia?: React_2.ComponentProps<typeof ItemLayout>['endMedia'];
};

// @public
export type ListItemState = ComponentState<ListItemSlots> & {
    selectable?: boolean;
    selected?: boolean;
    navigable?: boolean;
    truncateHeader?: boolean;
    truncateContent?: boolean;
};

// @public
export type ListProps = ComponentProps_2<ListSlots> & {
    layout?: ListLayout;
    navigable?: boolean;
    selectable?: boolean;
    selectionMode?: SelectionMode_2;
    selectedItems?: SelectionItemId[];
    defaultSelectedItems?: SelectionItemId[];
    onSelectionChange?: (event: React_2.SyntheticEvent, data: {
        selectedItems: SelectionItemId[];
    }) => void;
    truncateHeader?: boolean;
    truncateContent?: boolean;
};

// @public (undocumented)
export type ListSlots = {
    root: NonNullable<Slot_2<'ul', 'div' | 'ol'>>;
};

// @public
export type ListState = ComponentState<ListSlots> & Required<Pick<ListProps, 'layout'>> & ListContextValue;

// @public (undocumented)
export const Primitive: PrimitiveComponent;

// @public (undocumented)
export const primitiveClassName = "fui-Primitive";

// @public
export const renderList_unstable: (state: ListState, contextValues: ListContextValues) => JSXElement;

// @public
export const renderListItem_unstable: (state: ListItemState) => JSXElement;

// @public (undocumented)
export const Segment: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLElement> & React_2.RefAttributes<HTMLDivElement>>;

// @public (undocumented)
export const slider: {
    fluid: () => GriffelStyle;
};

// @public (undocumented)
export const spinner: {
    v0Inline: () => GriffelStyle;
    v0SpinnerLabelStyle: () => GriffelStyle;
};

// @public (undocumented)
export const StyledText: React_2.ForwardRefExoticComponent<StyledTextProps & React_2.RefAttributes<HTMLSpanElement>>;

// @public (undocumented)
export const styledTextClassName = "fui-StyledText";

// @public (undocumented)
export type StyledTextProps = ComponentProps<StyledTextSlots> & {
    align?: 'start' | 'center' | 'end' | 'justify';
    atMention?: 'me' | boolean;
    disabled?: boolean;
    error?: boolean;
    important?: boolean;
    size?: 'smaller' | 'small' | 'medium' | 'large' | 'large500' | 'larger' | 'largest' | 100 | 200 | 300 | 400 | 500 | 600 | 700;
    success?: boolean;
    temporary?: boolean;
    timestamp?: boolean;
    truncate?: boolean;
    weight?: 'light' | 'semilight' | 'regular' | 'medium' | 'semibold' | 'bold';
    wrap?: boolean;
};

// @public (undocumented)
export type StyledTextSlots = {
    root: Slot<'span', 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'pre' | 'time'>;
};

// @public (undocumented)
export const useFlexStyles: () => Record<"flex" | "fill" | "inline" | "column" | "wrap" | "alignItemsFlexStart" | "alignItemsCenter" | "alignItemsFlexEnd" | "alignItemsStretch" | "justifyContentFlexStart" | "justifyContentCenter" | "justifyContentFlexEnd" | "justifyContentStretch" | "justifyContentSpaceAround" | "justifyContentSpaceBetween" | "justifyContentSpaceEvenly" | "gapForColumnFlexSmall" | "gapForColumnFlexSmaller" | "gapForColumnFlexMedium" | "gapForColumnFlexLarge" | "gapForRowFlexSmall" | "gapForRowFlexSmaller" | "gapForRowFlexMedium" | "gapForRowFlexLarge" | "paddingMedium", string>;

// @public (undocumented)
export const useGridStyles: () => Record<"grid" | "onlyRows" | "rows1" | "rows2" | "rows3" | "columns1" | "columns2" | "columns3" | "columnsDefault", string>;

// @public (undocumented)
export const useItemLayoutStyles: () => Record<"root" | "header" | "contentMedia" | "contentWrapper" | "headerMedia" | "startMedia" | "endMedia", string>;

// @public
export const useList_unstable: (props: ListProps, ref: React_2.Ref<HTMLDivElement | HTMLUListElement>) => ListState;

// @public
export const useListItem_unstable: (props: ListItemProps, ref: React_2.Ref<HTMLLIElement | HTMLDivElement>) => ListItemState;

// @public
export const useListItemStyles_unstable: (state: ListItemState) => ListItemState;

// @public (undocumented)
export function useListSelection(options?: SelectionHookParams): ListSelectionState;

// @public
export const useListStyles_unstable: (state: ListState) => ListState;

// @public (undocumented)
export const v0Icon: () => GriffelStyle;

// @public (undocumented)
export const v9CustomSizeIcon: () => GriffelStyle;

// @public (undocumented)
export const v9DisabledCursor: () => GriffelStyle;

// @public (undocumented)
export const v9HoverClasses: () => GriffelStyle;

// @public (undocumented)
export const v9Icon: () => GriffelStyle;

// @public (undocumented)
export const Video: React_2.ForwardRefExoticComponent<VideoProps & React_2.RefAttributes<HTMLVideoElement>>;

// @public (undocumented)
export const videoClassName = "fui-Video";

// @public
export interface VideoProps extends React_2.VideoHTMLAttributes<HTMLVideoElement> {
    autoPlay?: boolean;
    controls?: boolean;
    loop?: boolean;
    muted?: boolean;
    poster?: string;
    src: string;
}

// (No @packageDocumentation comment for this package)