ContextQMD
Back to Fluentui

React Image.Api

packages/react-components/react-image/library/etc/react-image.api.md

4.40.2-hotfix21.6 KB
Original Source

API Report File for "@fluentui/react-image"

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 * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
const Image_2: ForwardRefComponent<ImageProps>;
export { Image_2 as Image }

// @public (undocumented)
export const imageClassNames: SlotClassNames<ImageSlots>;

// @public (undocumented)
export type ImageProps = ComponentProps<ImageSlots> & {
    block?: boolean;
    bordered?: boolean;
    fit?: 'none' | 'center' | 'contain' | 'cover' | 'default';
    shadow?: boolean;
    shape?: 'square' | 'circular' | 'rounded';
};

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

// @public (undocumented)
export type ImageState = ComponentState<ImageSlots> & Required<Pick<ImageProps, 'block' | 'bordered' | 'fit' | 'shadow' | 'shape'>>;

// @public
export const renderImage_unstable: (state: ImageState) => JSXElement;

// @public
export const useImage_unstable: (props: ImageProps, ref: React_2.Ref<HTMLImageElement>) => ImageState;

// @public (undocumented)
export const useImageStyles_unstable: (state: ImageState) => ImageState;

// (No @packageDocumentation comment for this package)