This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.
主机
一个 SwiftUI 主机组件,使 SwiftUI 组件能够在 React Native 中使用。
信息 有关跨平台使用,请参阅通用
Host—— 它会根据平台呈现相应的原生组件。
一个组件,允许你在 React Native 中放置其他 @expo/ui/swift-ui 组件。它的作用类似于 DOM 的 <svg>,react-native-skia 的 <Canvas>,其底层使用 UIHostingController 在 UIKit 中渲染 SwiftUI 视图。
🌐 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.
由于 Host 组件是一个 React Native View,你可以向它传递 style 属性,或者传递 matchContents 属性,使 Host 组件匹配内容的大小。
🌐 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
- npx expo install @expo/uiIf you are installing this in an existing React Native app, make sure to install expo in your project.
用法
🌐 Usage
匹配内容大小
🌐 Match contents sizing
使用 matchContents 让 Host 自动调整大小以适应其 SwiftUI 内容,而不需要明确的尺寸。
🌐 Use matchContents to let the Host automatically size itself to fit its SwiftUI content, instead of requiring explicit dimensions.
import { Button, Host } from '@expo/ui/swift-ui'; export default function MatchContentsExample() { return ( <Host matchContents> <Button onPress={() => { console.log('Pressed'); }}> Click </Button> </Host> ); }
注意: 不要在与滚动容器(
ScrollView、List、Form、LazyHStack、LazyVStack)相同的轴上使用matchContents。matchContents对应 SwiftUI 的.fixedSize,它会根据内容调整滚动容器的大小。它还会导致视口之外没有可滚动的内容,因此滚动会悄无声息地停止工作。请将matchContents={{ vertical: true }}与style={{ width: '100%' }}(或滚动轴上的任何有限宽度)一起使用。
import { Host, HStack, ScrollView, Text } from '@expo/ui/swift-ui'; export default function ScrollViewMatchContents() { return ( <Host matchContents={{ vertical: true }} style={{ width: '100%' }}> <ScrollView axes="horizontal"> <HStack spacing={12}> {Array.from({ length: 20 }).map((_, i) => ( <Text key={i}>Item {i}</Text> ))} </HStack> </ScrollView> </Host> ); }
使用样式进行显式设置大小
🌐 Explicit sizing with style
使用 style 来设置 Host 的明确大小,例如使用 flex: 1 填充可用空间。
🌐 Use style to set explicit sizes on the Host, such as filling the available space with flex: 1.
import { Button, Host, VStack, Text } from '@expo/ui/swift-ui'; export default function ExplicitSizingExample() { return ( <Host style={{ flex: 1 }}> <VStack spacing={8}> <Text>Hello, world!</Text> <Button onPress={() => { console.log('Pressed'); }}> Click </Button> </VStack> </Host> ); }
忽略键盘安全区域
🌐 Ignoring keyboard safe area
当 React Native 已经处理键盘避免(例如使用 react-native-keyboard-controller)时,使用 ignoreSafeArea="keyboard",以防止 SwiftUI 宿主应用自身的键盘内边距。
🌐 Use ignoreSafeArea="keyboard" when React Native is already handling keyboard avoidance (for example, with react-native-keyboard-controller), to prevent the SwiftUI host from applying its own keyboard inset.
import { Host, TextField } from '@expo/ui/swift-ui'; import { KeyboardProvider, KeyboardStickyView } from 'react-native-keyboard-controller'; import { View } from 'react-native'; export default function IgnoreKeyboardExample() { return ( <KeyboardProvider> <View style={{ flex: 1, backgroundColor: 'black' }}> <KeyboardStickyView style={{ position: 'absolute', bottom: 0, left: 0, right: 0, padding: 16, backgroundColor: 'green', }}> <Host matchContents ignoreSafeArea="keyboard" style={{ backgroundColor: 'red' }}> <TextField placeholder="Enter text" axis="vertical" /> </Host> </KeyboardStickyView> </View> </KeyboardProvider> ); }
忽略所有安全区域
🌐 Ignoring all safe areas
当你希望 SwiftUI 内容延伸到状态栏后面时,使用 ignoreSafeArea="all",这对于全屏覆盖或背景非常有用。
🌐 Use ignoreSafeArea="all" when you want SwiftUI content to extend behind the status bar, useful for full-screen overlays or backgrounds.
import { Host, Text, VStack } from '@expo/ui/swift-ui'; export default function IgnoreAllSafeAreasExample() { return ( <Host ignoreSafeArea="all" style={{ position: 'absolute', top: 0, left: 0, right: 0, bottom: 0 }}> <VStack> <Text>This content extends behind the status bar and home indicator.</Text> </VStack> </Host> ); }
应用接口
🌐 API
import { Host } from '@expo/ui/swift-ui';
Component
Type: React.Element<HostProps>
A hosting component for SwiftUI views.
ReactNodestringThe color scheme of the host view.
Acceptable values are: 'light' | 'dark'
stringControls which safe area regions the SwiftUI hosting view should ignore. Can only be set once on mount.
'all'- ignores all safe area insets.'keyboard'- ignores only the keyboard safe area.
Acceptable values are: 'all' | 'keyboard'
stringThe layout direction for the SwiftUI content. Defaults to the current locale direction from I18nManager.
Acceptable values are: 'leftToRight' | 'rightToLeft'
union • Default: falseWhen 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
}
(event: {
nativeEvent: {
height: number,
width: number
}
}) => voidCallback 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.
stringAcceptable values are: 'box-none' | 'none' | 'box-only' | 'auto'
ColorValueSeed color applied to the SwiftUI content as its tint. It propagates through the SwiftUI environment to theme interactive elements (buttons, switches, sliders, and similar controls) rendered by the children.
StyleProp<ViewStyle>boolean • Default: falseWhen 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.