1.0.14 • Published 3 years ago

actionsheet-react v1.0.14

Weekly downloads
69
License
ISC
Repository
-
Last release
3 years ago

ActionSheet-React

Size npm

An action sheet component for react.

What is an action sheet ?

Action Sheet is a component that slides in from bottom and has some list of action for the user. Mostly action sheets are used in native mobile application, but action sheet is a very helpful UI element which can be also be used in websites and PWA.

📺 Demo

demo gif

code-sandbox simple example

code-sandbox complex example

📦 Installation

using npm
npm i actionsheet-react
using yarn
yarn add actionsheet-react

👨‍💻 Usage

Sample code using Javascript
import React, { useRef, Fragment } from "react";
import ActionSheet from "actionsheet-react";

const MyComponent = () => {
  const ref = useRef();

  const handleOpen = () => {
    ref.current.open();
  };

  const handleClose = () => {
    ref.current.close();
  };

  return (
    <Fragment>
      <button onClick={handleOpen}>Open</button>
      <button onClick={handleClose}>Close</button>
      <ActionSheet ref={ref}>
        <div style={style.content}>🙂 Hi React Devs!</div>
      </ActionSheet>
    </Fragment>
  );
};

const style = {
  content: {
    height: 300,
    display: "flex",
    justifyContent: "center",
    alignItems: "center",
  },
};
Sample code using Typescript
import ActionSheet, {ActionSheetRef} from 'actionsheet-react';

const MyComponent = () => {
  const ref = useRef<ActionSheetRef>();

  // ...rest same as above code

🌮 Props

all props are optional
property nametypemore info
onClosecallback functioncalled when the actionsheet is closed
childrenReact Childrenall the fancy HTML elements that you want to show in the menu
bgStylecss styles objectthese styles are applied to the background black overlay
sheetStylecss styles objectthese styles are applied to the sheet component
mouseEnablebooleanif true, the sheet can be dragged down using mouse
touchEnablebooleanif true, the sheet can be swiped down on touch devices
thresholdnumberthe minimum distance dragged, so that sheet will slide down. Threshold is measured in px , default value is 50
zIndexnumberthe default value is 999
closeOnBgTapbooleanif true, the sheet is closed when the background overlay is tapped
reversebooleanopen the sheet in reverse direction
sheetTransitionstringcss transition shorthand, default value transform 0.3s ease-in-out
bgTransitionstringcss transition shorthand, default value opacity 0.5s ease-in-out, z-index 0.5s ease-in-out

👾 Misc

  1. The logic to stop the backgroud from scrolling is not implemented in this package just to keep it simple. To avoid the background from scrolling you can toggle the overflow property of the body tag, or you can also use some other way of your choice
document.body.style.overflow = "hidden";
document.body.style.overflow = "auto";
  1. Mobile browsers generally have pull-to-refresh and when action sheet is open and when user drags the sheet down the pull-to-refresh is triggered. To control this behavior either you can disable swipe in action sheet touchEnable={false} or you can disable pull-to-refresh.
body {
  overscroll-behavior: contain;
}

⛳ Issues/Feature Request/Pull Request

The github repo is always there for you.

1.0.14

3 years ago

1.0.13

3 years ago

1.0.11

3 years ago

1.0.10

3 years ago

1.0.12

3 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago