@expo/react-native-action-sheet

What is @expo/react-native-action-sheet?

@expo/react-native-action-sheet is a library that provides a customizable ActionSheet component for React Native applications. It allows developers to present a list of options to the user in a modal dialog, which can be used for various purposes such as selecting an item, confirming an action, or displaying additional options.

What are @expo/react-native-action-sheet's main functionalities?

Displaying an ActionSheet

This feature allows you to display an ActionSheet with a list of options. The user can select an option, and the selected option's index is returned in the callback function.

import React from 'react';
import { View, Button } from 'react-native';
import { useActionSheet } from '@expo/react-native-action-sheet';

const App = () => {
  const { showActionSheetWithOptions } = useActionSheet();

  const onOpenActionSheet = () => {
    const options = ['Option 1', 'Option 2', 'Cancel'];
    const cancelButtonIndex = 2;

    showActionSheetWithOptions(
      {
        options,
        cancelButtonIndex,
      },
      (buttonIndex) => {
        // Handle button press
        console.log('Selected option:', buttonIndex);
      }
    );
  };

  return (
    <View>
      <Button title="Open ActionSheet" onPress={onOpenActionSheet} />
    </View>
  );
};

export default App;

Customizing ActionSheet Options

This feature allows you to customize the ActionSheet options, including setting a destructive button (e.g., for delete actions) and a cancel button.

import React from 'react';
import { View, Button } from 'react-native';
import { useActionSheet } from '@expo/react-native-action-sheet';

const App = () => {
  const { showActionSheetWithOptions } = useActionSheet();

  const onOpenActionSheet = () => {
    const options = ['Delete', 'Save', 'Cancel'];
    const destructiveButtonIndex = 0;
    const cancelButtonIndex = 2;

    showActionSheetWithOptions(
      {
        options,
        cancelButtonIndex,
        destructiveButtonIndex,
      },
      (buttonIndex) => {
        // Handle button press
        console.log('Selected option:', buttonIndex);
      }
    );
  };

  return (
    <View>
      <Button title="Open ActionSheet" onPress={onOpenActionSheet} />
    </View>
  );
};

export default App;

Other packages similar to @expo/react-native-action-sheet

react-native-action-sheet

react-native-action-sheet is a popular library for displaying action sheets in React Native applications. It provides similar functionality to @expo/react-native-action-sheet, allowing developers to present a list of options to the user. However, it may require additional setup and configuration compared to the Expo version.

react-native-modal

react-native-modal is a versatile library for creating modals in React Native applications. While it is not specifically designed for action sheets, it can be used to create custom modal dialogs with a list of options. It offers more flexibility and customization options compared to @expo/react-native-action-sheet but may require more effort to implement.

README

react-native-action-sheet

ActionSheet is a cross-platform React Native component that uses the native UIActionSheet on iOS and a JS implementation on Android. Almost a drop in replacement for ActionSheetIOS except it cannot be called statically.

iOS	Android	Web

Installation

$ npm install @expo/react-native-action-sheet -S

or

$ yarn add @expo/react-native-action-sheet

A basic ActionSheet Setup

1. Wrap your top-level component with <ActionSheetProvider />

import { ActionSheetProvider } from '@expo/react-native-action-sheet';

class AppContainer extends React.Component {
  render() {
    return (
      <ActionSheetProvider>
        <ConnectedApp />
      </ActionSheetProvider>
    );
  }
}

2. Connect your component which uses showActionSheetWithOptions.

import { connectActionSheet } from '@expo/react-native-action-sheet';

class App extends React.Component {
  /* ... */
}

const ConnectedApp = connectActionSheet(App);

export default ConnectedApp;

App component can access the actionSheet method as this.props.showActionSheetWithOptions

_onOpenActionSheet = () => {
  // Same interface as https://facebook.github.io/react-native/docs/actionsheetios.html
  const options = ['Delete', 'Save', 'Cancel'];
  const destructiveButtonIndex = 0;
  const cancelButtonIndex = 2;

  this.props.showActionSheetWithOptions(
    {
      options,
      cancelButtonIndex,
      destructiveButtonIndex,
    },
    (buttonIndex) => {
      // Do something here depending on the button index selected
    }
  );
};

