Sheet Modal Svelte コンポーネント

    Sheet Modalは、Picker/Calendarのオーバーレイに似た特殊なオーバーレイタイプです。このようなモーダルは、カスタムコンテンツを持つカスタムピッカーオーバーレイを作成することができます。

    Sheet Modal Svelteコンポーネントは、Sheet Modalコンポーネントを表しています。

    シートモーダルコンポーネント

    以下のコンポーネントが含まれています。

    • Sheet - シートモーダル要素

    シートモーダルのプロパティ

    PropTypeDescription
    <Sheet> properties
    positionstringシートの位置は top または bottom になります。デフォルトでは bottom です。
    topbooleanposition="top"`と同じです。
    bottombooleanposition="bottom"` と同じです。
    backdropboolean必要に応じて、追加のシートモーダルの背景をレンダリングすることを可能にします。
    backdropElstring
    object
    HTML要素または文字列 カスタム背景要素のCSSセレクタ
    openedbooleanシートモーダルの開閉と初期状態の設定を可能にする
    closeByBackdropClickboolean有効にすると、背景をクリックしたときにシートが閉じられます。デフォルトでは同じアプリのパラメータ値を継承します
    closeByOutsideClickboolean有効にすると、シートの外側をクリックしたときにシートを閉じます。デフォルトでは、同じアプリのパラメーター値を継承します。
    closeOnEscapeboolean有効にすると、ESCキーを押したときにシートが閉じます。
    swipeToClosebooleanスワイプジェスチャーでシートを閉じることができるかどうか
    swipeToStepboolean有効にすると、開いているシートを、スワイプで操作できる「部分的に開いた状態」と「完全に開いた状態」に分けることができます。
    swipeHandlerHTMLElement
    string
    有効にしない場合は、シート全体をスワイプで閉じることができます。ここでは、スワイプターゲットとして使われるカスタム要素のHTML要素または文字列のCSSセレクタを渡すことができます。(swipeToClose または swipeToStep も有効にする必要があります)
    pushboolean有効にすると、オープン時にビューを後ろに押します。トップセーフエリアが設定されている場合のみ動作します。また、Sheet要素にsheet-modal-pushクラスを追加することでも、この機能を有効にすることができます。
    animatebooleanWhether the modal should be opened/closed with animation or not
    containerElHTMLElement
    string
    Element to mount modal to (default to app root element)

    シートモーダルのイベント

    EventDescription
    <Sheet> events
    sheetOpenイベントは、Sheet Modal がオープニングアニメーションを開始したときに発生します。
    sheetOpenedイベントはSheet Modalがオープニングアニメーションを完了した後に発生します。
    sheetCloseイベントはSheet Modalが閉じるアニメーションを開始するときに発生します。
    sheetClosedイベントはSheet Modalが閉じるアニメーションを完了した後に発生します。
    sheetStepOpenイベントはシートスワイプステップのオープン/エクスパンションでトリガされます。
    sheetStepCloseイベントはシートスワイプステップのクローズ/コラプスでトリガされます。
    sheetStepProgressイベントはシートスワイプステップが開いた状態と閉じた状態の間で発生します。event.detailとして、ステップオープンのプログレス番号(0から1`まで)を受け取ります。

    シートモーダルのスロット

    <Sheet> コンポーネントには、カスタムエレメント用の追加スロットがあります。

    • default - スクロール可能な <div class="sheet-modal-inner"> 要素の子として挿入されます。
    • static - default と同じです。
    • fixed - スクロール可能な <div class="sheet-modal-inner"> 要素の前に挿入されます。
    <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>
    

    シートモーダルを開く・閉じる

    Sheet Modalの状態を制御して、開いたり閉じたりすることができます。

    • Sheet Modal APIを使って、Sheet Modalの状態を制御し、開いたり閉じたりすることができます。
    • シートモーダルの opened プロパティーに true または false を渡します。
    • リンクボタンsheetOpen プロパティ(開く)や sheetClose プロパティ(閉じる)をクリックする。

    Sheet Modal インスタンスへのアクセス

    Sheet Modal の初期化されたインスタンスにアクセスするには、.instance() コンポーネントのメソッドを呼び出します。例えば

    <Sheet bind:this={component}>...</Sheet>
    
    <script>
      let component;
    
      // あるメソッドでインスタンスを取得する
      component.instance()
    </script>
    
    

    Examples

    <Page onPageBeforeOut={onPageBeforeOut} onPageBeforeRemove={onPageBeforeRemove}>
      <Navbar title="Sheet Modal"></Navbar>
      <Block>
        <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>
          <Button fill sheetOpen=".demo-sheet">Open Sheet</Button>
        </p>
        <p>
          <Button fill onClick={createSheet}>Create Dynamic Sheet</Button>
        </p>
        <p>
          <Button fill onClick={() => sheetOpened = true}>Open Via Prop Change</Button>
        </p>
        <p>
          <Button fill sheetOpen=".demo-sheet-swipe-to-close">Swipe To Close</Button>
        </p>
        <p>
          <Button fill sheetOpen=".demo-sheet-swipe-to-step">Swipe To Step</Button>
        </p>
        <p>
          <Button fill sheetOpen=".demo-sheet-push">Sheet Push</Button>
        </p>
      </Block>
    
      <Sheet class="demo-sheet" opened={sheetOpened} onSheetClosed={() => sheetOpened = false}>
        <Toolbar>
          <div class="left"></div>
          <div class="right">
            <Link sheetClose>Close</Link>
          </div>
        </Toolbar>
        <!--  Scrollable sheet content -->
        <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; --f7-sheet-bg-color: #fff"
        swipeToClose
        backdrop
      >
        <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; --f7-sheet-bg-color: #fff"
        swipeToClose
        swipeToStep
        backdrop
      >
        <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 noHairlines>
          <ListItem title="Item 1">
            <b slot="after" class="text-color-black">$200</b>
          </ListItem>
          <ListItem title="Item 2">
            <b slot="after" class="text-color-black">$180</b>
          </ListItem>
          <ListItem title="Delivery">
            <b slot="after" class="text-color-black">$120</b>
          </ListItem>
        </List>
      </Sheet>
    
      <Sheet class="demo-sheet-push" push>
        <Toolbar>
          <div class="left"></div>
          <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>
    </Page>
      
    
    <script>
      import {f7, Page, Navbar, Block, Button, Sheet, Toolbar, Link, PageContent, BlockTitle, List, ListItem} from 'framework7-svelte';
    
      let sheetOpened = false;
      let sheet;
    
      function createSheet() {
        // Create sheet modal
        if (!sheet) {
          sheet = 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. 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 (f7.$('.demo-sheet.modal-in').length > 0) f7.sheet.close('.demo-sheet');
        // Open it
        sheet.open();
      }
    
      function onPageBeforeOut() {
        // Close opened sheets on page out
        f7.sheet.close();
      }
    
      function onPageBeforeRemove() {
        // Destroy sheet modal when page removed
        if (sheet) sheet.destroy();
      }
    </script>