mottem-sheet

mottem-sheet Documentation

mottem-sheet is a bottom-sheet React.js component designed to help developers effortlessly integrate a bottom sheet component into their applications in mobile view. This document aims to provide clear and simple instructions for using mottem-sheet in your projects.

Demo - Sandbox

Online Demo: Click Here to see demo

Sandbox: Here is the sandbox link to check the package Demo

Overview

mottem-sheet is a versatile React.js component developed using TypeScript, ensuring comprehensive support for both React TypeScript and React JavaScript applications. This component offers two distinct modes to cater to various development needs: Header Mode and Free Mode.

Installation

Before using mottem-sheet, you need to install it in your project. You can do this using npm or yarn:

npm install mottem-sheet
# or
yarn add mottem-sheet

Header Mode

Header Mode allows developers to add content at the top of their applications without specifying the height or phase. This mode automatically positions your content as the first phase, eliminating the need for manual height adjustments.

Usage in Header Mode

Here's how you can use mottem-sheet in Header Mode:

import { BottomSheet, Sheet, SheetHead, SheetBody, DragAreaEl } from "mottem-sheet";


<BottomSheet isOpen={isOpen} setIsOpen={setOpen}>
  <Sheet
    phases={phases}
    initPhaseActiveIndex={0}
  >
    <SheetHead>
      <DragAreaEl />
      <h1 style={{ margin: 0 }}>Header content</h1>
    </SheetHead>
    <SheetBody>
      <p>Body Content Here</p>
    </SheetBody>
  </Sheet>
</BottomSheet>

For a complete example, refer to the HeadMode.tsx file in the example folder within the source code.

Free Mode

In Free Mode, you define the stopping points of the bottom sheet using phases. This mode offers more control over the bottom sheet's behavior.

Defining a Phase

A phase is an object with value and an optional scrollable property:

{
  value: number;
  offset?: number;
}

• value: A percentage indicating how much of the screen height the bottom sheet should cover.
• offset: sometime we need to manipulate the final position of bottom sheet phase value, this value will be added to final value of bottom sheet position.

Example of Phases

const phases = [
  {
    value: 20,
  },
  {
    value: 60,
    offset: 50,
  },
];

Usage in Free Mode

To use Free Mode, remove the <SheetHead /> component from the Header Mode example:

import { BottomSheet, Sheet, SheetBody, DragAreaEl } from "mottem-sheet";

<BottomSheet isOpen={isOpen} setIsOpen={setOpen}>
  <Sheet
    phases={phases}
    initPhaseActiveIndex={0}
  >
    <SheetBody>
      <DragAreaEl />
      <p>Body Content Here</p>
    </SheetBody>
  </Sheet>
</BottomSheet>

Component Properties

BottomSheet Component Props

• isOpen: A boolean indicating if the bottom sheet is open or closed.
• setIsOpen: A function to update the isOpen state.

Sheet Component Props

• isOpen: Optional boolean to control the visibility of the sheet.
• setIsOpen: Optional function to update the visibility state.
• phaseActiveIndex: a number indicates index of active phase state. setPhaseActiveIndex: a function to update active phase index state.
• initWithNoAnimation: Optional boolean to initialize the sheet without animation.
• phases: An array of phases to control the sheet's behavior.
• onActiveIndexChange: Optional function triggered when the active index changes.
• phaseThreshold: Safe space keep the phase as where it is, default is 60px.
• headerStyle: css inline-style that applies on header.
• bodyStyle: css inline-style that applies on body.
• headerClassName: css class that applies on header.
• bodyClassName: css class that applies on body.
• keepHeadOpen: Set true if you need always to keep the bottom sheet open. The default value is false, so the bottom sheet uses the isOpen value to manage the open and closed states.