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

Label

A SwiftUI Label component for displaying text with an icon.

iOS

tvOS

Included in Expo Go

GitHub

npm

Changelog

Expo UI Label matches the official SwiftUI Label API and displays a title alongside an icon.

Three Label rows with SF Symbols inside a Form

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 label with SF Symbol

BasicLabelExample.tsx

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

export default function BasicLabelExample() {
  return (
    <Host matchContents>
      <Label title="Favorites" systemImage="star.fill" />
    </Host>
  );
}

With custom icon

Use the icon prop to provide a custom React node as the icon instead of an SF Symbol.

LabelCustomIconExample.tsx

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

export default function LabelCustomIconExample() {
  return (
    <Host matchContents>
      <Label title="Custom Icon" icon={<Image systemName="sparkles" size={20} color="purple" />} />
    </Host>
  );
}

Icon only

Use the labelStyle modifier with iconOnly to display only the icon. Always provide a title for accessibility even though it won't be visible.

LabelIconOnlyExample.tsx

import { Host, Label } from '@expo/ui/swift-ui';
import { labelStyle } from '@expo/ui/swift-ui/modifiers';

export default function LabelIconOnlyExample() {
  return (
    <Host matchContents>
      <Label title="Settings" systemImage="gear" modifiers={[labelStyle('iconOnly')]} />
    </Host>
  );
}

API

import { Label } from '@expo/ui/swift-ui';

Component

`Label`

iOS

tvOS

Type: React.Element<LabelProps>

Renders a native label view, which could be used in a list or section.

LabelProps

`children`

iOS

tvOS

Optional • Type: ReactNode

Custom title view. Accepts any React node (for example, a VStack with title and subtitle). When provided, this takes precedence over title.

Deprecated: Use foregroundStyle modifier instead.

`color`

iOS

tvOS

Optional • Type: ColorValue

The color of the label icon.

`icon`

iOS

tvOS

Optional • Type: ReactNode

Custom icon view to be displayed in the label. When provided, this takes precedence over systemImage.

`systemImage`

iOS

tvOS

Optional • Type: SFSymbols7_0

The name of the SFSymbol to be displayed in the label.

`title`

iOS

tvOS

Optional • Type: string

The title text to be displayed in the label.

Inherited Props

CommonViewModifierProps