按钮

一个用于显示原生按钮的 SwiftUI Button 组件。

iOS

tvOS

GitHub

npm

更新日志

Bundled version:

~55.0.0-beta.0

Expo UI Button 与官方 SwiftUI Button API 保持一致，并支持通过 buttonStyle、controlSize 以及其他修饰器进行样式设置。

安装

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.

用法

基础按钮

BasicButtonExample.tsx

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

export default function BasicButtonExample() {
  return (
    <Host matchContents>
      <Button label="按我" onPress={() => alert('已按下！')} />
    </Host>
  );
}

带系统图像的按钮

ButtonWithImageExample.tsx

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

export default function ButtonWithImageExample() {
  return (
    <Host matchContents>
      <Button
        label="下载"
        systemImage="arrow.down.circle"
        onPress={() => alert('正在下载...')}
      />
    </Host>
  );
}

仅图标按钮

使用 labelStyle 修饰器仅显示图标，同时保留标签以便辅助功能使用。

IconOnlyButtonExample.tsx

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

export default function IconOnlyButtonExample() {
  return (
    <Host matchContents>
      <Button
        label="设置"
        systemImage="gear"
        modifiers={[labelStyle('iconOnly')]}
        onPress={() => alert('设置')}
      />
    </Host>
  );
}

按钮样式

使用 buttonStyle 修饰器来更改按钮外观。可用样式有：bordered、borderedProminent、borderless、plain、glass 和 glassProminent。

注意： glass 和 glassProminent 样式仅在使用 Xcode 26 构建时的 iOS 26+ 上可用。

ButtonStylesExample.tsx

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

export default function ButtonStylesExample() {
  return (
    <Host matchContents>
      <VStack spacing={8}>
        <Button label="有边框" modifiers={[buttonStyle('bordered')]} />
        <Button label="强调有边框" modifiers={[buttonStyle('borderedProminent')]} />
        <Button label="无边框" modifiers={[buttonStyle('borderless')]} />
        <Button label="普通" modifiers={[buttonStyle('plain')]} />
      </VStack>
    </Host>
  );
}

控件尺寸

使用 controlSize 修饰器来调整按钮大小。可用尺寸有：mini、small、regular、large 和 extraLarge。

注意： extraLarge 尺寸仅在 iOS 17+ 上可用。

ControlSizeExample.tsx

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

export default function ControlSizeExample() {
  return (
    <Host matchContents>
      <VStack spacing={8}>
        <Button label="迷你" modifiers={[controlSize('mini'), buttonStyle('bordered')]} />
        <Button label="小" modifiers={[controlSize('small'), buttonStyle('bordered')]} />
        <Button label="常规" modifiers={[controlSize('regular'), buttonStyle('bordered')]} />
        <Button label="大" modifiers={[controlSize('large'), buttonStyle('bordered')]} />
      </VStack>
    </Host>
  );
}

按钮角色

使用 role 属性来指示按钮的语义角色。可用角色有：default、cancel 和 destructive。

ButtonRolesExample.tsx

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

export default function ButtonRolesExample() {
  return (
    <Host matchContents>
      <VStack spacing={8}>
        <Button label="默认" role="default" />
        <Button label="取消" role="cancel" />
        <Button label="删除" role="destructive" />
      </VStack>
    </Host>
  );
}

着色按钮

使用 tint 修饰器更改按钮颜色。

TintedButtonExample.tsx

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

export default function TintedButtonExample() {
  return (
    <Host matchContents>
      <Button label="自定义颜色" modifiers={[tint('#FF6347')]} />
    </Host>
  );
}

禁用按钮

使用 disabled 修饰器来禁用按钮。

DisabledButtonExample.tsx

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

export default function DisabledButtonExample() {
  return (
    <Host matchContents>
      <Button label="已禁用" modifiers={[disabled()]} />
    </Host>
  );
}

自定义标签内容

你可以将自定义组件作为 children 传入，以实现更复杂的按钮标签内容。

CustomContentExample.tsx

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

export default function CustomContentExample() {
  return (
    <Host matchContents>
      <Button onPress={() => console.log('已按下！')}>
        <VStack spacing={4}>
          <Image systemName="folder" />
          <Text>文件夹</Text>
        </VStack>
      </Button>
    </Host>
  );
}

API

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

Component

`Button`

iOS

tvOS

Type: React.Element<ButtonProps>

Displays a native button component.

Example

import { Button } from '@expo/ui/swift-ui';
import { buttonStyle, controlSize, tint, disabled } from '@expo/ui/swift-ui/modifiers';

<Button
  role="destructive"
  onPress={handlePress}
  label="Delete"
  modifiers={[
    buttonStyle('bordered'),
    controlSize('large'),
    tint('#FF0000'),
    disabled(true)
  ]}
/>

ButtonProps

`children`

iOS

tvOS

Optional • Literal type: union

Custom content for the button label. Use this for custom label views. Only nested elements are supported, not plain strings.

Acceptable values are: React.ReactElement | React.ReactElement

`label`

iOS

tvOS

Optional • Type: string

The text label for the button. Use this for simple text buttons.

`onPress`

iOS

tvOS

Optional • Type: () => void

A callback that is called when the button is pressed.

`role`

iOS

tvOS

Optional • Type: ButtonRole

Indicates the role of the button.

`systemImage`

iOS

tvOS

Optional • Type: SFSymbol

A string describing the system image to display in the button. Only used when label is provided.

`target`

iOS

tvOS

Optional • Type: string

Target identifier for the button, used for identifying which button was pressed in widgets and live activities.

Inherited Props

CommonViewModifierProps

Types

`ButtonRole`

iOS

tvOS

Literal Type: string

The role of the button.

default - The default button role.
cancel - A button that cancels the current operation.
destructive - A button that deletes data or performs a destructive action.

Acceptable values are: 'default' | 'cancel' | 'destructive'