🔥 Meet Our New Project: t0ggles - Your Ultimate Project Management Tool!

Page Svelte Component

Page in Framework7 has the same meaning as when you think about web pages. Page is the main component to display and operate content.

Page Svelte component represents Framework7's Page.

Page Components

There are following components included:

Page Properties

<Page> properties
namestringPage name
messagesContentbooleanEnable if you use Messages component inside to add required extra styling
pageContentbooleantrueWhen enabled it automatically adds page-content element inside. Useful to disable when you need to use few page-content elements for tabs
tabsbooleanEnable if you use Page as Tabs wrapper
loginScreenbooleanEnable if you use Login Screen inside of the page to add required extra styling
noSwipebackbooleanDisables swipeback feature for the current page (affects iOS theme only)
withSubnavbarbooleanEnable if you have Sub Navbar inside of the page
noNavbarbooleanEnable if you use common Navbar layout and need to hide common Navbar (or use another one) for this page (affects iOS theme only)
noToolbarbooleanEnable if you use common Toolbar/Tabbar layout and need to hide Toolbar (or use another one) for this page
hideBarsOnScrollbooleanHide Navbar & Toolbar on page scroll
hideNavbarOnScrollbooleanHide Navbar on page scroll
hideToolbarOnScrollbooleanHide Toolbar on page scroll
ptrbooleanEnables Pull To Refresh
ptrDistancenumberCustom pull to refresh trigger distance. By default (if not specified) it is 44px.
ptrPreloaderbooleantrueDisable if you want to use custom pull to refresh preloader element
ptrBottombooleanfalseEnables pull to refresh from bottom
ptrMousewheelbooleanfalseEnables pull to refresh with mousewheel (for desktop apps). Works only for PTR top
infinitebooleanEnables Infinite Scroll
infiniteTopbooleanEnables infinite scroll on top of the page
infiniteDistancenumberDistance from the bottom of page (in px) to trigger infinite scroll event. By default (if not specified), it is 50 (px)
infinitePreloaderbooleantrueDisable if you want to use custom infinite-scroll preloader
<PageContent> properties
tabbooleanEnable if you use page-content as Tab
tabActivebooleanEnable if the current tab is active
Same as <Page> properties

Page Events

<Page> events
pageMountedEvent will be triggered when page with keepAlive route is mounted/attached to DOM
pageInitEvent will be triggered after Framework7 initialize required page's components and navbar
pageReinitThis event will be triggered in case of navigating to the page that was already initialized.
pageBeforeInEvent will be triggered when everything initialized and page is ready to be transitioned into view (into active/current position)
pageAfterInEvent will be triggered after page transitioned into view
pageBeforeOutEvent will be triggered right before page is going to be transitioned out of view
pageAfterOutEvent will be triggered after page transitioned out of view
pageBeforeUnmountEvent will be triggered when page with keepAlive route is going to be unmounted/detached from DOM
pageBeforeRemoveEvent 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.
pageTabShowEvent will be triggered when page's parent View as Tab becomes visible
pageTabHideEvent will be triggered when page's parent View as Tab becomes hidden
ptrPullStartEvent will be triggered when you start to move pull to refresh content
ptrPullMoveEvent will be triggered during you move pull to refresh content
ptrPullEndEvent will be triggered when you release pull to refresh content
ptrRefreshEvent will be triggered when pull to refresh enters in "refreshing" state
ptrDoneEvent will be triggered after pull to refresh is done and it is back to initial state (after calling pullToRefreshDone method)
infiniteEvent will be triggered when page scroll reaches specified (in data-distance attribute) distance to the bottom.
<PageContent> events
tabShowEvent will be triggered when Tab becomes visible/active
tabHideEvent will be triggered when Tab becomes hidden/inactive
Same as <Page> events

Page Slots

Page Svelte component (<Page>) has additional slots for custom elements:

  <div slot="fixed">Fixed element</div>
  <p>Page content goes here</p>

<!-- Renders to: -->

<div class="page">
  <div>Fixed element</div>
  <div class="page-content">
    <p>Page content goes here</p>


Infinite Scroll

  import { Navbar, Page, BlockTitle, List, ListItem } from 'framework7-svelte';

  let items = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20];
  let allowInfinite = true;
  let showPreloader = true;

  function loadMore() {
    if (!allowInfinite) return;
    allowInfinite = false;

    setTimeout(() => {
      if (items.length >= 200) {
        showPreloader = false;

      const itemsLength = items.length;

      for (let i = 1; i <= 20; i += 1) {
        items.push(itemsLength + i);

      items = items;
      allowInfinite = true;
    }, 1000);

<Page infinite infiniteDistance={50} infinitePreloader={showPreloader} onInfinite={loadMore}>
  <Navbar title="Infinite Scroll" />
  <BlockTitle>Scroll bottom</BlockTitle>
  <List strongIos outlineIos dividersIos>
    {#each items as item, index (index)}
      <ListItem title={`Item ${item}`} />

Pull To Refresh

  import { Navbar, Page, List, ListItem, BlockFooter } from 'framework7-svelte';

  let items = [
      title: 'Yellow Submarine',
      author: 'Beatles',
      cover: 'https://cdn.framework7.io/placeholder/abstract-88x88-1.jpg',
      title: "Don't Stop Me Now",
      author: 'Queen',
      cover: 'https://cdn.framework7.io/placeholder/abstract-88x88-2.jpg',
      title: 'Billie Jean',
      author: 'Michael Jackson',
      cover: 'https://cdn.framework7.io/placeholder/abstract-88x88-3.jpg',
  const songs = ['Yellow Submarine', "Don't Stop Me Now", 'Billie Jean', 'Californication'];
  const authors = ['Beatles', 'Queen', 'Michael Jackson', 'Red Hot Chili Peppers'];

  function loadMore(done) {
    setTimeout(() => {
      const picURL = `https://cdn.framework7.io/placeholder/abstract-88x88-${
        Math.floor(Math.random() * 10) + 1
      const song = songs[Math.floor(Math.random() * songs.length)];
      const author = authors[Math.floor(Math.random() * authors.length)];
        title: song,
        cover: picURL,
      items = items;

    }, 1000);

<!-- svelte-ignore a11y-missing-attribute -->
<Page ptr ptrMousewheel={true} onPtrRefresh={loadMore}>
  <Navbar title="Pull To Refresh" />
  <List mediaList strongIos dividersIos outlineIos>
    {#each items as item, index (index)}
      <ListItem title={item.title} subtitle={item.author}>
        <img slot="media" src={item.cover} width="44" style="border-radius: 8px" />
      Just pull page down to let the magic happen.<br />Note that pull-to-refresh feature is
      optimised for touch and native scrolling so it may not work on desktop browser.