You can use a hook instead of the higher order component if you are on React 16.8 or newer.

import { useActionSheet } from '@expo/react-native-action-sheet';

export default function App() {
  const { showActionSheetWithOptions } = useActionSheet();
  /* ... */
}

Options

The goal of this library is to mimic the native iOS and Android ActionSheets as closely as possible.

This library can also be used in the browser with Expo for web.

Universal Props

The same options available on React Native's ActionSheetIOS component exist for both iOS and Android in this library. Note: disabledButtonIndicies is only available for iOS in Expo 43+ or RN 0.64.0+.

iOS Only Props

Name	Type	Required	Default
anchor	number	No
userInterfaceStyle	string	No

anchor (optional)

iPad only option that allows for docking the action sheet to a node. See ShowActionSheetButton.tsx for an example on how to implement this.

userInterfaceStyle (optional)

The interface style used for the action sheet, can be set to light or dark, otherwise the default system style will be used.

Android/Web-Only Props

The below props allow modification of the Android ActionSheet. They have no effect on the look on iOS as the native iOS Action Sheet does not have options for modifying these options.

Name	Type	Required	Default
icons	array of required images or icons	No
tintIcons	boolean	No	true
textStyle	TextStyle	No
titleTextStyle	TextStyle	No
messageTextStyle	TextStyle	No
autoFocus	boolean	No	false
showSeparators	boolean	No	false
containerStyle	ViewStyle	No
separatorStyle	ViewStyle	No
useModal	boolean	No	false (true if autoFocus is true)
destructiveColor	string	No	#d32f2f

icons (optional)

Show icons to go along with each option. If image source paths are provided via require, images will be rendered for you. Alternatively, you can provide an array of elements such as vector icons, pre-rendered Images, etc.

tintIcons (optional)

Icons by default will be tinted to match the text color. When set to false, the icons will be the color of the source image. This is useful if you want to use multicolor icons. If you provide your own nodes/pre-rendered icons rather than required images in the icons array, you will need to tint them appropriately before providing them in the array of icons; tintColor will not be applied to icons unless they are images from a required source.

textStyle (optional)

Apply any text style props to the options. If the tintColor option is provided, it takes precedence over a color text style prop.

titleTextStyle (optional)

Apply any text style props to the title if present.

messageTextStyle (optional)

Apply any text style props to the message if present.

autoFocus: (optional)

If true, will give the first option screen reader focus automatically when the action sheet becomes visible. On iOS, this is the default behavior of the native action sheet.

showSeparators: (optional)

Show separators between items. On iOS, separators always show so this prop has no effect.

containerStyle: (optional)

Apply any view style props to the container rather than use the default look (e.g. dark mode).

separatorStyle: (optional)

Modify the look of the separators rather than use the default look.

useModal: (optional)

Wrap the ActionSheet with a Modal, in order to show in front of other Modals that were already opened (issue reference).

destructiveColor: (optional)

Modify color for text of destructive option.

ActionSheetProvider Props

The following props can be set directly on the ActionSheetProvider

useNativeDriver (optional)

Windows only option that provides the option to disable the native animation driver for React Native Windows projects targeting Windows 10 Version-1809 ; Build-10.0.17763.0 and earlier. useNativeDriver is supported in Version-1903 and later so if your project is targeting that, you don't need to set this prop.

Try it out

Try it in Expo: https://expo.io/@community/react-native-action-sheet-example

Example

See the example app.

Usage

$ cd example
$ yarn

// build simulator
$ yarn ios
$ yarn android

// web
$ yarn web

Development

Setup

$ git clone [e-mail]:expo/react-native-action-sheet.git
$ cd react-native-action-sheet
$ yarn

Build

We use bob.

$ yarn build

Lint & Format

// tsc
$ yarn type-check

// ESLint + Prettier
$ yarn lint

Changelog

3.12.0 (2021-10-14)

Bug Fixes

• use correct callback type allowing for undefined i (#239) (b54b9f1)

Features

• adds support for disabledButtonIndices (#246) (feed1f7), closes #224