This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 54).

Image

A SwiftUI Image component for displaying SF Symbols.

iOS

tvOS

GitHub

npm

Changelog

Expo UI Image displays SF Symbols using the SwiftUI Image API. SF Symbols are a library of configurable symbols provided by Apple.

Installation

Terminal

- npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Basic SF Symbol

BasicImageExample.tsx

import { Host, Image } from '@expo/ui/swift-ui';

export default function BasicImageExample() {
  return (
    <Host matchContents>
      <Image systemName="star.fill" />
    </Host>
  );
}

With size and color

ImageSizeColorExample.tsx

import { Host, HStack, Image } from '@expo/ui/swift-ui';

export default function ImageSizeColorExample() {
  return (
    <Host matchContents>
      <HStack spacing={16}>
        <Image systemName="heart.fill" size={24} color="red" />
        <Image systemName="star.fill" size={32} color="orange" />
        <Image systemName="bell.fill" size={40} color="blue" />
      </HStack>
    </Host>
  );
}

With variable value

Some SF Symbols alter their appearance based on a variable value. Use the variableValue prop with a value between 0.0 and 1.0 to control the rendered symbol. Requires iOS 16.0+ and SF Symbols 4.0+.

ImageVariableExample.tsx

import { Host, HStack, Image } from '@expo/ui/swift-ui';

export default function ImageVariableExample() {
  return (
    <Host matchContents>
      <HStack spacing={16}>
        <Image systemName="chart.bar.fill" size={32} variableValue={0.3} />
        <Image systemName="chart.bar.fill" size={32} variableValue={0.6} />
        <Image systemName="chart.bar.fill" size={32} variableValue={1.0} />
      </HStack>
    </Host>
  );
}

API

Component

`Image`

iOS

tvOS

Type: React.Element<ImageProps>

ImageProps

`color`

iOS

tvOS

Optional • Type: ColorValue

The color of the system image. Can be a color name like '#ff00ff', 'red', 'blue', etc.

`onPress`

iOS

tvOS

Optional • Type: () => void

Callback triggered when the view is pressed.

`size`

iOS

tvOS

Optional • Type: number

The size of the system image.

`systemName`

iOS

tvOS

Type: SFSymbols6_0

The name of the system image (SF Symbol). For example: 'photo', 'heart.fill', 'star.circle'

`variableValue`

iOS16.0+

tvOS16.0+

Optional • Type: number

The variable value that alters the symbol's appearance. A number between 0.0 and 1.0. Only works with SF Symbols that support variable values (SF Symbols 4.0+).

Inherited Props

CommonViewModifierProps