Page
Page is one of the main components (containers) used to display app content.
Page Layout
<div class="page" data-name="home">
<div class="page-content">
... scrollable page content goes here ...
</div>
</div>
Page Name
As you may note, each page has a data-name
attribute with a unique page name. It's not required but can be useful within "page events" or "page callbacks". It can help us to define which page is loaded and available so you can make required manipulations to the page.
Page Content
All visual content (like list views, forms, etc.) should put inside of <div class="page-content">
which should be a child of <div class="page">
. It's required for correct styling, layout and scrolling.
Page Events
Now lets look at one of the most important parts of page navigation, "page events". Page Events allow us to manipulate just loaded pages by executing JavaScript for those specific pages:
Event | Target | Description |
---|---|---|
page:mounted | Page Element<div class="page"> | Event will be triggered when new page just inserted to DOM. Or when page with keepAlive route is mounted/attached to DOM |
page:init | Page Element<div class="page"> | Event will be triggered after Framework7 initialize required page's components and navbar |
page:reinit | Page Element<div class="page"> | This event will be triggered in case of navigating to the page that was already initialized. |
page:beforein | Page Element<div class="page"> | Event will be triggered when everything initialized and page is ready to be transitioned into view (into active/current position) |
page:afterin | Page Element<div class="page"> | Event will be triggered after page transitioned into view |
page:beforeout | Page Element<div class="page"> | Event will be triggered right before page is going to be transitioned out of view |
page:afterout | Page Element<div class="page"> | Event will be triggered after page transitioned out of view |
page:beforeunmount | Page Element<div class="page"> | Event will be triggered when page with keepAlive route is going to be unmounted/detached from DOM |
page:beforeremove | Page Element<div class="page"> | Event will be triggered right before Page will be removed from DOM. This event could be very useful if you need to detach some events / destroy some plugins to free memory. This event won't be triggered for keepAlive routes. |
page:tabshow | Page Element<div class="page"> | Event will be triggered when page's parent View as Tab becomes visible |
page:tabhide | Page Element<div class="page"> | Event will be triggered when page's parent View as Tab becomes hidden |
Lets see how we can use these events. There are two ways to add page event handlers:
// Option 1. Using one 'page:init' handler for all pages
$$(document).on('page:init', function (e) {
// Do something here when page loaded and initialized
})
// Option 2. Using live 'page:init' event handlers for each page
$$(document).on('page:init', '.page[data-name="about"]', function (e) {
// Do something here when page with data-name="about" attribute loaded and initialized
})
Page Loading Sequence Classes
When a new page is loading and transitioned into the view (main visible part of the app) it has different classes on page element.
When we load/open new page the following happens:
- Currently active page has
page-current
class. - If page we load not in DOM (e.g. loaded via Ajax or using template or from component) it will be added to DOM.
- Page that we load/open will have additional
page-next
class set on its element. - Router element (
<div class="view">
) will have additionalrouter-transition-forward
class that does the following:- page with
page-next
(new page) class moves into the view - page with
page-current
(current page) class moves out of the view
- page with
- After transition completed, the new page that we loaded will have
page-current
class - And the page that was previously active will have
page-previous
class
When we load/open previous page (go back) the following happens:
- Currently active page has
page-current
class. - If page we go back to not in DOM (e.g. loaded via Ajax or using template or from component) it will be added to DOM.
- Page that we go back to will have additional
page-previous
class set on its element. - Router element (
<div class="view">
) will have additionalrouter-transition-backward
class that does the following:- page with
page-previous
(page that we go back to) class moves into the view - page with
page-current
(current page) class moves out of the view
- page with
- After transition completed, the new page that we returned to will have
page-current
class - And the page that was previously active will have
page-next
class. In case this page was added to DOM dynamically, it will be removed from DOM.
Page Data
As you may see it is pretty easy, but how do you determine which page is loaded when we use only one handler? For this case we have Page Data in the event details:
// In page events:
$$(document).on('page:init', function (e) {
// Page Data contains all required information about loaded and initialized page
var page = e.detail;
})
Or in case the event handler was assigned using Dom7 like in example above then it will be passed in second argument:
// In page events:
$$(document).on('page:init', function (e, page) {
console.log(page);
})
Now, in the example above we have page data in page
variable. It is an object with the following properties:
page.app | object | Initialized app instance |
page.view | object | View instance that contains this page (if this View was initialized) |
page.router | object | Router instance that contains this page (if this View was initialized). Same as page.view.router |
page.name | string | Value of page's data-name attribute |
page.el | HTMLElement | Page element |
page.$el | object | Dom7 instance with Page element |
page.from | string | Page position before transition or direction of where this Page comes from. It will be next if you load new page, previous - if you go back to this page, or current if this page replaces the currently active one. |
page.to | string | New page position or where this page goes to. Can be same next , previous or current |
page.position | string | Alias for page.from |
page.direction | string | Direction of page transition (if applicable). Can be forward or backward |
page.route | object | Route associated with this page, object with current route data that was used to load this page. It has the following properties
|
page.pageFrom | object | Page data of the page that was currently active before this new page. |
Access To Page Data
If you don't use page events/callbacks and need to access to page data, it is possible via the f7Page
property on its HTMLElement:
var $$ = Dom7;
var page = $$('.page[data-name="somepage"]')[0].f7Page;
// do something with page data
CSS Variables
Below is the list of related CSS variables (CSS custom properties).
Note that commented variables are not specified by default and their values is what they fallback to in this case.
:root {
--f7-page-master-width: 320px;
--f7-page-master-border-color: rgba(0, 0, 0, 0.1);
--f7-page-master-border-width: 1px;
--f7-page-swipeback-transition-duration: 300ms;
--f7-page-parallax-transition-duration: 500ms;
--f7-page-cover-transition-duration: 450ms;
--f7-page-dive-transition-duration: 500ms;
--f7-page-fade-transition-duration: 500ms;
--f7-page-flip-transition-duration: 700ms;
--f7-page-push-transition-duration: 500ms;
/*
--f7-page-content-extra-padding-top: 0px;
--f7-page-content-extra-padding-bottom: 0px;
*/
--f7-page-title-line-height: 1.2;
--f7-page-title-text-color: inherit;
--f7-page-title-padding-left: 16px;
--f7-page-title-padding-right: 16px;
}
.ios {
--f7-page-transition-duration: 400ms;
--f7-page-title-font-size: 34px;
--f7-page-title-font-weight: 700;
--f7-page-title-letter-spacing: -0.03em;
--f7-page-title-padding-vertical: 6px;
--f7-page-bg-color: #efeff4;
}
.ios .dark,
.ios.dark {
--f7-page-bg-color: #000;
}
.md {
--f7-page-transition-duration: 400ms;
--f7-page-title-font-size: 34px;
--f7-page-title-font-weight: 500;
--f7-page-title-letter-spacing: 0;
--f7-page-title-padding-vertical: 8px;
}
.md,
.md .dark,
.md [class*='color-'] {
--f7-page-bg-color: var(--f7-md-surface);
}
.dark {
--f7-page-master-border-color: rgba(255, 255, 255, 0.2);
}