1.0.1 • Published 2 years ago

@tamkeentech/react-native-bottom-sheet v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@TamkeenTech/react-native-bottom-sheet

A simple react native package for creating and using different kind of modals

Demo

Screen Record of the default sheet Screen Record of a sticky sheet

Installation

  1. Install react-native-reanimatad 2, for installation instructions please follow the below link:

    expo or react-native.

  2. Install react-native-gesture-handler, for installation instructions please follow the below link:

    expo or react-native.

  3. Finally, run the command:

   npm install @tamkeentech/react-native-bottom-sheet

Usage and Example

Basic Usage

1- Sheet

import React from 'react';
import { Sheet } from '@tamkeentech/react-native-bottom-sheet';
import { Block, Label, Paragraph } from '../placeholder';

export const DemoSheet = ({ show, onClose }) => {
  return (
    <Sheet
      contentContainerStyle={{ paddingHorizontal: 15 }}
      show={show}
      onClose={onClose}
    >
      <Label />
      <Paragraph />
      <Block />
    </Sheet>
  );
};

2- Sticky Sheet

import React from 'react';
import { StickySheet } from 'react-native-bottom-sheet';
import { Block, Label, Paragraph } from '../placeholder';

export const DemoSheet = () => {
  return (
    <StickySheet contentContainerStyle={{ paddingHorizontal: 15 }}>
      {/* Child 1 */}
      <View>
        <Label />
        <Paragraph />
      </View>
      {/* Child 2 */}
      <View>
        <Label />
        <Paragraph num={1} />
        <Block />
      </View>
      {/* Child 3 */}
      <View>
        <Label />
        <Paragraph />
        <Block />
      </View>
    </StickySheet>
  );
};

API

PropsSheet TypeTypeDescriptionDefault
offsetAllnumberAn extra translate area to be set at the bottom of the sheet0
childOffsetSticky SheetnumberA bottom offset area to be set for each direct child0
onSnapSticky SheetfunctionA callback function excuted when the user removes his touch
delaySticky SheetnumberA delay added ONLY to the mounting animation0
SheetHeaderComponentAllfunctionA custom header component for a sheetDefault header component shipped with the library
SheetHeaderComponentStyleAllobject
contentContainerStyleAllobject
styleAllobject
showSheetbooleanBoolean to open/close the sheetfalse
dimSheetnumberSet the dim level for the sheet background0.8
onCloseSheetfunctionA callback function to be run upon closing the sheet

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT ©

Author

ezziddin