react-native-actions-sheet-web v0.0.3

How to use

It's very simple to use the ActionSheet. Import the ActionSheet & SheetManager.

import React from "react";
import ActionSheet, { SheetManager } from "react-native-actions-sheet-web";

Create your ActionSheet component and give it a unique id.

<ActionSheet id="helloworld_sheet">
  <View>
    <Text>Hello World</Text>
  </View>
</ActionSheet>

Open the ActionSheet from anywhere in the app.

SheetManager.show("helloworld_sheet");

Want to pass some data on opening the sheet or update the state?

SheetManager.show("helloworld_sheet",{value:"Hello World"});

<ActionSheet
onBeforeShow={(data) => {
  setData(data);
}}
id="helloworld_sheet">

Hiding the sheet is easy. Enable gestures or do the following.

await SheetManager.hide("helloworld_sheet");

Close all opened ActionSheets

SheetManager.hideAll();

Features

1. Cross Platform (iOS and Android)
2. Native Animations & Performance
3. Identical Working on Android and iOS
4. Control ActionSheet with Gestures
5. Raw ActionSheet - You can Add Anything
6. Allow ActionSheet to be partially shown when opened
7. Support TextInputs
8. Cool bounce effect on open.
9. Tablets and iPads
10. Horizontal Layout
11. Nested Scrolling or Scrollable Content.
12. Virtualization Support
13. Global Sheet Manager
14. Proper resizing on Android & iOS on Keyboard show/hide.

Consider supporting with a ⭐️ star on GitHub

If you are using the library in one of your projects, consider supporting with a star. It takes a lot of time and effort to keep this maintained and address issues and bugs. Thank you.

Props

id

A unique id for the ActionSheet. You must set this if you are using SheetManager.

ref

Assigns a ref to ActionSheet component to use methods.

testID

Test ID for unit testing

initialOffsetFromBottom

Use if you want to show the ActionSheet Partially on Opening. Requires gestureEnabled=true

Default: 1

extraScroll

Normally when the ActionSheet is fully opened, a small portion from the bottom is hidden by default. Use this prop if you want the ActionSheet to hover over the bottom of screen and not hide a little behind it.

Default: 0

indicatorStyle

Style the top indicator bar in ActionSheet.

containerStyle

Any custom styles for the container.

delayActionSheetDraw

Delay draw of ActionSheet on open for android.

Default: false

delayActionSheetDrawTime

Delay draw of ActionSheet on open for android time.

Default: 50

CustomHeaderComponent

Your custom header component. Using this will hide the default indicator.

ExtraOverlayComponent

Render a component over the ActionSheet. Useful for rendering Toast components with which user can interact.

headerAlwaysVisible

Keep the header always visible even when gestures are disabled.

Default: false

animated

Animate the opening and closing of ActionSheet.

Default: true

openAnimationSpeed

Speed of opening animation. Higher means the ActionSheet will open more quickly. Use it in combination with bounciness prop to have optimize the bounce/spring effect on ActionSheet open.

Default: 12

closeAnimationDuration

Duration of closing animation.

Default: 300

gestureEnabled

Enables gesture control of ActionSheet

Default: false

closeOnTouchBackdrop

Control closing ActionSheet by touching on backdrop.

Default: true

bounceOnOpen

Bounces the ActionSheet on open.

Default: false

bounciness

How much you want the ActionSheet to bounce when it is opened.

Default: 8

springOffset

When touch ends and user has not moved farther from the set springOffset, the ActionSheet will return to previous position.

Default: 50

elevation

Add elevation to the ActionSheet container.

Default: 0

indicatorColor

Color of the gestureEnabled Indicator.

Default: "#f0f0f0"

overlayColor

Color of the overlay/backdrop.

Default: "black"

defaultOverlayOpacity

Default opacity of the overlay/backdrop.

Default: 0.3

closable

Prevent ActionSheet from closing on gesture or tapping on backdrop. Instead snap it to bottomOffset location

Default: true

bottomOffset

