SwipeActions

A SwiftUI SwipeActions component for adding leading and trailing swipe actions to row content.

iOS

GitHub

npm

Changelog

Bundled version:

~55.0.16

Expo UI SwipeActions matches the official SwiftUI swipeActions modifier and lets you attach leading or trailing actions to row content.

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

SwipeActionsExample.tsx

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

export default function SwipeActionsExample() {
  return (
    <Host style={{ flex: 1 }}>
      <List>
        <Section>
          <SwipeActions>
            <Text>Message from Expo</Text>

            <SwipeActions.Actions edge="leading" allowsFullSwipe={false}>
              <Button label="Pin" systemImage="pin" onPress={() => {}} />
            </SwipeActions.Actions>

            <SwipeActions.Actions edge="trailing">
              <Button label="Delete" systemImage="trash" role="destructive" onPress={() => {}} />
            </SwipeActions.Actions>
          </SwipeActions>
        </Section>
      </List>
    </Host>
  );
}

API

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

Components

`SwipeActions`

iOS

Type: React.Element<SwipeActionsProps>

Applies native SwiftUI swipe actions to its non-slot children.

SwipeActionsProps

`children`

iOS

Type: React.ReactNode

The regular content and SwipeActions.Actions action groups.

Inherited Props

CommonViewModifierProps

`Actions`

iOS

Type: React.Element<SwipeActionsGroupProps>

The buttons revealed when the user swipes the regular content from an edge.

Types

`SwipeActionsEdge`

iOS

Literal Type: string

Acceptable values are: 'leading' | 'trailing'