Photo Browser Vue Component

Photo Browser is an photo browser component to display collection of photos / images. Photos can be zoomed and panned (optional).

Photo Browser Vue component represents Framework7's Photo Browser component.

Photo Browser Vue component doesn't render any output. It can be used to create JS Photo Browser instance and control it inside of your Vue component.

Photo Browser Component

There are following components included:

  • f7-photo-browser

Photo Browser Properties

You can pass all parameters in single params property or use separate props for each parameter to specify them via component properties:

Prop Type Default Description
<f7-photo-browser> properties
init boolean true Initializes Photo Browser
params Object Object with Photo Browser parameters
photos array [] Array with URLs of photos or array of objects with "url" (or "html") and "caption" properties.
url string photos/ Photo browser modal URL that will be set as a current route
routable-modals boolean true Will add opened photo browser to router history which gives ability to close photo browser by going back in router history and set current route to the photo browser modal
swiper object Object with Swiper parameters. By default equals to:
swiper: {
  initialSlide: 0,
  spaceBetween: 20,
  speed: 300,
  loop: false,
  preloadImages: true,
  navigation: {
    nextEl: '.photo-browser-next',
    prevEl: '.photo-browser-prev',
  zoom: {
    enabled: true,
    maxRatio: 3,
    minRatio: 1,
  lazy: {
    enabled: true,
virtualSlides boolean true When enabled then Swiper will use Virtual Slides
exposition boolean true Enable disable exposition mode when clicking on Photo Browser.
exposition-hide-captions boolean false Set to true if you also want to hide captions in exposition mode
swipe-to-close boolean true You can close Photo Browser with swipe up/down when this parameter is enabled
type string standalone Define how Photo Browser should be opened. Could be standalone (will be opened as an overlay with custom transition effect), popup (will be opened as popup), page (will be injected to View and loaded as a new page).
theme string light Photo Browser color theme, could be light or dark
captions-theme string Captions color theme, could be also dark or light. By default, equal to "theme" parameter
navbar boolean true Set to false to remove Photo Browser's Navbar
toolbar boolean true Set to false to remove Photo Browser's Toolbar
back-link-text string Close Text on back link in Photo Browser's Navbar
navbar-of-text string of Text of "of" in photos counter: "3 of 5"
icons-color string One of the default colors

Photo Browser Events

Event Description
<f7-photo-browser> events
photobrowser:open Event will be triggered on Photo Browser open.
photobrowser:opened Event will be triggered after Photo Browser completes its opening animation
photobrowser:close Event will be triggered on Photo Browser close.
photobrowser:closed Event will be triggered after Photo Browser completes its closing animation
photobrowser:swipetoclose This event will be triggered when user close Photo Browser with swipe up/down.

Photo Browser Methods

The following Photo Browser components methods are available (e.g. by accesing it via $refs):

<f7-photo-browser> methods
.open(index); Open Photo Browser on photo with index number equal to "index" parameter. If "index" parameter is not specified, it will be opened on last closed photo.
.close(); Close Photo Browser
.expositionToggle(); Toggle exposition mode
.expositionEnable(); Enable exposition mode
.expositionDisable(); Disable exposition mode

Access To Photo Browser Instance

You can access Photo Browser initialized instance by accessing .f7PhotoBrowser component's property.


Here is how it can be used in Vue component and how to control it:


  <!-- Photo Browser -->

  <!-- Link To Open PB -->
  <f7-link @click="openPhotoBrowser">Photos</f7-link>


  export default {
    data: function () {
      return {
        photos: [
            url: 'path/to/picture-1.jpg',
            caption: 'Picture 1'
            url: 'path/to/picture-2.jpg',
            caption: 'Picture 2'
    methods: {
      openPhotoBrowser: function () {
      onOpen: function () {
        console.log('Photo Browser is opened')