Hugo-bottom-drawer NPM

Hugo Bottom Drawer

A lightweight and highly performant bottom drawer for react native

Features

Extremely lightweight (~20 KB) and highly performant
Support for snapping (multi height bottom drawer)
Smooth Animations and Gestures
Completely Customisable
Automatic Keyboard Handling
useBottomDrawer hook to allow the bottom drawer child components to access bottom drawer methods
Written in Typescript

Installation

using npm

npm i hugo-bottom-drawer

using yarn

yarn add hugo-bottom-drawer

Usage

import React, {useRef} from 'react';
import {View, Text, StyleSheet, Button, SafeAreaView} from 'react-native';
import BottomDrawer, {
  BottomDrawerMethods,
} from 'hugo-bottom-drawer';

const App = () => {
  // ref
  const bottomDrawerRef = useRef<BottomDrawerMethods>(null);

  // renders
  return (
    <SafeAreaView style={styles.container}>
      <Button title="Open" onPress={() => bottomDrawerRef.current.open()} />
      <BottomDrawer ref={bottomDrawerRef} openOnMount>
        <View style={styles.contentContainer}>
          <Text>Awesome 🎉</Text>
        </View>
      </BottomDrawer>
    </SafeAreaView>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    padding: 24,
  },
  contentContainer: {
    flex: 1,
    alignItems: 'center',
  },
});

export default App;

Available Props

Name	Type	Default	Description	Required
`gestureMode`	`handle \\| content \\| none`	`handle`	This prop determines where to apply the gestures	No
`openDuration`	`number`	`450`	Animation duration when the bottom drawer is opened	No
`closeDuration`	`number`	`300`	Animation duration when the bottom drawer is closed	No
`onOpen`	`function`	`null`	Callback function when the bottom drawer is opened	No
`onClose`	`function`	`null`	Callback function when the bottom drawer is closed	No
`onBackdropPress`	`function`	`true`	Callback function when the backdrop is pressed	No
`onBackPress`	`function`	`null`	Callback function when the hardware back button is pressed	No
`closeOnPressBack`	`boolean`	`true`	Setting this true will allow the bottom drawer to close when hardware back is pressed (only on android)	No
`closeOnBackdropPress`	`boolean`	`true`	Setting this true will allow the bottom drawer to close when backdrop is pressed	No
`openOnMount`	`boolean`	`false`	Setting this true will automatically open the bottom drawer when the parent component is mounted	No
`enableSnapping`	`boolean`	`false`	Set this to true when you want to snap the bottom drawer to multiple heights	No
`snapPoints`	`number[]`	`[400]`	Points for the bottom sheet to snap to, points should be sorted from bottom to top. It accepts array of number. Example: `[300, 500, 700]`	Yes, if `enableSnapping` is `true`
`backdropColor`	`string`	`#000`	Color of the backdrop	No
`backdropOpacity`	`number`	`0.5`	Opacity of the backdrop	No
`customStyles`	`object`	`{}`	Add your custom styles here!	No
`overDrag`	`boolean`	`true`	Setting this true will allow the bottom sheet to be overdragged	No
`initialIndex`	`number`	`0`	The initial index out of `snapPoints` when the bottom sheet is opened	No
`initialHeight`	`number`	`420`	The initial height of the bottom sheet when opened. *Note*: This prop is not available when `enableSnapping` is set to `true`	No
`safeTopOffset`	`number`	`50`	Minimum safe distance from top while dragging the sheet or keyboard is opened	No

Available Methods

These methods can be accessed by bottom drawer reference or useBottomDrawer hook.

open

Opens the bottom drawer

type open = (
  // open at provided sheetHeight
  sheetHeight?: number,
) => void;

NOTE: sheetHeight is only read when enableSnapping is set to false. If enableSnapping is true, then the bottom sheet will be opened at index 0 out of snapPoints.

close

Closes the bottom drawer

type close = () => void;

snapToPosition

Snaps the bottom drawer to given position

type snapToPosition = (
  sheetHeight: number,
  config?: {
    resetLastPosition?: boolean;
  },
) => void;

snapToIndex

Snaps the bottom drawer to given index out of snapPoints (requires enableSnapping to be true)

type snapToIndex = (index: number) => void;

NOTE: This method is only accessible when enableSnapping is set to true.

react native bottom drawer bottom sheet react

0.0.24

1 month ago

0.0.23

1 month ago