-
Get Started
-
Events
-
Router / Navigation
-
Components
- App / Core
- Accordion / Collapsible
- Action Sheet / Actions
- Autocomplete
- Badge
- Block / Content Block
- Button
- Calendar / Datepicker
- Cards
- Checkbox
- Chips / Tags
- Contacts List
- Data Table
- Dialog
- Elevation
- Floating Action Button / FAB
- Form Data / Storage
- Gauge
- Grid / Layout Grid
- Icons
- Infinite Scroll
- Inputs / Form Inputs
- Lazy Load
- Link
- List View
- List Index
- Login Screen
- Messagebar
- Messages
- Navbar
- Notification
- Page
- Panel / Side Panels
- Photo Browser
- Picker
- Popover
- Popup
- Preloader
- Progressbar
- Pull to Refresh
- Radio
- Range Slider
- Searchbar
- Sheet Modal
- Smart Select
- Sortable List
- Statusbar
- Stepper
- Subnavbar
- Swiper
- Swipeout
- Tabs
- Timeline
- Toast
- Toggle
- Toolbar / Tabbar
- Tooltip
- Video Intelligence (vi)
- View / Router
- Virtual List
-
Framework7 Icons
-
Styling
-
Dom7
-
Template7
-
Fast Clicks
-
Utilities
-
Plugins API
-
Lazy Modules
-
Custom Build
View / Router
View (<div class="view">) - is a separate visual part of the app with its own settings, navigation and history. So it is some kind of app in app. Such kind of functionality allows you easily manipulate each part of your app.
View Layout
Let's look at view HTML structure:
<body>
<!-- app root -->
<div id="app">
<!-- view inside of panel -->
<div class="panel panel-left panel-cover">
<div class="view panel-view"> ... </div>
</div>
<!-- Your main view -->
<div class="view view-main">
<!-- View related pages -->
...
</div>
<div class="popup">
<div class="view popup-view"> ... </div>
</div>
</div>
</body>
As you see View may be almost in any part of your app.
Main View
Your main view should have additional view-main class. Why we need main view? By default all links (which is not in any initialized view) will load pages in main view. Also if you use pushState
hash navigation then it works only for main view's navigation.
Multiple Views Layout
In case we have the app with multiple views in app root, so called "Tabbed Views" app, we must wrap our views with additional <div class="views">
element.
Only one "Views" element is allowed!
<body>
<!-- app root -->
<div id="app">
<!-- view inside of panel -->
<div class="panel panel-left panel-cover">
<div class="view panel-view"> ... </div>
</div>
<!-- Views container -->
<div class="views tabs">
<!-- Your main view -->
<div class="view view-main tab tab-active" id="view-1">
<!-- View related pages -->
...
</div>
<!-- Another view -->
<div class="view tab" id="view-2">
<!-- View related pages -->
...
</div>
...
</div>
<div class="popup">
<div class="view popup-view"> ... </div>
</div>
</div>
</body>
View App Methods
When we already have required views in HTML and our app is already initialized, now we need to initialize our views. Let's look at available app methods to work with Views:
app.views.create(viewEl, parameters) - initialize View
- viewEl - string or HTMLElement. If string - CSS selector of View element
- parameters - object. Object with View parameters
- Method returns object with just created View instance.
app.views.get(viewEl) - get View instance by HTML element
- viewEl - string or HTMLElement. If string - CSS selector of View element
- Method returns object with just created View instance.
There could be situation when we need to get currently active View, because instead of main app view we may also have view in opened popup, popover, opened panel, tabs, etc. This method allows to get the View instance of currently active/visible/"most-top" view.
For example, if you have initilized View in panel, and panel is currently opened, then this method will return panel's view. Or, if you use app with tab bar layout, where each tab is view, then this method will return currently active/visible tab-view
app.views.current - get currently active/visible View instance.
- Method returns object with just created View instance.
View Parameters
Now let's look at list of available parameters we need to create View:
Parameter | Type | Default | Description |
---|---|---|---|
name | string | View name. If view was created with name, then it may be accessed via app.views.[name] |
|
main | boolean | false | Specify whether this is View is main or not. If not passed then will be determined based on whether its element has view-main class or not |
router | boolean | true | Set to false to disable view router |
url | string | Default (initial) View's url. If not specified, then it is equal to document url | |
stackPages | boolean | false | If enabled then all previous pages in navigation chain will not be removed from DOM when you navigate deeper and deeper. It could be useful, for example, if you have some Form from 5 steps (5 pages) and when you are on last 5th page you need access to form that was on 1st page. |
linksView | string object |
CSS Selector of another view or object with initialized View instance. By defaul all links in initialized (only) view will load pages in this view. This tell links to load pages in other view. | |
allowDuplicateUrls | boolean | false | You may enable this parameter to allow loading of new pages that have same url as currently "active" page in View. |
animate | boolean | true | Enables transitions between pages |
preloadPreviousPage | boolean | true | Enable/disable preloading of previous page when you go deep in navigation. Should be enabled for correct work of "swipe back page" feature. |
reloadPages | boolean | false | When enabled, View will always reload currently active page without loading new one |
restoreScrollTopOnBack | boolean | true | When enabled it will restore page scroll top when you get back to this page |
iosPageLoadDelay | number | 0 | Delay (in ms) after new page will be loaded and inserted to DOM and before it will be transitioned. Can be increased a bit to improve performance. Will have effect only under iOS theme |
materialPageLoadDelay | number | 0 | Delay (in ms) after new page will be loaded and inserted to DOM and before it will be transitioned. Can be increased a bit to improve performance. Will have effect only under MD theme |
passRouteQueryToRequest | boolean | true | When enabled then router will pass route url query to request url query (for url , templateUrl and componentUrl route properties)
If you have the following route:
and you will click link with /somepage/?foo=bar url then it will load page from http://myserver/page/?foo=bar url |
passRouteParamsToRequest | boolean | false | When enabled then router will pass current route parameters to request url query (for url , templateUrl and componentUrl route properties)
If you have the following route:
and you will click link with /user/11/posts/12/ url then it will load page from http://myserver/userpost/?userId=11&postId=12 url |
Routes | |||
routes | array | Array with current View routes. In case if specified then will overwrite global app routes and routes only specified here will be available for the current View | |
routesAdd | array | Array with additional routes that will extend global app routes. This additional routes will only be available for the current View | |
routesBeforeEnter | function(to, from, resolve, reject) array |
Function (or array of functions) that will be executed before every route load/enter. To proceed route loading resolve must be called. In case of array then every function in array must be resolved to proceed.
Same as route beforeEnter but will work for every route |
|
routesBeforeLeave | function(to, from, resolve, reject) array |
Function (or array of functions) that will be executed before every route unload/leave. To proceed navigation resolve must be called. In case of array then every function in array must be resolved to proceed.
Same as route beforeLeave but will work for every route |
|
Elements Removal | |||
removeElements | boolean | true | During page transitions Router may remove unused Page and Navbar elements from DOM. Useful to be disabled in case you want to handle elements removal manually or using other library, e.g. Vue or React |
removeElementsWithTimeout | boolean | false | When enabled then Router will remove elements after timeout |
removeElementsTimeout | number | 0 | Timeout to remove elements (in case of removeElementsWithTimeout: true ) |
unloadTabContent | boolean | true | Unloads routable tab content (removes tab inner content) when tab becomes visible. Only for routable tabs |
XHR Cache | |||
xhrCache | boolean | true | As Router can use Ajax to load HTML content for pages it is good to use caching, especially if your content in those pages updates not very often. |
xhrCacheIgnore | boolean | [] | Array of URLs (string) that should not be cached |
xhrCacheIgnoreGetParameters | boolean | false | If "true" then URLs like "about.html?id=2" and "about.html?id=3" will be treated and cached like single "about.html" page |
xhrCacheDuration | boolean | 1000 * 60 * 10 | Duration in ms (milliseconds) while app will use cache instead of loading page with another Ajax request. By default it takes 10 minutes. |
iOS Dynamic Navbar | |||
iosDynamicNavbar | boolean | true | Enables dynamic navbar for iOS theme |
iosSeparateDynamicNavbar | boolean | true | When enabled will extract dynamic navbar HTML element from page element and put it as a child of Views element. It improves dynamic navbar transition appearance, but in case you need dynamic navbar to be always as a page's child, then disable this parameter |
iosAnimateNavbarBackIcon | boolean | true | This option (when enabled) gives more native look for dynamic navbar left back-link icon animation. Useful only when you use dynamic navbar with default back-link icon on left side set as "sliding". |
Swipe back | |||
iosSwipeBack | boolean | true | Enable/disable ability to swipe back from left edge of screen to get to the previous page. For iOS theme |
iosSwipeBackThreshold | number | 0 | Value in px. Swipe back action will start if "touch distance" will be more than this value. For iOS theme |
iosSwipeBackActiveArea | number | 30 | Value in px. Width of invisible left edge of the screen that triggers swipe back action. For iOS theme |
iosSwipeBackAnimateShadow | boolean | true | Enable/disable box-shadow animation during swipe back action. You can disable it to improve performance. For iOS theme |
iosSwipeBackAnimateOpacity | boolean | true | Enable/disable opacity animation during swipe back action. You can disable it to improve performance. For iOS theme |
mdSwipeBack | boolean | false | Enable/disable ability to swipe back from left edge of screen to get to the previous page. For MD theme |
mdSwipeBackThreshold | number | 0 | Value in px. Swipe back action will start if "touch distance" will be more than this value. For MD theme |
mdSwipeBackActiveArea | number | 30 | Value in px. Width of invisible left edge of the screen that triggers swipe back action. For MD theme |
mdSwipeBackAnimateShadow | boolean | true | Enable/disable box-shadow animation during swipe back action. You can disable it to improve performance. For MD theme |
mdSwipeBackAnimateOpacity | boolean | false | Enable/disable opacity animation during swipe back action. You can disable it to improve performance. For MD theme |
Push State | |||
pushState | boolean | false | If you develop web app (not PhoneGap or Home Screen web app) it is useful to enable hash navigation (browser url will look like "http://my-webapp.com/#!/about.html"). User as well will be able to navigate through app's history by using browser's default back and forward buttons. |
pushStateRoot | string | Push state root URL separator, for example "http://my-app.com/". It is useful only in case when you use empty ("") pushStateSeparator | |
pushStateAnimate | boolean | true | Enable/disable page transitions on push state change |
pushStateAnimateOnLoad | boolean | false | Enable/disable push state page transition on app load |
pushStateSeparator | string | #! | Push state URL separator, can be changed for something like '#page/' and then your push state urls will look like "http://myapp.com/#page/about.html" |
pushStateOnLoad | boolean | true | Disable to ignore parsing push state URL and loading page on app load |
Events Handlers | |||
on | object |
Object with events handlers. For example:
|
Note that all following parameters can be used in global app parameters under view
property to set defaults for all views. For example:
var app = new Framework7({
view: {
iosDynamicNavbar: false,
xhrCache: false,
}
});
View Methods & Properties
So to create View we have to call:
var view = app.views.create({ /* parameters */ })
After that we have its initialized instance (like view
variable in example above) with useful methods and properties:
Properties | |
---|---|
view.app | Link to global app instance |
view.el | View HTML element |
view.$el | Dom7 instance with view HTML element |
view.name | View name that was passed name parameter |
view.main | Boolean property indicating is it a main view or not |
view.routes | Array with available router's routes |
view.history | Array with view history |
view.params | Object with view initialization parameters |
view.router | View's initialized router instance |
Methods | |
view.destroy() | Destroy view instance |
view.on(event, handler) | Add event handler |
view.once(event, handler) | Add event handler that will be removed after it was fired |
view.off(event, handler) | Remove event handler |
view.off(event) | Remove all handlers for specified event |
view.emit(event, ...args) | Fire event on instance |
View Events
View will fire the following DOM events on view element and events on app and view instance:
View Dom Events
Event | Target | Description |
---|---|---|
view:init | View Element<div class="view"> | Event will be triggered on view initialization |
View Instance Events
View instance emits events on both self instance and app instance. App instance events has same names prefixed with view
.
Event | Target | Arguments | Description |
---|---|---|---|
init | view | (view) | Event will be triggered on view initialization |
viewInit | app |
Router API / Methods & Properties
View's main purpose is a navigating/routing between pages. We can access its router instance by view.router
. It has a lot of useful methods and properties to take control over routing and navigation:
Router Properties | |
---|---|
router.app | Link to global app instance |
router.view | Link to related View instance |
router.params | Object with router initialization parameters |
router.el | Router's view HTML element |
router.$el | Dom7 instance with router's view HTML element |
router.currentPageEl | Dom7 instance with current page HTML element |
router.routes | Array with available router's routes |
router.history | Array with router's view history |
router.cache | Object with router/view cache data |
router.currentRoute | Object with current route data. It has the following properties
|
router.previousRoute | Object with previously active route data. Same object format as currentRoute |
router.allowPageChange | Boolean property indicating is it allowed to change page / navigate or not |
Router Methods | |
router.navigate(url, options) | Navigate to (load) new page
|
router.navigate(parameters, options) | Navigate to (load) new page by parameters. This method allows to navigate to route by its name .
For example, if we have the following route:
We can navigate to it by calling:
If have more complex route with params:
Then it is mandatory to pass params as well:
|
router.back(url, options) | Go back to previous page, going back in View history
|
router.refreshPage() |
Refresh/reload current page. Actually same as:
|
router.clearPreviousHistory() | Clear router previous pages history and remove all previous pages from DOM |
router.clearPreviousPages() | Works mostly like clearPreviousHistory but only removes previous pages from DOM |
router.updateCurrentUrl(url) | Updates current route url, and updates `router.currentRoute` properties (query, params, hash, etc.) based on passed url. This method doesn't load or reload any content. It just changes current route url. |
router.on(event, handler) | Add event handler |
router.once(event, handler) | Add event handler that will be removed after it was fired |
router.off(event, handler) | Remove event handler |
router.off(event) | Remove all handlers for specified event |
router.emit(event, ...args) | Fire event on instance |
Linking Between Pages & Views
It may be not very comfortable to use router methods all the time to navigate between pages. In many cases we can just use links to navigate between pages. And we can pass additional navigation parameters using data-
attributes:
<!-- same as router.navigate('/somepage/'); -->
<a href="/somepage/">Some Page</a>
<!-- same as router.navigate('/somepage/', {reloadCurrent: true, animate: false}); -->
<a href="/somepage/" data-animate="false" data-reload-current="true">Some Page</a>
<!-- same as router.back(); -->
<a href="#" class="back">Go back</a>
<!-- same as router.back('/home/', {force: true, ignoreCache: true}); -->
<a href="/home/" data-force="true" data-ignore-cache="true" class="back">Go back</a>
Links default behavior:
- If link is in inside of not initialized view then it will load page in main view
- If link is in inside of initialized view then it will load page in this view (if other view is not specified in view's
linksView
parameter)
But if we need to load page in another view we can specify this view's CSS selector in link's data-view
attribute
<!-- left view -->
<div class="view view-init view-left" data-name="left">
...
<!-- will load "some-page" to main view -->
<a href="/some-page/" data-view=".view-main">Some Page</a>
...
</div>
<!-- main view -->
<div class="view view-init view-main">
...
<!-- will load "another-page" to left view -->
<a href="/another-page/" data-view=".view-left">Another Page</a>
...
</div>
Router Events
Router has a lot of useful events.
Router Dom Events
Router will fire the following DOM events for swipe back pages:
Event | Target | Description |
---|---|---|
swipeback:move | View Element<div class="view"> | Event will be triggered during swipe back move |
swipeback:beforechange | View Element<div class="view"> | Event will be triggered right before swipe back animation to previous page when you release it |
swipeback:afterchange | View Element<div class="view"> | Event will be triggered after swipe back animation to previous page when you release it |
swipeback:beforereset | View Element<div class="view"> | Event will be triggered right before swipe back animation to current page when you release it |
swipeback:afterreset | View Element<div class="view"> | Event will be triggered after swipe back animation to current page when you release it |
Router Instance Events
Router events bubble to View instance and to the App instance, so the event emitted on router instance will also be avaiable on view and on app instances:
Event | Arguments | Description |
---|---|---|
routeChange | (newRoute, previousRoute, router) | Event will be fired on current route change |
routeChanged | (newRoute, previousRoute, router) | Event will be fired on current route change and after page transitions |
routeUrlUpdate | (newRoute, router) | Event will be fired when router.updateCurrentUrl method called |
XHR Events | ||
routerAjaxStart | (xhr, options) | Event will be fired after router XHR opened and before XHR send. Can be used to modify the XHR object before it is sent. Use this callback to set custom headers, etc. As an arguments receives XHR object and navigating options object |
routerAjaxSuccess | (xhr, options) | Event will be fired when the request succeeds. As an arguments receives XHR object and navigating options object |
routerAjaxError | (xhr, options) | Event will be fired if the request fails. As an arguments receives XHR object and navigating options object |
routerAjaxComplete | (xhr, options) | Event will be fired when the request finishes. As an arguments receives XHR object and navigating options object |
Swipe Back Events | ||
swipebackMove | (data) | Event will be triggered during swipe back move. data contains object with the following properties: percentage , currentPageEl , previousPageEl , currentNavbarEl , previousNavbarEl |
swipebackBeforeChange | (data) | Event will be triggered right before swipe back animation to previous page when you release it. data contains object with the following properties: currentPageEl , previousPageEl , currentNavbarEl , previousNavbarEl |
swipebackAfterChange | (data) | Event will be triggered after swipe back animation to previous page when you release it. data contains object with the following properties: currentPageEl , previousPageEl , currentNavbarEl , previousNavbarEl |
swipebackBeforeReset | (data) | Event will be triggered right before swipe back animation to current page when you release it. data contains object with the following properties: currentPageEl , previousPageEl , currentNavbarEl , previousNavbarEl |
swipebackAfterReset | (data) | Event will be triggered after swipe back animation to current page when you release it. data contains object with the following properties: currentPageEl , previousPageEl , currentNavbarEl , previousNavbarEl |
Page Events | ||
pageMounted | (pageData) | Event will be triggered when new page just inserted to DOM. Or when page with keepAlive route is mounted/attached to DOM. As an argument event receives Page Data |
pageInit | (pageData) | Event will be triggered after Router initialize required page's components and navbar. As an argument event receives Page Data |
pageReinit | (pageData) | This event will be triggered in case of navigating to the page that was already initialized. As an argument event receives Page Data |
pageBeforeIn | (pageData) | Event will be triggered when everything initialized and page is ready to be transitioned into view (into active/current position). As an argument event receives Page Data |
pageAfterIn | (pageData) | Event will be triggered after page transitioned into view. As an argument event receives Page Data |
pageBeforeOut | (pageData) | Event will be triggered right before page is going to be transitioned out of view. As an argument event receives Page Data |
pageAfterOut | (pageData) | Event will be triggered after page transitioned out of view. As an argument event receives Page Data |
pageBeforeUnmount | (pageData) | Event will be triggered when page with keepAlive route is going to be unmounted/detached from DOM. As an argument event receives Page Data |
pageBeforeRemove | (pageData) | 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. As an argument event receives Page Data. This event won't be triggered for keepAlive routes. |
Routable Tabs Events | ||
tabInit tabMounted |
(newTabEl, tabRoute) | Event will be triggered right after routable Tab content will be loaded. As an argument event handler receives:
|
tabBeforeRemove | (oldTabEl, newTabEl, tabRoute) | Event will be triggered right after routable Tab content will be loaded. As an argument event handler receives:
|
Routable Modals Events | ||
modalInit modalMounted |
(modalEl, modalRoute, modal) | Event will be triggered right after routable modal content will be loaded and added to DOM. As an argument event handler receives:
|
modalBeforeRemove | (modalEl, modalRoute, modal) | Event will be triggered right before routable modal will be removed from DOM and destroyed. As an argument event handler receives:
|
View Auto Initialization
If you don't need to use View API and your View is inside of DOM on a moment of app initialization then it can be auto initialized with just adding additional view-init
class:
<!-- Add view-init class -->
<div class="view view-init">
...
</div>
But what about View parameters. In this case we may pass them in data-
attributes.
Parameters that used in camelCase, for example pushState
, in data- attributes should be used as kebab-case as data-push-state
<!-- view parameters in data- attributes -->
<div class="view view-init" data-url="/" data-name="home" data-push-state="true">
...
</div>
In this case if you need to access created View instance you can use:
- In case if it is main view, we may use
app.views.main
to get main view instance - Otherwise, we can access it by passed
name
parameter likeapp.views.home
<!-- main view -->
<div class="view view-main view-init">
...
</div>
<!-- another view -->
<div class="view view-init" data-name="home">
...
</div>
var mainView = app.views.main;
var homeView = app.views.home;
Initial Page Route
Initial page can also be loaded correctly using Routes. In app layout we must leave View blank:
<body>
<div id="app">
<div class="view view-main"></div>
</div>
</body>
In routes we may specify "home" route, for example:
routes: [
{
path: '/',
url: './home.html'
},
...
]
And when we init the View, we need to specify it is default URL:
app.views.create('.view-main', {
url: '/'
})
That is all, now on app load, home page content will be loaded from "home.html" file.