Snap ActionSheet to this location if closable is set to false. By default it will snap to the location on first open.

Default: 0

keyboardShouldPersistTaps

Setting the keyboard persistence of the ScrollView component. Should be one of "never", "always" or "handled"

Default: never

keyboardHandlerEnabled

Allow to choose will content change position when keyboard is visible. This is enabled by default.

Default: true

keyboardDismissMode

Set how keyboard should behave on tapping the ActionSheet.

Default : "none"

statusBarTranslucent

Determine whether the modal should go under the system statusbar.

Default: true

closeOnPressBack

Will the ActionSheet close on hardwareBackPress event.

Default: true

drawUnderStatusBar

Allow ActionSheet to draw under the StatusBar. This is enabled by default.

Default: false

onPositionChanged(onReachedTop:boolean)

Event called when position of ActionSheet changes.

onClose

Event called when the ActionSheet closes.

onOpen

An event called when the ActionSheet Opens.

Methods

Methods require you to set a ref on ActionSheet Component.

handleChildScrollEnd()

If your component includes any child ScrollView/FlatList you must attach this method to all scroll end callbacks.

<ScrollView
            ref={scrollViewRef}
            nestedScrollEnabled={true}
            onMomentumScrollEnd={() =>
              actionSheetRef.current?.handleChildScrollEnd()
            }
.....

show()

Opens the ActionSheet.

import ActionSheet from "react-native-actions-sheet-web";
import React, { createRef } from "react";

const actionSheetRef = createRef();

// First create a ref on your <ActionSheet/> Component.
<ActionSheet ref={actionSheetRef} />;

// then later in your function to open the ActionSheet:

actionSheetRef.current?.show();

hide()

Closes the ActionSheet.

import ActionSheet from "react-native-actions-sheet-web";
import React, { createRef } from "react";

const actionSheetRef = createRef();

// First create a ref on your <ActionSheet/> Component.
<ActionSheet ref={actionSheetRef} />;

// then later in your function to open the ActionSheet:

actionSheetRef.current?.hide();

setModalVisible

ActionSheet can be opened or closed using its ref.

import ActionSheet from "react-native-actions-sheet-web";
import React, { createRef } from "react";

const actionSheetRef = createRef();

// First create a ref on your <ActionSheet/> Component.
<ActionSheet ref={actionSheetRef} />;

// then later in your function to open the ActionSheet:

actionSheetRef.current?.setModalVisible();

setModalVisible(visible)

It's also possible to explicitly either show or hide modal.

import ActionSheet from "react-native-actions-sheet-web";
import React, { createRef } from "react";

const actionSheetRef = createRef();
// First create a ref on your <ActionSheet/> Component.
<ActionSheet ref={actionSheetRef} />;

// then to show modal use
actionSheetRef.current?.setModalVisible(true);

// and later you may want to hide it using
actionSheetRef.current?.setModalVisible(false);

snapToOffset(offset:number)

When the ActionSheet is open, you can progammatically snap it to different offsets.

import ActionSheet from "react-native-actions-sheet-web";
import React, { createRef } from "react";

const actionSheetRef = createRef();
// First create a ref on your <ActionSheet/> Component.
<ActionSheet ref={actionSheetRef} />;

// snap to this location on screen
actionSheetRef.current?.snapToOffset(200);

actionSheetRef.current?.snapToOffset(150);

actionSheetRef.current?.snapToOffset(300);

Nested scrolling on android

Nested scrolling on android is disabled by default. You can enable it as done below.

import ActionSheet from "react-native-actions-sheet-web";

const App = () => {
  const actionSheetRef = useRef();

  return (
    <ActionSheet ref={actionSheetRef}>
      <ScrollView
        nestedScrollEnabled={true}
        onMomentumScrollEnd={() =>
          actionSheetRef.current?.handleChildScrollEnd()
        }
      />
    </ActionSheet>
  );
};

Find this library useful? ❤️

Support it by donating or joining stargazers for this repository. ⭐️ and follow me for my next creations!

MIT Licensed