Toast
Toasts provide brief feedback about an operation through a message on the screen.
Toast App Methods
Let's look at related App methods to work with Toast:
app.toast.create(parameters)- create Toast instance
- parameters - object. Object with toast parameters
Method returns created Toast's instance
app.toast.destroy(el)- destroy Toast instance
- el - HTMLElement or string (with CSS Selector) or object. Toast element or Toast instance to destroy.
app.toast.get(el)- get Toast instance by HTML element
- el - HTMLElement or string (with CSS Selector). Toast element.
Method returns Toast's instance
app.toast.open(el, animate)- opens Toast
- el - HTMLElement or string (with CSS Selector). Toast element to open.
- animate - boolean. Open Toast with animation.
Method returns Toast's instance
app.toast.close(el, animate)- closes Toast
- el - HTMLElement or string (with CSS Selector). Toast element to close.
- animate - boolean. Close Toast with animation.
Method returns Toast's instance
app.toast.show(parameters)- create Toast instance and show immediately
- parameters - object. Object with toast parameters
Method returns created Toast's instance
Toast Parameters
Now let's look at list of available parameters we need to create Toast:
Parameter | Type | Default | Description |
---|---|---|---|
el | HTMLElement | Toast element. Can be useful if you already have Toast element in your HTML and want to create new instance using this element | |
icon | string | Toast icon HTML layout, e.g. <i class="f7-icons">house</i> or image <img src="path/to/icon.png" /> | |
text | string | Toast inner text | |
position | string | bottom | Toast position. Can be bottom , center or top |
horizontalPosition | string | left | Toast horizontal alignment on wide screen. Has effects only on top and bottom toasts. Can be left , center or right |
closeButton | boolean | false | Adds toast close button |
closeButtonColor | string | One of the default color themes | |
closeButtonText | string | Ok | Close button text |
closeTimeout | number | Timeout delay (in ms) to close toast automatically | |
cssClass | string | Additional css class to add | |
destroyOnClose | boolean | false | Destroys toast instance on close |
render | function | Custom function to render Toast. Must return toast html | |
containerEl | HTMLElement string | Allows to mount the toast to custom element rather than app root element | |
on | object | Object with events handlers. For example:
|
Note that all following parameters can be used in global app parameters under toast
property to set defaults for all toasts. For example:
var app = new Framework7({
toast: {
closeTimeout: 3000,
closeButton: true,
}
});
Toast Methods & Properties
So to create Toast we have to call:
var toast = app.toast.create({ /* parameters */ })
After that we have its initialized instance (like toast
variable in example above) with useful methods and properties:
Properties | |
---|---|
toast.app | Link to global app instance |
toast.el | Toast HTML element |
toast.$el | Dom7 instance with toast HTML element |
toast.params | Toast parameters |
Methods | |
toast.open() | Open toast |
toast.close() | Close toast |
toast.on(event, handler) | Add event handler |
toast.once(event, handler) | Add event handler that will be removed after it was fired |
toast.off(event, handler) | Remove event handler |
toast.off(event) | Remove all handlers for specified event |
toast.emit(event, ...args) | Fire event on instance |
Toast Events
Toast will fire the following DOM events on toast element and events on app and toast instance:
DOM Events
Event | Target | Description |
---|---|---|
toast:open | Toast Element<div class="toast"> | Event will be triggered when Toast starts its opening animation |
toast:opened | Toast Element<div class="toast"> | Event will be triggered after Toast completes its opening animation |
toast:close | Toast Element<div class="toast"> | Event will be triggered when Toast starts its closing animation |
toast:closed | Toast Element<div class="toast"> | Event will be triggered after Toast completes its closing animation |
App and Toast Instance Events
Toast instance emits events on both self instance and app instance. App instance events has same names prefixed with toast
.
Event | Arguments | Target | Description |
---|---|---|---|
closeButtonClick | toast | toast | Event will be triggered when user clicks on Toast close button. As an argument event handler receives toast instance |
toastCloseButtonClick | toast | app | |
open | toast | toast | Event will be triggered when Toast starts its opening animation. As an argument event handler receives toast instance |
toastOpen | toast | app | |
opened | toast | toast | Event will be triggered after Toast completes its opening animation. As an argument event handler receives toast instance |
toastOpened | toast | app | |
close | toast | toast | Event will be triggered when Toast starts its closing animation. As an argument event handler receives toast instance |
toastClose | toast | app | |
closed | toast | toast | Event will be triggered after Toast completes its closing animation. As an argument event handler receives toast instance |
toastClosed | toast | app | |
beforeDestroy | toast | toast | Event will be triggered right before Toast instance will be destroyed. As an argument event handler receives toast instance |
toastBeforeDestroy | toast | app |
CSS Variables
Below is the list of related CSS variables (CSS custom properties).
:root {
--f7-toast-font-size: 14px;
--f7-toast-icon-size: 48px;
--f7-toast-max-width: 568px;
}
.ios {
--f7-toast-text-color: #fff;
--f7-toast-bg-color: rgba(0, 0, 0, 0.75);
--f7-toast-bg-color-rgb: 0, 0, 0;
--f7-toast-padding-horizontal: 16px;
--f7-toast-padding-vertical: 12px;
--f7-toast-border-radius: 8px;
--f7-toast-button-min-width: 64px;
}
.md {
--f7-toast-padding-horizontal: 24px;
--f7-toast-padding-vertical: 14px;
--f7-toast-border-radius: 16px;
--f7-toast-button-min-width: 64px;
}
.md,
.md .dark,
.md [class*='color-'] {
--f7-toast-text-color: var(--f7-md-on-surface);
--f7-toast-bg-color: var(--f7-md-surface-5);
}
Examples
<template>
<div class="page">
<div class="navbar">
<div class="navbar-bg"></div>
<div class="navbar-inner sliding">
<div class="title">Toast</div>
</div>
</div>
<div class="page-content">
<div class="block block-strong-ios block-outline-ios">
<p>Toasts provide brief feedback about an operation through a message on the screen.</p>
<p>
<a class="button button-fill" @click=${showToastBottom}>Toast on Bottom</a>
</p>
<p>
<a class="button button-fill" @click=${showToastTop}>Toast on Top</a>
</p>
<p>
<a class="button button-fill" @click=${showToastCenter}>Toast on Center</a>
</p>
<p>
<a class="button button-fill" @click=${showToastIcon}>Toast with icon</a>
</p>
<p>
<a class="button button-fill" @click=${showToastLargeMessage}>Toast with large message</a>
</p>
<p>
<a class="button button-fill" @click=${showToastWithButton}>Toast with close button</a>
</p>
<p>
<a class="button button-fill" @click=${showToastWithCustomButton}>Toast with custom button</a>
</p>
<p>
<a class="button button-fill" @click=${showToastWithCallback}>Toast with callback on close</a>
</p>
</div>
</div>
</div>
</template>
<script>
export default (props, { $f7, $theme, $on }) => {
let toastBottom;
let toastTop;
let toastCenter;
let toastIcon;
let toastLargeMessage;
let toastWithButton;
let toastWithCustomButton;
let toastWithCallback;
const showToastBottom = () => {
// Create toast
if (!toastBottom) {
toastBottom = $f7.toast.create({
text: 'This is default bottom positioned toast',
closeTimeout: 2000,
});
}
// Open it
toastBottom.open();
}
const showToastTop = () => {
// Create toast
if (!toastTop) {
toastTop = $f7.toast.create({
text: 'Top positioned toast',
position: 'top',
closeTimeout: 2000,
});
}
// Open it
toastTop.open();
}
const showToastCenter = () => {
// Create toast
if (!toastCenter) {
toastCenter = $f7.toast.create({
text: 'I\'m on center',
position: 'center',
closeTimeout: 2000,
});
}
// Open it
toastCenter.open();
}
const showToastIcon = () => {
// Create toast
if (!toastIcon) {
toastIcon = $f7.toast.create({
icon: $theme.ios ? '<i class="f7-icons">star_fill</i>' : '<i class="material-icons">star</i>',
text: 'I\'m with icon',
position: 'center',
closeTimeout: 2000,
});
}
// Open it
toastIcon.open();
}
const showToastLargeMessage = () => {
// Create toast
if (!toastLargeMessage) {
toastLargeMessage = $f7.toast.create({
text: 'This toast contains a lot of text. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Nihil, quae, ab. Delectus amet optio facere autem sapiente quisquam beatae culpa dolore.',
closeTimeout: 2000,
});
}
// Open it
toastLargeMessage.open();
}
const showToastWithButton = () => {
// Create toast
if (!toastWithButton) {
toastWithButton = $f7.toast.create({
text: 'Toast with additional close button',
closeButton: true,
});
}
// Open it
toastWithButton.open();
}
const showToastWithCustomButton = () => {
// Create toast
if (!toastWithCustomButton) {
toastWithCustomButton = $f7.toast.create({
text: 'Custom close button',
closeButton: true,
closeButtonText: 'Close Me',
closeButtonColor: 'red',
});
}
// Open it
toastWithCustomButton.open();
}
const showToastWithCallback = () => {
// Create toast
if (!toastWithCallback) {
toastWithCallback = $f7.toast.create({
text: 'Callback on close',
closeButton: true,
on: {
close: function () {
$f7.dialog.alert('Toast closed');
},
}
});
}
// Open it
toastWithCallback.open();
}
$on('pageBeforeOut', () => {
$f7.toast.close();
})
$on('pageBeforeRemove', () => {
// Destroy toasts when page removed
if (toastBottom) toastBottom.destroy();
if (toastTop) toastTop.destroy();
if (toastCenter) toastCenter.destroy();
if (toastIcon) toastIcon.destroy();
if (toastLargeMessage) toastLargeMessage.destroy();
if (toastWithButton) toastWithButton.destroy();
if (toastWithCustomButton) toastWithCustomButton.destroy();
if (toastWithCallback) toastWithCallback.destroy();
})
return $render;
}
</script>