Surface

一个用于样式化内容容器的 Jetpack Compose Surface 组件。

Android

GitHub

npm

更新日志

Bundled version:

~55.0.0-beta.0

Expo UI Surface 与官方 Jetpack Compose Surface API 保持一致，并提供一个容器，用于应用 Material Design 的 Surface 样式，包括颜色、海拔和内容颜色。

安装

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.

用法

基础 Surface

BasicSurfaceExample.tsx

import { Host, Surface, Text } from '@expo/ui/jetpack-compose';
import { paddingAll } from '@expo/ui/jetpack-compose/modifiers';

export default function BasicSurfaceExample() {
  return (
    <Host matchContents>
      <Surface modifiers={[paddingAll(16)]}>
        <Text>Surface 上的内容</Text>
      </Surface>
    </Host>
  );
}

带海拔的 Surface

使用 tonalElevation 和 shadowElevation 来控制 Surface 的视觉深度。

SurfaceElevationExample.tsx

import { Host, Surface, Column, Text } from '@expo/ui/jetpack-compose';
import { paddingAll } from '@expo/ui/jetpack-compose/modifiers';

export default function SurfaceElevationExample() {
  return (
    <Host matchContents>
      <Column modifiers={[paddingAll(16)]}>
        <Surface tonalElevation={1} shadowElevation={2} modifiers={[paddingAll(16)]}>
          <Text>低海拔</Text>
        </Surface>
        <Surface tonalElevation={4} shadowElevation={8} modifiers={[paddingAll(16)]}>
          <Text>高海拔</Text>
        </Surface>
      </Column>
    </Host>
  );
}

带自定义颜色的 Surface

使用 color 和 contentColor 属性覆盖默认的 Material 主题颜色。

SurfaceCustomColorsExample.tsx

import { Host, Surface, Text } from '@expo/ui/jetpack-compose';
import { paddingAll } from '@expo/ui/jetpack-compose/modifiers';

export default function SurfaceCustomColorsExample() {
  return (
    <Host matchContents>
      <Surface
        color="#1E3A5F"
        contentColor="#FFFFFF"
        tonalElevation={2}
        modifiers={[paddingAll(16)]}>
        <Text color="#FFFFFF">自定义颜色的 Surface</Text>
      </Surface>
    </Host>
  );
}

带形状和边框的 Surface

使用 shape 属性裁剪内容，并使用 border 在 Surface 周围绘制描边。

SurfaceShapeBorderExample.tsx

import { Host, Surface, Shape, Text } from '@expo/ui/jetpack-compose';
import { paddingAll } from '@expo/ui/jetpack-compose/modifiers';

export default function SurfaceShapeBorderExample() {
  return (
    <Host matchContents>
      <Surface
        shape={Shape.RoundedCorner({
          cornerRadii: { topStart: 16, topEnd: 16, bottomStart: 16, bottomEnd: 16 },
        })}
        border={{ width: 2, color: '#6200EE' }}
        modifiers={[paddingAll(16)]}>
        <Text>带边框的圆角 Surface</Text>
      </Surface>
    </Host>
  );
}

API

import { Surface } from '@expo/ui/jetpack-compose';

Component

`Surface`

Android

Type: React.Element<SurfaceProps>

A Material Design surface container. Surface is responsible for:

Clipping content to the shape
Applying background color based on tonal elevation
Providing content color to its children

SurfaceProps

`border`

Android

Optional • Type: SurfaceBorder

Border stroke drawn around the surface.

`checked`

Android

Optional • Type: boolean

Whether the surface is in a checked (toggled on) state. When provided together with onCheckedChange, the surface becomes a toggleable surface.

`children`

Android

Optional • Type: React.ReactNode

The content to display inside the surface.

`color`

Android

Optional • Type: ColorValue

The background color of the surface. Defaults to MaterialTheme.colorScheme.surface.

`contentColor`

Android

Optional • Type: ColorValue

The color of the content inside the surface. Defaults to contentColorFor(color).

`enabled`

Android

Optional • Type: boolean • Default: true

Whether the surface is enabled and responds to user interaction.

`modifiers`

Android

Optional • Type: ModifierConfig[]

Modifiers for the component.

`onCheckedChange`

Android

Optional • Type: (checked: boolean) => void

Called when the checked state of a toggleable surface changes. Providing this callback together with checked enables the toggleable variant.

`onClick`

Android

Optional • Type: () => void

Called when the surface is clicked. Providing this callback makes the surface clickable. When combined with selected, the surface becomes a selectable variant.

`selected`

Android

Optional • Type: boolean

Whether the surface is in a selected state. When provided together with onClick, the surface becomes a selectable surface that visually reflects its selection state.

`shadowElevation`

Android

Optional • Type: number • Default: 0

The shadow elevation of the surface. Value in dp.

`shape`

Android

Optional • Type: ShapeJSXElement

Shape configuration for clipping the surface.

`tonalElevation`

Android

Optional • Type: number • Default: 0

The tonal elevation of the surface, which affects its background color based on the color scheme. Value in dp.

Types

`SurfaceBorder`

Android

Border stroke configuration.

Property	Type	Description
color(optional)	`ColorValue`	Border color. Default:`MaterialTheme.colorScheme.outline`
width(optional)	`number`	Border width in dp. Default:`1`