Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlaskit/image

atlassian55.6kApache-2.03.0.2TypeScript support: included

An image that changes in light or dark themes.

readme

Image

An image component with additional features, such as support for themes.

Installation

yarn add @atlaskit/image

Usage

import Image from '@atlaskit/image';

View documentation.

changelog

@atlaskit/image

3.0.2

Patch Changes

  • Updated dependencies

3.0.1

Patch Changes

  • Updated dependencies

3.0.0

Major Changes

  • #130672 c92554212ded6 - Migrated from @emotion/react to @compiled/react in order to improve performance, align with the rest of the Atlaskit techstack, and support React 18 Streaming SSR. Please note, in order to use this version of @atlaskit/image, you will need to ensure that your bundler is configured to handle .css imports correctly.

    Removed --img-source and --img-source-dark CSS variables and content CSS property from <img> since the content values were invalid before.

    Most bundlers come with built-in support for .css imports, so you may not need to do anything. If you are using a different bundler, please refer to the documentation for that bundler to understand how to handle .css imports. For more information on the migration, please refer to RFC-73 Migrating our components to Compiled CSS-in-JS.

2.0.0

Major Changes

Patch Changes

  • Updated dependencies

1.4.1

Patch Changes

  • Updated dependencies

1.4.0

Minor Changes

Patch Changes

  • Updated dependencies

1.3.11

Patch Changes

1.3.10

Patch Changes

  • Updated dependencies

1.3.9

Patch Changes

1.3.8

Patch Changes

  • Updated dependencies

1.3.7

Patch Changes

  • Updated dependencies

1.3.6

Patch Changes

  • Updated dependencies

1.3.5

Patch Changes

  • Updated dependencies

1.3.4

Patch Changes

  • #166026 962b5e77810fb - Adds side-effect config to support Compiled css extraction in third-party apps

1.3.3

Patch Changes

  • #156266 6029cf729997a - Fixes an issue where images with invalid/not-found urls will be requested in an infinite loop
  • Updated dependencies

1.3.2

Patch Changes

  • Updated dependencies

1.3.1

Patch Changes

  • Updated dependencies

1.3.0

Minor Changes

  • #110670 c733254a2dd6e - Explicitly set jsxRuntime to classic via pragma comments in order to avoid issues where jsxRuntime is implicitly set to automatic.

1.2.2

Patch Changes

  • Updated dependencies

1.2.1

Patch Changes

  • #89307 47cdc66371fb - [ux] Fix bug where images flickered in dark mode. Source URLs are now set based on the current theme before first paint.
  • Updated dependencies

1.2.0

Minor Changes

1.1.7

Patch Changes

1.1.6

Patch Changes

  • #38487 b2da5b33468 - Documents that props like css and className are unsafe and will be deprecated in the future.

1.1.5

Patch Changes

  • #36754 4ae083a7e66 - Use @af/accessibility-testing for default jest-axe config and jest-axe import in accessibility testing.

1.1.4

Patch Changes

1.1.3

Patch Changes

  • #32935 b1bdec7cce2 - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change.

1.1.2

Patch Changes

1.1.1

Patch Changes

1.1.0

Minor Changes

Patch Changes

  • Updated dependencies

1.0.4

Patch Changes

  • #27634 718d5ad3044 - Updates to support the new @atlaskit/tokens theming API.
  • Updated dependencies

1.0.3

Patch Changes

  • Updated dependencies

1.0.2

Patch Changes

  • Updated dependencies

1.0.1

Patch Changes

  • #28081 98f5ba36c98 - Updates atlaskit/image thumbnails + descriptions for the website

1.0.0

Major Changes

  • #28012 bc74a5feb7d - This package is no longer experimental and the API is considered stable. Version contains no changes what so ever.

0.2.1

Patch Changes

  • #27885 c674eafa051 - Fixes a bug where the system preference would override the default behaviour when the color-mode was not set to auto. As a result, an OS setting of "dark" and a product setting of "light" would result in a "dark" image.

0.2.0

Minor Changes

  • #27046 8ab96dfc824 - Adds a new Image primitive that works like the native HTML img element, with the added functionality of being theme-aware.

0.1.0

  • Create Image component with theme functionality.