Group

Expo UI Group matches the official SwiftUI Group API and groups views together without introducing additional layout structure.

Usage

Basic group

Groups are useful for applying modifiers to multiple views at once or organizing views without affecting layout.

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

export default function BasicGroupExample() {
  return (
    <Host matchContents style={{ alignSelf: 'center' }}>
      <VStack spacing={8}>
        <Group modifiers={[foregroundStyle('blue')]}>
          <Text>First item</Text>
          <Text>Second item</Text>
          <Text>Third item</Text>
        </Group>
      </VStack>
    </Host>
  );
}

Three lines of blue text stacked vertically: First item, Second item, and Third item.

API

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

Component

`Group`

Type: React.Element<GroupProps>

GroupProps

`children`

Type: ReactNode

Inherited props

CommonViewModifierProps

Modifiers

Use these modifiers in the modifiers prop of the SwiftUI version.

Expo UI lets you put any of the 89 modifiers for any view on Group, but not all of them do something here.

74 change what you see on Group.
1 work, but not in the way that you may expect.
2 have no visible effect on Group.
13 work only in one place, such as a widget or a Grid.

Where the modifiers go

SwiftUI applies the modifiers on a Group to each child, not to the group as one view. For example, padding adds padding around each child.

Best modifiers for Group

These modifiers are the ones that you use most with Group.

Also works on Group

Group takes these modifiers too, and each one works in the usual way.

Needs care on Group

These modifiers work on Group, but not in the way that you may expect.

Modifier	What to know
`padding`	SwiftUI gives the padding to each child of the `Group`, not to the group as one view.

No visible effect on Group

Group accepts these modifiers, but you see no change. They do not give an error.

Modifier	Why nothing happens
`layoutPriority`	It has an effect only when the view shares an axis with other views in a stack.
`zIndex`	It changes the order of views that cover each other in the same parent, and Group does not stack its children.

Only in some places

These modifiers work only in a widget, in a Grid, in a Namespace or in a parent that asks for them.

Modifier	Where it works
`activityBackgroundTint`	Works only in a Live Activity. It has no effect in the app.
`alignmentGuide`	Has an effect only when the parent, such as a `VStack` or `ZStack`, aligns its children by the same guide.
`containerBackground`	Works only in a widget, or in a navigation container when you use a `navigation` placement.
`glassEffectId`	Works only on a view that also has `glassEffect`, in a `GlassEffectContainer` and a `Namespace`.
`gridCellAnchor` iOS 16+	Works only on a cell of a `Grid`. `Grid` is in `@expo/ui/swift-ui`, but it has no Expo docs page.
`gridCellColumns`	Works only on a view in a `Grid.Row`. `Grid` is in `@expo/ui/swift-ui`, but it has no Expo docs page.
`gridCellUnsizedAxes`	Works only on a view in a `Grid`. `Grid` is in `@expo/ui/swift-ui`, but it has no Expo docs page.
`gridColumnAlignment` iOS 16+	Works only on a view in a `Grid.Row`. `Grid` is in `@expo/ui/swift-ui`, but it has no Expo docs page.
`invalidatableContent` iOS 17+	Has an effect only when a parent view uses `redacted` with the `invalidated` reason.
`matchedGeometryEffect`	Works only in a `Namespace`. Give two views the same `id` and change between them with an animation.
`privacySensitive`	Has an effect only when a parent view uses `redacted` with the `privacy` reason.
`unredacted`	Has an effect only in a parent view that uses `redacted`.
`widgetURL`	Works only in a widget. It has no effect in the app.

Sources

The original Expo docs for this page:

Group (SwiftUI) (source-of-truth/versions/v57.0.0/sdk/ui/swift-ui/group.md)

On this page