Vue Bottom Sheet Vue 2

A nice clean and touch-friendly bottom sheet component based on Vue.js 2 and hammer.js for Vue 2

• Vue 3 Version
• 🎬 Demo
• 中文文档

Installation

NPM

npm install @nclsm/vue-bottom-sheet-vue2

Yarn

yarn add @nclsm/vue-bottom-sheet-vue2

Usage

<template>
    <vue-bottom-sheet-vue2 ref="myBottomSheet">
        <h1>Lorem Ipsum</h1>
        <h2>What is Lorem Ipsum?</h2>
        <p>
            <strong>Lorem Ipsum</strong> is simply dummy text
        </p>
    </vue-bottom-sheet-vue2>
</template>

<script>
import VueBottomSheetVue2 from "@nclsm/vue-bottom-sheet-vue2";

export default {
    components: {
        VueBottomSheetVue2
    },
    methods: {
        open() {
            this.$refs.myBottomSheet.open();
        },
        close() {
            this.$refs.myBottomSheet.close();
        }
    }
}
</script>

Props

Prop	Type	Description	Example	Defaults
max-width	Number	Set max-width of component card in px	:max-width="640"	640
max-height	Number	Sets the maximum height of the window, if not set it takes the height of the content	:max-height="90"	-
close-height-percent	Number	Set the percentage of the height in the Off state to the height in the fully enabled state. 100 indicates that the height is fully off	:max-height="50"	100
can-swipe	Boolean	Enable or disable swipe to close	:can-swipe="false"	true
overlay	Boolean	Enable overlay	:overlay="false"	true
overlay-color	String	Set overlay color with opacity	overlay-color="#0000004D"	#0000004D
overlay-click-close	Boolean	Close window on overlay click	:overlay-click-close="false"	true
drag-color v1.2.0	String	Drag the bar icon color	drag-color="#ffc107"	#333333
custom-class v1.2.0	String	The component custom class name	custom-class="custom-style"	''
init-sheet-height v1.3.0	Number	Sets the initial height of the window, if not set it takes the height of the content	:init-sheet-height="300"	-
z-index v1.3.2	Number	Set z-index of component card	:z-index="1001"	99999

custom-class

<template>
    <vue-bottom-sheet-vue2
        custom-class="bg-color"
    />
</template>

<style lang="scss" scoped>
::v-deep .bg-color{
    background-color: #ffc107;
}
</style>

or:

<template>
    <vue-bottom-sheet-vue2
        custom-class="bg-color"
    />
</template>

<style lang="scss">
.bg-color{
    background-color: #ffc107;
}
</style>

Events

Event	Description	Example
opened	Fire when card component is opened	@opened=""
closed	Fire when card component is closed	@closed=""
dragging-up	Fire while card component dragging up	@dragging-up=""
dragging-down	Fire while card component dragging down	@dragging-down=""

Slots

You can use this named slots:

Slot	Description
drag v1.2.0	Drag the bar icon
header	header content
default	main content
footer	footer content

<template>
    <vue-bottom-sheet-vue2 ref="myBottomSheet">
        <template #drag>
            <div style="width: 40px;height: 4px;background: #31d2f2;border-radius: 8px;margin: 0 auto;"></div>
        </template>
        <template #header>
            <h1>Lorem Ipsum</h1>
        </template>
        <template #default>
            <h2>What is Lorem Ipsum?</h2>
        </template>
        <template #footer>
            <p>
                <strong>Lorem Ipsum</strong> is simply dummy text
            </p>
        </template>
    </vue-bottom-sheet-vue2>
</template>