@solb/bottom-sheet
v1.0.0
Published
This is a bottomsheet created with pure JavaScript using Web Components.
Downloads
11
Maintainers
Readme
@solb/bottom-sheet
Bottomsheet component made with pure JavaScript. When used on the mobile web or app, it appears as a bottomsheet, and on the web it appears as a modal. (Demo)
This component is built with Web Components, offering the key advantage of universal usability. You can employ it across various frameworks or even without any framework. Therefore, you can integrate this bottom sheet seamlessly in different environments such as React, Vue, and more.
Installation
Install from NPM
npm i @solb/bottom-sheet
import "@solb/bottom-sheet";
import "@solb/bottom-sheet/style/style.css";
Use bottom-sheet from CDN
<script src="https://cdn.jsdelivr.net/npm/@solb/bottom-sheet/dist/index.min.js" defer></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@solb/bottom-sheet/style/style.css"/>
Usage
Children elements to be included in the bottomsheet must be wrapped with the main
tag.
Examples of usage in react, nextjs, and vue can be seen here 👋!
<button
type="button"
onclick="document.getElementById('testBottomSheet').openSheet()"
>
openSheet
</button>
<bottom-sheet id="testBottomSheet" title="Title is Lorem ipsum">
<main class="_example">
<p>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
est laborum.
</p>
<div>
<button
type="button"
onclick="document.getElementById('testBottomSheet').closeSheet()"
>
closeSheet
</button>
<button
type="button"
onclick="document.getElementById('testBottomSheet').fullSheet()"
>
fullSheet
</button>
</div>
</main>
</bottom-sheet>
Props
title (optional)
Title of bottomsheet
<bottom-sheet title="Title is Lorem ipsum"> ... </bottom-sheet>
vh (optional)
Default vh(viewport height) of bottomsheet If this value is not present, the default is determined by calculating the height.
<bottom-sheet vh="50"> ... </bottom-sheet>
class (optional)
Adds style to the main of bottomsheet
<bottom-sheet>
<main class="bg-blue"></main>
</bottom-sheet>
Methods
openSheet()
Opens the bottomsheet
openFullSheet()
Opens the bottomsheet in full screen.
closeSheet()
Closes the bottomsheet
fullSheet()
Opens an already opened bottom sheet in full screen.