Panel / Side Panels

Let’s look how to add Side Panels to our App. We may include up to 2 panels to our App, one on left side and another one on right side. We should add panels’ HTML right in the beginning of the app root element (or in case there is no root element in use):

Panel Effect

After we added panels we need to choose opening effect for each panel. There could be one of two effects: “Reveal” (when panel moves out whole app’s content) or “Cover” (when panel overlays app’s content). If you want to use “Reveal” effect you should add additional class to Panel, or **panel-cover** for cover effect:

<body>
  <!-- App root element -->
  <div id="app">
    <!-- Left panel, let it be with reveal effect -->
    <div class="panel panel-left panel-reveal">
        ... panel content goes here ...
    </div>
    <!-- Right panel, with cover effect -->
    <div class="panel panel-right panel-cover">
        ... panel content goes here ...
    </div>
    ...
  </div>
</body>

Panel App Parameters

It is possible to control some default panels behavior using global app parameters by passing panels related parameters under panel parameter:

For example:

Let’s look at related App methods to work with Panel:

app.panel.open(side, animate)- open panel

side - string. Panel to open: “left” or “right”. Required in case you have two panels.
animate - boolean. Should it be opened with animation or not. Optional, by default is true

app.panel.close(side, animate)- close panel

side - string. Panel to close. Optional, by default will close any opened panel.
animate - boolean. Should it be opened with animation or not. Optional, by default is true

app.panel.create(parameters)- create new panel instance

parameters - object. Object with panel parameters.

Method returns created Panel instance

app.panel.get(side)- get Panel instance by specified side

side - string. Panel to get

Method returns Panel instance

app.panel.enableSwipe(side)- enable swipes for panel (swipe-to-close and swipe-to-open)

side - string. Panel to enable swipe actions on

app.panel.disableSwipe(side)- disable swipes for panel (swipe-to-close and swipe-to-open)

side - string. Panel to disable swipe actions on

app.panel.left- left panel instance

app.panel.right- right panel instance

Panel Parameters

If we create Panel manually using app.panel.create method we need to pass object with panel parameters:

For example:

var panel = app.panel.create({
  el: '.panel-left',
})

Panel Methods & Properties

After we created Panel instance (by calling app.panel.create) or after we got Panel instance (by calling app.panel.get) we may use its useful methods and properties:

To open panel we need to add **panel-open** class to any HTML element (prefered to link)
To close panel we need to add **panel-close** class to any HTML element (prefered to link)
If you want to specify which panel should opened/closed, then it could be done via additional **data-panel="left** attribute on this HTML element

According to above note:

Routable Panels

Routable Panels available from Framework7 version 3.2.0.

Panels can also be routable with same features as for routable modals and pages:

it provides opportunity to open Panel by usual links instead of so called special links or API,
with enabled Push State, the same Panel will be opened when you refresh browser, navigate back and forward in history,
with routable Panels you can load Panel itself and its content in the same ways as for pages and modals, i.e. using , content, template, templateUrl, component or componentUrl

routes = [
  ...
  // Creates Panel from passed HTML string
  {
    path: '/left-panel/',
    panel: {
      content: `
        <div class="panel panel-left panel-cover">
          <div class="view">
            <div class="page">
              ...
            </div>
          </div>
        </div>
      `
    }
  },
  // Load Panel from file via Ajax
  {
    path: '/right-panel-ajax/',
    panel: {
      url: './right-panel.html',
      /* right-panel.html contains:
      <div class="panel panel-right panel-reveal">
        <div class="view">
          <div class="page">
            ...
          </div>
        </div>
      </div>
      */
    },
  },
  // Load Panel from component file
  {
    path: '/panel-component/',
    panel: {
      componentUrl: './panel-component.html',
      /* panel-component.html contains:
        <div class="panel panel-left panel-cover">
            <div class="page">
              ...
            </div>
          </div>
        </div>
      </template>
      <style>...</style>
      <script>...</script>
      */
    },
  },
]

According to example above:

when you click on link with /left-panel/ href attribute it will open Panel from specified string content,
when you click on link with /right-panel-ajax/ href attribute it will perform Ajax request to right-panel.html file and open it as a Right Panel,
when you click on link with /panel-component/ href attribute it will perform Ajax request to panel-component.html file, parse it as a Router Component and open it as a Panel,

Note that routable Panels can’t be mixed with static Panels. So if you have static left panel in the app, then only right panel can be loaded as routable panel.

Panel Events

App and Panel Instance Events

Panel instance emits events on both self instance and app instance. App instance events has same names prefixed with panel.

var app = new Framework7();
var $$ = Dom7;
// Dom Events
$$('.panel-left').on('panel:open', function () {
  console.log('Panel left: open');
});
$$('.panel-left').on('panel:opened', function () {
  console.log('Panel left: opened');
});
// Instance Events
var panelRight = app.panel.right;
panelRight.on('open', function () {
  console.log('Panel right: open');
});
panelRight.on('opened', function () {
  console.log('Panel right: opened');
});
// App Events
app.on('panelClose', function (panel) {
  console.log('Panel ' + panel.side + ': close');
});
app.on('panelClosed', function (panel) {
});