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

Host

GitHub

Changelog

npm

A SwiftUI Host component that enables SwiftUI components in React Native.

iOS

tvOS

A component that allows you to put the other @expo/ui/swift-ui components in React Native. It acts like <svg> for DOM, <Canvas> for react-native-skia, which underlying uses UIHostingController to render the SwiftUI views in UIKit.

Since the Host component is a React Native View, you can pass the style prop to it or matchContents prop to make the Host component match the contents' size.

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

Wrapping Button in Host

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

function Example() {
  return (
    <Host matchContents>
      <Button
        onPress={() => {
          console.log('Pressed');
        }}>
        Click
      </Button>
    </Host>
  );
}

Host with flexbox and VStack

import { Button, Host, VStack, Text } from '@expo/ui/swift-ui';

function Example() {
  return (
    <Host style={{ flex: 1 }}>
      <VStack spacing={8}>
        <Text>Hello, world!</Text>
        <Button
          onPress={() => {
            console.log('Pressed');
          }}>
          Click
        </Button>
      </VStack>
    </Host>
  );
}

API

Component

`Host`

iOS

tvOS

Type: React.Element<HostProps>

A hosting component for SwiftUI views.

HostProps

`children`

iOS

tvOS

Type: React.ReactNode

`colorScheme`

iOS

tvOS

Optional • Type: ColorSchemeName

The color scheme of the host view.

`matchContents`

iOS

tvOS

Optional • Literal type: union • Default: false

When true, the host view will update its size in the React Native view tree to match the content's layout from SwiftUI. Can be only set once on mount.

Acceptable values are: boolean | { horizontal: boolean, vertical: boolean }

`onLayoutContent`

iOS

tvOS

Optional • Type:

(event: {
  nativeEvent: {
  height: number, 
  width: number
}
}) => void

Callback function that is triggered when the SwiftUI content completes its layout. Provides the current dimensions of the content, which may change as the content updates.

`style`

iOS

tvOS

Optional • Type: StyleProp<ViewStyle>

`useViewportSizeMeasurement`

iOS

tvOS

Optional • Type: boolean • Default: false

When true and no explicit size is provided, the host will use the viewport size as the proposed size for SwiftUI layout. This is particularly useful for SwiftUI views that need to fill their available space, such as Form.

Inherited Props

CommonViewModifierProps