Sheet Modal Svelte组件
Sheet Modal是一种特殊的覆盖类型,类似于Picker/Calendar的覆盖。这种模态允许创建具有自定义内容的自定义选择器覆盖。
Sheet Modal Svelte组件表示表格模态组件。
Sheet Modal组件
包含以下组件:
Sheet
- sheet modal元素
Sheet Modal属性
属性 | 类型 | 描述 |
---|---|---|
<Sheet>属性 | ||
位置 | 字符串 | Sheet位置,可以是top 或bottom .默认是bottom |
顶部 | 布尔值 | 与position="top" |
底部相同 | 布尔值 | 与position="bottom" |
背景遮罩 | 布尔值 | 在需要时启用渲染额外的Sheet Modal背景遮罩 |
backdropEl | 字符串 对象 | 自定义背景元素的HTML元素或字符串CSS选择器 |
backdropUnique | 布尔值 | 如果启用,它将为该模态创建唯一的背景元素 |
opened | 布尔值 | 允许打开/关闭Sheet Modal并设置其初始状态 |
closeByBackdropClick | 布尔值 | 当启用时,点击背景遮罩将关闭Sheet。默认继承相同的应用参数值 |
closeByOutsideClick | 布尔值 | 当启用时,点击其外部将关闭Sheet。默认继承相同的应用参数值 |
closeOnEscape | 布尔值 | 当启用时,按下ESC键盘键将关闭Sheet |
swipeToClose | 布尔值 | Sheet是否可以用滑动手势关闭 |
swipeToStep | 布尔值 | 当启用时,可以将其分为两种状态:部分打开和完全打开,可以通过滑动控制 |
swipeHandler | HTMLElement 字符串 | 如果未传递,则整个Sheet都可以滑动关闭。您可以在此处传递HTML元素或字符串CSS选择器,该元素将用作滑动目标。(必须启用)swipeToClose 或swipeToStep push |
push | 布尔值 | 当启用时,打开时将视图推到后面。仅在顶部安全区域存在时才有效。也可以通过向Sheet元素添加sheet-modal-push 类来启用 |
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 Modal事件
事件 | 描述 |
---|---|
<Sheet>事件 | |
sheetOpen | 当Sheet Modal开始其打开动画时将触发事件 |
sheetOpened | Sheet Modal完成其打开动画后触发事件 |
sheetClose | 当Sheet Modal开始其关闭动画时将触发事件 |
sheetClosed | Sheet Modal完成其关闭动画后触发事件 |
sheetStepOpen | 在Sheet滑动步骤打开/展开时触发事件 |
sheetStepClose | 在Sheet滑动步骤关闭/折叠时触发事件 |
sheetStepProgress | 在Sheet滑动步骤在打开和关闭状态之间时触发事件。作为第二个参数,它接收步骤打开进度数字(从0 到1 ) |
sheetBreakpoint | 在Sheet断点更改时触发事件。作为第二个参数,它接收当前断点(从0 到1 ) |
Sheet Modal插槽
<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状态,打开和关闭它:
- 使用其Sheet Modal API
- 通过将其
true
或false
传递给其opened
prop - 通过点击链接或按钮并使用相关
sheetOpen
属性(打开它)和sheetClose
属性来关闭它
访问Sheet Modal实例
您可以通过调用.instance()
组件的方法来访问初始化的Sheet Modal实例。例如:
<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>