シートモーダル React コンポーネント
シートモーダルは、ピッカー/カレンダーのオーバーレイと同様の特殊なオーバーレイタイプです。このようなモーダルを使用すると、カスタムコンテンツを持つカスタムピッカーオーバーレイを作成できます。
シートモーダル React コンポーネントは、シートモーダルコンポーネントを表します。
シートモーダルコンポーネント
次のコンポーネントが含まれています。
Sheet
- シートモーダル要素
シートモーダルプロパティ
プロパティ | タイプ | 説明 |
---|---|---|
<Sheet> プロパティ | ||
position | 文字列 | シートの位置。top またはbottom になります。デフォルトはbottom です。 |
top | 論理値 | position="top" と同じです。 |
bottom | 論理値 | position="bottom" と同じです。 |
backdrop | 論理値 | 必要に応じて追加のシートモーダルバックドロップをレンダリングできるようにします。 |
backdropEl | 文字列 オブジェクト | カスタムバックドロップ要素のHTML要素または文字列CSSセレクター |
backdropUnique | 論理値 | 有効にすると、このモーダル専用の独自のバックドロップ要素が作成されます。 |
opened | 論理値 | シートモーダルを開閉し、初期状態を設定できます。 |
closeByBackdropClick | 論理値 | 有効にすると、バックドロップをクリックしたときにシートが閉じます。デフォルトでは、同じアプリパラメーター値を継承します。 |
closeByOutsideClick | 論理値 | 有効にすると、シートの外側をクリックしたときにシートが閉じます。デフォルトでは、同じアプリパラメーター値を継承します。 |
closeOnEscape | 論理値 | 有効にすると、ESCキーを押したときにシートが閉じます。 |
swipeToClose | 論理値 | スワイプジェスチャーでシートを閉じることができるかどうか。 |
swipeToStep | 論理値 | 有効にすると、開いたシートを部分的に開いた状態と完全に開いた状態の2つの状態に分割できます。スワイプで制御できます。 |
swipeHandler | HTMLElement 文字列 | 渡さない場合、シート全体をスワイプして閉じることができます。ここでは、スワイプターゲットとして使用されるカスタム要素のHTML要素または文字列CSSセレクターを渡すことができます。(swipeToClose またはswipeToStep も有効にする必要があります) |
push | 論理値 | 有効にすると、開いているときに後ろのビューをプッシュします。トップセーフエリアがある場合にのみ機能します。sheet-modal-push クラスをSheet要素に追加することでも有効にできます。 |
breakpoints | number[] | swipeToStep の代わりに使用して、スワイプブレークポイントを有効にします。0が完全に閉じられ、1が完全に開かれている0より大きく1より小さい数値の配列でなければなりません。例:[0.33, 0.66] 、[0.5] など。 |
backdropBreakpoint | 数値 | バックドロップが表示されるブレークポイントを定義します。0 (理想的にはbreakpoints 配列の最小値(最初の値))から1 (デフォルト0)の数値。 |
pushBreakpoint | 数値 | 後ろのビューをプッシュするブレークポイントを定義します(push を有効にする必要があります)。0 (理想的にはbreakpoints 配列の最小値(最初の値))から1 (デフォルト0)の数値。 |
animate | 論理値 | モーダルを開閉する際にアニメーションを使用するかどうか。 |
containerEl | HTMLElement 文字列 | モーダルをマウントする要素(デフォルトはアプリのルート要素) |
シートモーダルイベント
イベント | 説明 |
---|---|
<Sheet> イベント | |
sheetOpen | シートモーダルが開くアニメーションを開始するとトリガーされるイベント。 |
sheetOpened | シートモーダルが開くアニメーションが完了するとトリガーされるイベント。 |
sheetClose | シートモーダルが閉じるアニメーションを開始するとトリガーされるイベント。 |
sheetClosed | シートモーダルが閉じるアニメーションが完了するとトリガーされるイベント。 |
sheetStepOpen | シートのスワイプステップを開いたり展開したりするとトリガーされるイベント。 |
sheetStepClose | シートのスワイプステップを閉じたり折りたたんだりするとトリガーされるイベント。 |
sheetStepProgress | ステップが開いている状態と閉じている状態の間のスワイプステップでトリガーされるイベント。第2引数として、ステップオープン進行状況の数値(0 から1 )を受け取ります。 |
sheetBreakpoint | シートのブレークポイントの変更時にトリガーされるイベント。第2引数として、現在のブレークポイント(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>
シートモーダルの開閉
シートモーダルの状態を制御し、開閉できます。
- シートモーダルAPIを使用します。
opened
プロパティにtrue
またはfalse
を渡すことで。- 関連する
sheetOpen
プロパティを持つリンクまたはボタンをクリックすることで(開くため)、sheetClose
プロパティを使用して閉じます。
例
sheet-modal.jsx
import React, { useRef, useState } from 'react';
import {
Page,
Navbar,
Sheet,
PageContent,
Toolbar,
BlockTitle,
Block,
Button,
Link,
List,
ListItem,
f7,
} from 'framework7-react';
export default () => {
const sheet = useRef(null);
const [sheetOpened, setSheetOpened] = useState(false);
const toggleSwipeStep = () => {
f7.sheet.stepToggle('.demo-sheet-swipe-to-step');
};
const createSheet = () => {
const $ = f7.$;
// Create sheet modal
if (!sheet.current) {
sheet.current = 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
sheet.current.open();
};
const onPageBeforeOut = () => {
// Close opened sheets on page out
f7.sheet.close();
};
const onPageBeforeRemove = () => {
// Destroy sheet modal when page removed
if (sheet.current) sheet.current.destroy();
};
return (
<Page onPageBeforeOut={onPageBeforeOut} onPageBeforeRemove={onPageBeforeRemove}>
<Navbar title="Sheet Modal"></Navbar>
<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 className="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={() => {
setSheetOpened(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
className="demo-sheet"
opened={sheetOpened}
onSheetClosed={() => {
setSheetOpened(false);
}}
>
<Toolbar>
<div className="left"></div>
<div className="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 top className="demo-sheet-top">
<Toolbar bottom>
<div className="left"></div>
<div className="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 className="demo-sheet-push" push>
<Toolbar>
<div className="left"></div>
<div className="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
className="demo-sheet-swipe-to-close"
style={{ height: 'auto' }}
swipeToClose
push
backdrop
>
<div className="swipe-handler"></div>
<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
className="demo-sheet-swipe-to-step"
style={{ height: 'auto' }}
swipeToClose
swipeToStep
push
backdrop
>
<div className="swipe-handler" onClick={() => toggleSwipeStep()}></div>
<div className="sheet-modal-swipe-step">
<div className="display-flex padding justify-content-space-between align-items-center">
<div style={{ fontSize: '18px' }}>
<b>Total:</b>
</div>
<div style={{ fontSize: '22px' }}>
<b>$500</b>
</div>
</div>
<div className="padding-horizontal padding-bottom">
<Button large fill>
Make Payment
</Button>
<div className="margin-top text-align-center">Swipe up for more details</div>
</div>
</div>
<BlockTitle medium className="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
className="demo-sheet-breakpoints"
style={{ height: 'auto' }}
swipeToClose
breakpoints={[0.33, 0.66]}
backdrop
backdropBreakpoint={0.66}
push
pushBreakpoint={0.66}
>
<div className="swipe-handler" style={{ backgroundColor: 'transparent' }}></div>
<div
style={{
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
height: '20vh',
}}
>
Section 1
</div>
<div
style={{
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
height: '20vh',
}}
>
Section 2
</div>
<div
style={{
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
height: '20vh',
}}
>
Section 3
</div>
</Sheet>
</Page>
);
};