Sheet Modal Vue Component

Sheet Modal Components
Sheet Modal Properties
Sheet Modal Methods
Sheet Modal Events
Open And Close Sheet Modal
Access To Sheet Modal Instance
Examples

Sheet Modal is a special overlay type which is similar to Picker/Calendar's overlay. Such modal allows to create custom picker overlays with custom content.

Sheet Modal Vue component represents Sheet Modal component.

There are following components included:

f7-sheet - sheet modal element

Prop	Type	Description
<f7-sheet> properties
position	string	Sheet position, can be `top` or `bottom`. By default is `bottom`
top	boolean	Same as `position="top"`
bottom	boolean	Same as `position="bottom"`
backdrop	boolean	Enable to render additional sheet modal backdrop when required
backdrop-el	string object	HTML element or string CSS selector of custom backdrop element
opened	boolean	Allows to open/close Sheet Modal and set its initial state
close-by-backdrop-click	boolean	When enabled, sheet will be closed on backdrop click. By default inherits same app parameter value
close-by-outside-click	boolean	When enabled, sheet will be closed on when click outside of it. By default inherits same app parameter value
close-on-escape	boolean	When enabled, sheet will be closed on ESC keyboard key press
swipe-to-close	boolean	Whether the Sheet can be closed with swipe gesture
swipe-to-step	boolean	When enabled it will be possible to split opened sheet into two states: partially opened and fully opened that can be controlled with swipe
swipe-handler	HTMLElement string	If not passed, then whole Sheet can be swiped to close. You can pass here HTML element or string CSS selector of custom element that will be used as a swipe target. (`swipeToClose` or `swipeToStep` must be also enabled)
push	boolean	When enabled it will push view behind on open. Works only when top safe area is in place. It can also be enabled by adding `sheet-modal-push` class to Sheet element.

<f7-sheet> methods
.open(animate)	Open sheet modal
.close(animate)	Close sheet modal

Event	Description
<f7-sheet> events
sheet:open	Event will be triggered when Sheet Modal starts its opening animation
sheet:opened	Event will be triggered after Sheet Modal completes its opening animation
sheet:close	Event will be triggered when Sheet Modal starts its closing animation
sheet:closed	Event will be triggered after Sheet Modal completes its closing animation
sheet:stepopen	Event will be triggered on Sheet swipe step open/expand
sheet:stepclose	Event will be triggered on Sheet swipe step close/collapse
sheet:stepprogress	Event will be triggered on Sheet swipe step between step opened and closed state. As `event.detail` it receives step open progress number (from `0` to `1`)

You can control Sheet Modal state, open and closing it:

using its Sheet Modal API
by passing true or false to its opened prop
by clicking on Link or Button with relevant sheet-open property (to open it) and sheet-close property to close it

You can access Sheet Modal initialized instance by accessing .f7Sheet component's property.

Examples

