Package Exports

@fluentui/react-image

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@fluentui/react-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@fluentui/react-image

React Image component for Fluent UI React

WIP 🚧 - These are not production-ready components as we are still in a Beta phase.

Usage of Image component ensures consistent styling and behaviour of images in your application based on the Fluent UI Design System.

Usage

To use the Image component, it is required to install the main package of Fluent UI components:

npm install @fluentui/react-components

import { Image } from '@fluentui/react-components';

const App = () => {
  return <Image src="example_image.png" />;
};

Or, installing only the react-image package:

npm install @fluentui/react-image
npm install @fluentui/react-provider

import { Image } from '@fluentui/react-image';
import { FluentProvider } from '@fluentui/react-provider';

const App = () => (
  <FluentProvider>
    <Image src="example_image.png" alt="Example image" />;
  </FluentProvider>
);

The DOM structure will result into:

<img src="example_image.png" alt="Example image" />

API

Image component is build upon the <img/> tag, which does support all the native attributes. Additionaly, the following properties are available: bordered, fit, block, shape and shadow.

For more information on the component, please refer to the API documentation.

Migration

For migrating from older versions of FluentUI, please check out the migration guide