Sheet Modal Svelte 元件

Sheet Modal 是一種特殊覆蓋類型,類似於 Picker/Calendar 的覆蓋。此類型的對話框允許使用自訂內容建立自訂選擇器覆蓋。

Sheet Modal Svelte 元件代表 Sheet Modal 元件。

Sheet Modal 元件

包含下列元件

Sheet Modal 屬性

屬性類型說明
<Sheet> 屬性
position字串表單位置,可以是 topbottom。預設為 bottom
top布林值position="top" 相同
bottom布林值position="bottom" 相同
backdrop布林值在需要時啟用以呈現額外的表單對話框背景
backdropEl字串
物件
自訂背景元素的 HTML 元素或字串 CSS 選擇器
backdropUnique布林值如果啟用,它會專門為此對話框建立唯一的背景元素
opened布林值允許開啟/關閉 Sheet Modal 並設定其初始狀態
closeByBackdropClick布林值啟用時,點擊背景會關閉表單。預設繼承相同的應用程式參數值
closeByOutsideClick布林值啟用時,點擊表單外部會關閉表單。預設繼承相同的應用程式參數值
closeOnEscape布林值啟用時,按下 ESC 鍵盤按鍵會關閉表單
swipeToClose布林值表單是否可以使用滑動手勢關閉
swipeToStep布林值啟用時,可以將開啟的表單分成兩個狀態:部分開啟和完全開啟,可以用滑動控制
swipeHandlerHTMLElement
字串
如果未傳遞,則可以滑動整個表單以關閉。您可以在這裡傳遞 HTML 元素或自訂元素的字串 CSS 選擇器,該元素將用作滑動目標。(swipeToCloseswipeToStep 也必須啟用)
push布林值啟用時,開啟時會推動後面的檢視。僅在頂部安全區域就位時才有效。也可以透過將 sheet-modal-push 類別新增到 Sheet 元素來啟用。
breakpointsnumber[]使用此屬性取代 swipeToStep 以啟用滑動中斷點。必須是數字陣列 > 0 和 < 1,其中 0 表示完全關閉,1 表示完全開啟,例如 [0.33, 0.66][0.5] 等。
backdropBreakpoint數字定義背景幕可見時的中斷點。從 0(理想上從 breakpoints 陣列的最低(第一個)值)到 1(預設為 0)的數字
pushBreakpoint數字定義將檢視推回後方的中斷點(必須啟用 push)。從 0(理想上從 breakpoints 陣列的最低(第一個)值)到 1(預設為 0)的數字
animate布林值是否應以動畫開啟/關閉模式
containerElHTMLElement
字串
要將模式掛載到的元素(預設為應用程式根元素)

表單模式事件

