npmpackage.info

Gathering detailed insights and metrics for @expo/react-native-action-sheet

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

@gorhom/bottom-sheet

5.0.6

A performant interactive bottom sheet with fully configurable options 🚀

expo-file-system

18.0.4

Provides access to the local file system on the device.

expo-modules-autolinking

2.0.2

Scripts that autolink Expo modules.

expo-constants

17.0.3

Provides system information that remains constant throughout the lifetime of your app.

Gathering detailed insights and metrics for @expo/react-native-action-sheet

@expo/react-native-action-sheet

A cross-platform ActionSheet for React Native

4.1.0

1,404

MIT

TypeScript

20,886,829 2.8

Installations

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

Pull Requests

Open

5

Total

182

Closed

44

Merged

133

Issues

Open

18

Total

150

Closed

132

Releases

v4.1.0

Published on 15 May 2024

v4.0.1

Published on 04 Nov 2022

v4.0.0

Published on 26 Oct 2022

v3.13.0

Published on 10 Jan 2022

v3.12.0

Published on 14 Oct 2021

v3.11.0

Published on 07 Sept 2021

View all 17 releases

Developer

expo

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.21.3

NPM Version

6.14.18 Statistics

1,404 Stars

320 Commits

226 Forks

10 Watching

7 Branches

66 Contributors

Updated on 26 Nov 2024

Languages

TypeScript (99.5%)

JavaScript (0.5%)

Total Downloads

Cumulative downloads

Total Downloads

20,886,829

Last day

-23.4%

26,632

Compared to previous day

Last week

-3.6%

133,480

Compared to previous week

Last month

10.9%

566,892

Compared to previous month

Last year

24.6%

5,669,014

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@expo/react-native-action-sheet

React Native Action Sheet is a cross-platform React Native component that uses the native UIActionSheet on iOS and a pure JS implementation on Android.

iOS	Android	Web

Check out the example snack here!

Installation

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

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

A basic ActionSheet Setup

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

ReactNativeActionSheet uses React context to allow your components to invoke the menu. This means your app needs to be wrapped with the ActionSheetProvider component first.

1import { ActionSheetProvider } from '@expo/react-native-action-sheet';
2
3export default function AppContainer() {
4  return (
5    <ActionSheetProvider>
6      <App />
7    </ActionSheetProvider>
8  );
9}

2. Call the `showActionSheetWithOptions` method with a hook or a higher order component.

1// Using the provided hook
2import { useActionSheet } from '@expo/react-native-action-sheet';
3
4export default Menu() {
5  const { showActionSheetWithOptions } = useActionSheet();
6
7  const onPress = () => {
8    const options = ['Delete', 'Save', 'Cancel'];
9    const destructiveButtonIndex = 0;
10    const cancelButtonIndex = 2;
11
12    showActionSheetWithOptions({
13      options,
14      cancelButtonIndex,
15      destructiveButtonIndex
16    }, (selectedIndex: number) => {
17      switch (selectedIndex) {
18        case 1:
19          // Save
20          break;
21
22        case destructiveButtonIndex:
23          // Delete
24          break;
25
26        case cancelButtonIndex:
27          // Canceled
28      }});
29  }
30
31  return (
32    <Button title="Menu" onPress={onPress}/>
33  )
34};

Alternatively, any component can use the higher order component to access the context and pass the showActionSheetWithOptions as a prop.

1// Using a Higher Order Component to wrap your component
2import { connectActionSheet } from '@expo/react-native-action-sheet';
3
4function Menu({ showActionSheetWithOptions }) {
5  /* ... */
6}
7
8export default connectActionSheet(Menu);

Menu component can now access the actionSheet prop as showActionSheetWithOptions.

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

Name	Type	Description
`options`	array of strings	A list of button titles (required)
`cancelButtonIndex`	number	Index of cancel button in options
`cancelButtonTintColor`	string	Color used for the change the text color of the cancel button
`destructiveButtonIndex`	number or array of numbers	Indices of destructive buttons in options
`title`	string	Title to show above the action sheet
`message`	string	Message to show below the title
`tintColor`	string	Color used for non-destructive button titles
`disabledButtonIndices`	array of numbers	Indices of disabled buttons in options

iOS Only Props

Name	Type	Description
`anchor`	number	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`	string	The interface style used for the action sheet, can be set to `light` or `dark`, otherwise the default system style will be used.

Custom Action Sheet Only (Android/Web) 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	Description
`icons`	array of required images or icons	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`	boolean	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`	TextStyle	Apply any text style props to the options. If the `tintColor` option is provided, it takes precedence over a color text style prop.
`titleTextStyle`	TextStyle	Apply any text style props to the title if present.
`messageTextStyle`	TextStyle	Apply any text style props to the message if present.
`autoFocus`	boolean	If `true`, this 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`	boolean	Show separators between items. On iOS, separators always show so this prop has no effect.
`containerStyle`	ViewStyle	Apply any view style props to the container rather than use the default look (e.g. dark mode).
`separatorStyle`	ViewStyle	Modify the look of the separators rather than use the default look.
`useModal`	boolean	Defaults to `false` (`true` if autoFocus is also `true`) Wraps the ActionSheet with a Modal, in order to show in front of other Modals that were already opened (issue reference).
`destructiveColor`	string	Modify color for text of destructive option. Defaults to `#d32f2f`.

ActionSheetProvider Props

The following props can be set directly on the ActionSheetProvider

Name	Type	Description
`useCustomActionSheet`	boolean	iOS only prop that uses the custom pure JS action sheet (Android/Web version) instead of the native ActionSheetIOS component. Defaults to `false`.
`useNativeDriver`	boolean	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.

1// example of using useCustomActionSheet on iOS
2export default function AppContainer() {
3  return (
4    <ActionSheetProvider useCustomActionSheet={true}>
5      <App />
6    </ActionSheetProvider>
7  );
8}

Callback

The second parameter of the showActionSheetWithOptions function is a callback for when a button is selected. The callback takes a single argument which will be the zero-based index of the pressed option. You can check the value against your cancelButtonIndex to determine if the action was cancelled or not.

1function onButtonPress(selectedIndex: number) {
2  // handle it!
3}

Try it out

Try it in Expo Snack: https://snack.expo.dev/@expo-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 git@github.com: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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

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

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

@expo/react-native-action-sheet

Installations

Pull Requests

5

182

44

133

Issues

18

150

132

Releases

Developer

expo

Developer Guide

CommonJS

Yes

14.21.3

6.14.18

Statistics

Languages

Total Downloads

20,886,829

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

@expo/react-native-action-sheet

Check out the example snack here!

Installation

A basic ActionSheet Setup

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

2. Call the showActionSheetWithOptions method with a hook or a higher order component.

Options

Universal Props

iOS Only Props

Custom Action Sheet Only (Android/Web) Props

ActionSheetProvider Props

Callback

Try it out

Example

Usage

Development

Setup

Build

Lint & Format

10

10

10

3

0

0

0

0

0

0

0

0

0

2.8

/10

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

2. Call the `showActionSheetWithOptions` method with a hook or a higher order component.