<template>
  <f7-page @page:beforeremove="onPageBeforeRemove" @page:beforeout="onPageBeforeOut">
    <f7-navbar title="Sheet Modal"></f7-navbar>
    <f7-block>
      <p>
        <f7-button fill sheet-open=".demo-sheet">Open Sheet</f7-button>
      </p>
      <p>
        <f7-button fill @click="createSheet">Create Dynamic Sheet</f7-button>
      </p>
      <p>
        <f7-button fill @click="sheetOpened = true">Open Via Prop Change</f7-button>
      </p>
      <p>
        <f7-button fill sheet-open=".demo-sheet-swipe-to-close">Swipe To Close</f7-button>
      </p>
      <p>
        <f7-button fill sheet-open=".demo-sheet-swipe-to-step">Swipe To Step</f7-button>
      </p>
      <p>
        <f7-button fill sheet-open=".demo-sheet-push">Sheet Push</f7-button>
      </p>
    </f7-block>

    <f7-sheet class="demo-sheet" :opened="sheetOpened" @sheet:closed="sheetOpened = false">
      <f7-toolbar>
        <div class="left"></div>
        <div class="right">
          <f7-link sheet-close>Close</f7-link>
        </div>
      </f7-toolbar>
      <!-- Scrollable sheet content -->
      <f7-page-content>
        <f7-block>
          <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quae ducimus dolorum ipsa aliquid accusamus perferendis laboriosam delectus numquam minima animi, libero illo in tempora harum sequi corporis alias ex adipisci...</p>
          <!-- ... -->
        </f7-block>
      </f7-page-content>
    </f7-sheet>

    <!-- Swipe to close demo sheet -->
    <f7-sheet
      class="demo-sheet-swipe-to-close"
      style="height:auto; --f7-sheet-bg-color: #fff;"
      swipe-to-close
      backdrop
    >
      <f7-page-content>
        <f7-block-title large>Hello!</f7-block-title>
        <f7-block>
          <p>Eaque maiores ducimus, impedit unde culpa qui, explicabo accusamus, non vero corporis voluptatibus similique odit ab...</p>
        </f7-block>
      </f7-page-content>
    </f7-sheet>

    <!-- Swipe to step demo sheet -->
    <f7-sheet
      class="demo-sheet-swipe-to-step"
      style="height:auto; --f7-sheet-bg-color: #fff;"
      swipe-to-close
      swipe-to-step
      backdrop
    >
      <!-- Initial swipe step sheet content -->
      <div class="sheet-modal-swipe-step">
        <div class="display-flex padding justify-content-space-between align-items-center">
          <div style="font-size: 18px"><b>Total:</b></div>
          <div style="font-size: 22px"><b>$500</b></div>
        </div>
        <div class="padding-horizontal padding-bottom">
          <f7-button large fill>Make Payment</f7-button>
          <div class="margin-top text-align-center">Swipe up for more details</div>
        </div>
      </div>
      <!-- Rest of the sheet content that will opened with swipe -->
      <f7-block-title medium class="margin-top">Your order:</f7-block-title>
      <f7-list no-hairlines>
        <f7-list-item title="Item 1">
          <b slot="after" class="text-color-black">$200</b>
        </f7-list-item>
        <f7-list-item title="Item 2">
          <b slot="after" class="text-color-black">$180</b>
        </f7-list-item>
        <f7-list-item title="Delivery">
          <b slot="after" class="text-color-black">$120</b>
        </f7-list-item>
      </f7-list>
    </f7-sheet>

    <!-- Sheet Push -->
    <f7-sheet class="demo-sheet-push" push>
      <f7-toolbar>
        <div class="left"></div>
        <div class="right">
          <f7-link sheet-close>Close</f7-link>
        </div>
      </f7-toolbar>
      <f7-page-content>
        <f7-block>
          <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit...</p>
        </f7-block>
      </f7-page-content>
    </f7-sheet>
  </f7-page>
</template>

<script>
export default {
  data() {
    return {
      sheetOpened: false,
    };
  },
  methods: {
    createSheet() {
      const self = this;
      const $ = self.$$;
      // Create sheet modal
      if (!self.sheet) {
        self.sheet = self.$f7.sheet.create({
          content: `
            <div class="sheet-modal">
              <div class="toolbar">
                <div class="toolbar-inner justify-content-flex-end">
                  <a href="#" class="link sheet-close">Close</a>
                </div>
              </div>
              <div class="sheet-modal-inner">
                <div class="page-content">
                  <div class="block">
                    <p>This sheet modal was created dynamically</p>
                    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse faucibus mauris leo, eu bibendum neque congue non. Ut leo mauris, eleifend eu commodo a, egestas ac urna. Maecenas in lacus faucibus, viverra ipsum pulvinar, molestie arcu. Etiam lacinia venenatis dignissim...</p>
                  </div>
                </div>
              </div>
            </div>
          `.trim(),
        });
      }
      // Close inline sheet
      if ($('.demo-sheet.modal-in').length > 0) self.$f7.sheet.close('.demo-sheet');
      // Open it
      self.sheet.open();
    },
    onPageBeforeOut() {
      const self = this;
      // Close opened sheets on page out
      self.$f7.sheet.close();
    },
    onPageBeforeRemove() {
      const self = this;
      // Destroy sheet modal when page removed
      if (self.sheet) self.sheet.destroy();
    },
  },
};
</script>

Sheet Modal Vue Component

Sheet Modal Components

Sheet Modal Properties

Sheet Modal Methods

Sheet Modal Events

Open And Close Sheet Modal

Access To Sheet Modal Instance

Examples