事件說明
<Sheet> 事件
sheetOpen當表單模式開始其開啟動畫時,將觸發事件
sheetOpened當表單模式完成其開啟動畫後,將觸發事件
sheetClose當表單模式開始其關閉動畫時,將觸發事件
sheetClosed當表單模式完成其關閉動畫後,將觸發事件
sheetStepOpen將在表單滑動步驟開啟/展開時觸發事件
sheetStepClose將在表單滑動步驟關閉/摺疊時觸發事件
sheetStepProgress將在表單滑動步驟位於步驟開啟和關閉狀態之間時觸發事件。作為第二個引數,它會收到步驟開啟進度數字(從 01
sheetBreakpoint將在表單中斷點變更時觸發事件。作為第二個引數,它會收到目前的斷點(從 01

表單模式插槽

<Sheet> 元件有額外的插槽供自訂元素使用

<Sheet>
  <span slot="fixed">Fixed slot</span>
  <span slot="static">Static slot</span>
  <span>Default slot</span>
</Sheet>

呈現為

<div class="sheet-modal">
  <span>Fixed slot</span>
  <div class="sheet-modal-inner">
    <span>Default slot</span>
    <span>Static slot</span>
  </div>
</div>

開啟和關閉表單模式

您可以控制表單模式狀態,開啟和關閉它

存取表單模式執行個體

您可以透過呼叫 .instance() 元件的方法存取已初始化的表單模式執行個體。例如

<Sheet bind:this={component}>...</Sheet>

<script>
  let component;

  // to get instance in some method
  component.instance()
</script>


範例

sheet-modal.svelte
<script>
  import {
    f7,
    Page,
    Navbar,
    Sheet,
    PageContent,
    Toolbar,
    BlockTitle,
    Block,
    Button,
    Link,
    List,
    ListItem,
  } from 'framework7-svelte';

  let sheetOpened = false;
  let dynamicSheet;

  function toggleSwipeStep() {
    f7.sheet.stepToggle('.demo-sheet-swipe-to-step');
  }
  function createSheet() {
    const $ = f7.$;
    // Create sheet modal
    if (!dynamicSheet) {
      dynamicSheet = f7.sheet.create({
        content: `
          <div class="sheet-modal sheet-modal-bottom">
            <div class="toolbar">
              <div class="toolbar-inner justify-content-flex-end">
                <a  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. Suspendisse non nisl semper tellus malesuada suscipit eu et eros. Nulla eu enim quis quam elementum vulputate. Mauris ornare consequat nunc viverra pellentesque. Aenean semper eu massa sit amet aliquam. Integer et neque sed libero mollis elementum at vitae ligula. Vestibulum pharetra sed libero sed porttitor. Suspendisse a faucibus lectus.</p>
                </div>
              </div>
            </div>
          </div>
        `.trim(),
      });
    }
    // Close inline sheet
    if ($('.demo-sheet.modal-in').length > 0) f7.sheet.close('.demo-sheet');
    // Open it
    dynamicSheet.open();
  }
  function onPageBeforeOut() {
    // Close opened sheets on page out
    f7.sheet.close();
  }
  function onPageBeforeRemove() {
    // Destroy sheet modal when page removed
    if (dynamicSheet) dynamicSheet.destroy();
  }
</script>

<Page {onPageBeforeOut} {onPageBeforeRemove}>
  <Navbar title="Sheet Modal" />
  <Block strongIos outlineIos>
    <p>
      Sheet Modals slide up from the bottom of the screen to reveal more content. Such modals allow
      to create custom overlays with custom content.
    </p>
    <p class="grid grid-cols-2 grid-gap">
      <Button fill sheetOpen=".demo-sheet">Open Sheet</Button>
      <Button fill onClick={createSheet}>Dynamic Sheet</Button>
    </p>
    <p>
      <Button fill sheetOpen=".demo-sheet-top">Top Sheet</Button>
    </p>
    <p>
      <Button fill onClick={() => (sheetOpened = true)}>Open Via Prop Change</Button>
    </p>
  </Block>

  <BlockTitle>Push View</BlockTitle>
  <Block strongIos outlineIos>
    <p>
      Sheet can push view behind on open. By default it has effect only when `safe-area-inset-top`
      is more than zero (iOS fullscreen webapp or iOS cordova app)
    </p>
    <p>
      <Button fill sheetOpen=".demo-sheet-push">Sheet Push</Button>
    </p>
  </Block>

  <BlockTitle>Swipeable Sheet</BlockTitle>
  <Block strongIos outlineIos>
    <p>
      Sheet modal can be closed with swipe to top (for top Sheet) or bottom (for default Bottom
      sheet):
    </p>
    <p>
      <Button fill sheetOpen=".demo-sheet-swipe-to-close">Swipe To Close</Button>
    </p>
    <p>Also there is swipe-step that can be set on Sheet modal to expand it with swipe:</p>
    <p>
      <Button fill sheetOpen=".demo-sheet-swipe-to-step">Swipe To Step</Button>
    </p>
    <p>In addition to "swipe step" there is a support for position breakpoints (multiple steps):</p>
    <p>
      <Button fill sheetOpen=".demo-sheet-breakpoints">Breakpoints</Button>
    </p>
  </Block>

  <Sheet class="demo-sheet" opened={sheetOpened} onSheetClosed={() => (sheetOpened = false)}>
    <Toolbar>
      <div class="left" />
      <div class="right">
        <Link sheetClose>Close</Link>
      </div>
    </Toolbar>
    <PageContent>
      <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>
        <p>
          Sunt magni enim saepe quasi aspernatur delectus consectetur fugiat necessitatibus qui sed,
          similique quis facere tempora, laudantium quae expedita ea, aperiam dolores. Aut deserunt
          soluta alias magnam. Consequatur, nisi, enim.
        </p>
        <p>
          Eaque maiores ducimus, impedit unde culpa qui, explicabo accusamus, non vero corporis
          voluptatibus similique odit ab. Quaerat quasi consectetur quidem libero? Repudiandae
          adipisci vel voluptatum, autem libero minus dignissimos repellat.
        </p>
        <p>
          Iusto, est corrupti! Totam minus voluptas natus esse possimus nobis, delectus veniam
          expedita sapiente ut cum reprehenderit aliquid odio amet praesentium vero temporibus
          obcaecati beatae aspernatur incidunt, perferendis voluptates doloribus?
        </p>
        <p>
          Illum id laborum tempore, doloribus culpa labore ex iusto odit. Quibusdam consequuntur
          totam nam obcaecati, enim cumque nobis, accusamus, quos voluptates, voluptatibus sapiente
          repellendus nesciunt praesentium velit ipsa illo iusto.
        </p>
      </Block>
    </PageContent>
  </Sheet>

  <Sheet top class="demo-sheet-top">
    <Toolbar bottom>
      <div class="left" />
      <div class="right">
        <Link sheetClose>Close</Link>
      </div>
    </Toolbar>
    <PageContent>
      <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>
        <p>
          Sunt magni enim saepe quasi aspernatur delectus consectetur fugiat necessitatibus qui sed,
          similique quis facere tempora, laudantium quae expedita ea, aperiam dolores. Aut deserunt
          soluta alias magnam. Consequatur, nisi, enim.
        </p>
        <p>
          Eaque maiores ducimus, impedit unde culpa qui, explicabo accusamus, non vero corporis
          voluptatibus similique odit ab. Quaerat quasi consectetur quidem libero? Repudiandae
          adipisci vel voluptatum, autem libero minus dignissimos repellat.
        </p>
        <p>
          Iusto, est corrupti! Totam minus voluptas natus esse possimus nobis, delectus veniam
          expedita sapiente ut cum reprehenderit aliquid odio amet praesentium vero temporibus
          obcaecati beatae aspernatur incidunt, perferendis voluptates doloribus?
        </p>
        <p>
          Illum id laborum tempore, doloribus culpa labore ex iusto odit. Quibusdam consequuntur
          totam nam obcaecati, enim cumque nobis, accusamus, quos voluptates, voluptatibus sapiente
          repellendus nesciunt praesentium velit ipsa illo iusto.
        </p>
      </Block>
    </PageContent>
  </Sheet>

  <Sheet class="demo-sheet-push" push>
    <Toolbar>
      <div class="left" />
      <div class="right">
        <Link sheetClose>Close</Link>
      </div>
    </Toolbar>
    <PageContent>
      <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>
        <p>
          Sunt magni enim saepe quasi aspernatur delectus consectetur fugiat necessitatibus qui sed,
          similique quis facere tempora, laudantium quae expedita ea, aperiam dolores. Aut deserunt
          soluta alias magnam. Consequatur, nisi, enim.
        </p>
        <p>
          Eaque maiores ducimus, impedit unde culpa qui, explicabo accusamus, non vero corporis
          voluptatibus similique odit ab. Quaerat quasi consectetur quidem libero? Repudiandae
          adipisci vel voluptatum, autem libero minus dignissimos repellat.
        </p>
        <p>
          Iusto, est corrupti! Totam minus voluptas natus esse possimus nobis, delectus veniam
          expedita sapiente ut cum reprehenderit aliquid odio amet praesentium vero temporibus
          obcaecati beatae aspernatur incidunt, perferendis voluptates doloribus?
        </p>
        <p>
          Illum id laborum tempore, doloribus culpa labore ex iusto odit. Quibusdam consequuntur
          totam nam obcaecati, enim cumque nobis, accusamus, quos voluptates, voluptatibus sapiente
          repellendus nesciunt praesentium velit ipsa illo iusto.
        </p>
      </Block>
    </PageContent>
  </Sheet>

  <Sheet class="demo-sheet-swipe-to-close" style="height: auto" swipeToClose push backdrop>
    <div class="swipe-handler" />

    <PageContent>
      <BlockTitle large>Hello!</BlockTitle>
      <Block>
        <p>
          Eaque maiores ducimus, impedit unde culpa qui, explicabo accusamus, non vero corporis
          voluptatibus similique odit ab. Quaerat quasi consectetur quidem libero? Repudiandae
          adipisci vel voluptatum, autem libero minus dignissimos repellat.
        </p>
        <p>
          Iusto, est corrupti! Totam minus voluptas natus esse possimus nobis, delectus veniam
          expedita sapiente ut cum reprehenderit aliquid odio amet praesentium vero temporibus
          obcaecati beatae aspernatur incidunt, perferendis voluptates doloribus?
        </p>
      </Block>
    </PageContent>
  </Sheet>

  <Sheet
    class="demo-sheet-swipe-to-step"
    style="height: auto"
    swipeToClose
    swipeToStep
    push
    backdrop
  >
    <div class="swipe-handler" on:click={() => toggleSwipeStep()} />
    <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">
        <Button large fill>Make Payment</Button>
        <div class="margin-top text-align-center">Swipe up for more details</div>
      </div>
    </div>
    <BlockTitle medium class="margin-top">Your order:</BlockTitle>
    <List>
      <ListItem title="Item 1"><b slot="after">$200</b></ListItem>
      <ListItem title="Item 2"><b slot="after">$180</b></ListItem>
      <ListItem title="Delivery"><b slot="after">$120</b></ListItem>
    </List>
  </Sheet>

  <Sheet
    class="demo-sheet-breakpoints"
    style="height: auto"
    swipeToClose
    breakpoints={[0.33, 0.66]}
    backdrop
    backdropBreakpoint={0.66}
    push
    pushBreakpoint={0.66}
  >
    <div class="swipe-handler" style="background-color: transparent;" />
    <div style="display: flex; align-items: center; justify-content: center; height: 20vh;">
      Section 1
    </div>
    <div style="display: flex; align-items: center; justify-content: center; height: 20vh;">
      Section 2
    </div>
    <div style="display: flex; align-items: center; justify-content: center; height: 20vh;">
      Section 3
    </div>
  </Sheet>
</Page>