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

Photo Browser Svelte Component

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

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

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

Photo Browser Component

There are following components included:

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:

<PhotoBrowser> properties
initbooleantrueInitializes Photo Browser
paramsObjectObject with Photo Browser parameters
photosarray[]Array with URLs of photos or array of objects with "url" (or "html") and "caption" properties.
thumbsarray[]Array with URLs of thumbs images. Will not render thumbs if not specified, or empty array
urlstringphotos/Photo browser modal URL that will be set as a current route
routableModalsbooleanfalseWill 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
swiperobjectObject with Swiper parameters. By default equals to:
swiper: {
  initialSlide: 0,
  spaceBetween: 20,
  speed: 300,
  loop: false,
  preloadImages: true,
  keyboard: {
    enabled: true,
  navigation: {
    nextEl: '.photo-browser-next',
    prevEl: '.photo-browser-prev',
  zoom: {
    enabled: true,
    maxRatio: 3,
    minRatio: 1,
  lazy: {
    enabled: true,
virtualSlidesbooleantrueWhen enabled then Swiper will use Virtual Slides
closeByBackdropClickbooleantrueWhen enabled, Photo Browser popup will be closed on backdrop click
expositionbooleantrueEnable disable exposition mode when clicking on Photo Browser.
expositionHideCaptionsbooleanfalseSet to true if you also want to hide captions in exposition mode
swipeToClosebooleantrueYou can close Photo Browser with swipe up/down when this parameter is enabled
typestringstandaloneDefine 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).
themestringlightPhoto Browser color theme, could be light or dark
captionsThemestringCaptions color theme, could be also dark or light. By default, equal to "theme" parameter
navbarbooleantrueSet to false to remove Photo Browser's Navbar
toolbarbooleantrueSet to false to remove Photo Browser's Toolbar
pageBackLinkTextstringBackText on back link in Photo Browser's navbar
popupCloseLinkTextstringCloseText on close link in Photo Browser's navbar when opened in Popup or as Standalone
navbarShowCountbooleanundefinedDefines should it display "3 of 5" text in navbar title or not. If not specified (undefined) then it will show this text if there is more than 1 item
navbarOfTextstringofText of "of" in photos counter: "3 of 5"
iconsColorstringOne of the default colors

Photo Browser Events

<PhotoBrowser> events
photoBrowserOpenEvent will be triggered on Photo Browser open.
photoBrowserOpenedEvent will be triggered after Photo Browser completes its opening animation
photoBrowserCloseEvent will be triggered on Photo Browser close.
photoBrowserClosedEvent will be triggered after Photo Browser completes its closing animation
photoBrowserSwipeToCloseThis 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 bind:this):

<PhotoBrowser> 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 calling .instance() component's method. For example:

<PhotoBrowser bind:this={component}>...</PhotoBrowser>

  let component;

  // to get instance in some method


  import { Navbar, Page, PhotoBrowser, Block, Button } from 'framework7-svelte';

  let standalone;
  let popup;
  let page;

  let standaloneDark;
  let popupDark;
  let pageDark;

  const photos = [
      url: 'img/beach.jpg',
      caption: 'Amazing beach in Goa, India',
      url: 'img/monkey.jpg',
      caption: 'I met this monkey in Chinese mountains',
      url: 'img/mountains.jpg',
      caption: 'Beautiful mountains in Zhangjiajie, China',

  const thumbs = [

  <Navbar title="Photo Browser" />
  <Block strongIos outlineIos>
      Photo Browser is a standalone and highly configurable component that allows to open window
      with photo viewer and navigation elements with the following features:
      <li>Swiper between photos</li>
      <li>Multi-gestures support for zooming</li>
      <li>Toggle zoom by double tap on photo</li>
      <li>Single click on photo to toggle Exposition mode</li>
  <Block strongIos outlineIos>
      Photo Browser could be opened in a three ways - as a Standalone component (Popup
      modification), in Popup, and as separate Page:
    <div class="grid grid-cols-3 grid-gap">
        <PhotoBrowser {photos} {thumbs} bind:this={standalone} />
        <Button fill onClick={() => standalone.open()}>Standalone</Button>
        <PhotoBrowser {photos} {thumbs} type="popup" bind:this={popup} />
        <Button fill onClick={() => popup.open()}>Popup</Button>
        <PhotoBrowser {photos} {thumbs} type="page" pageBackLinkText="Back" bind:this={page} />
        <Button fill onClick={() => page.open()}>Page</Button>
  <Block strongIos outlineIos>
      Photo Browser supports 2 default themes - default Light (like in previous examples) and Dark
      theme. Here is a Dark theme examples:
    <div class="grid grid-cols-3 grid-gap">
        <PhotoBrowser {photos} {thumbs} theme="dark" bind:this={standaloneDark} />
        <Button fill onClick={() => standaloneDark.open()}>Standalone</Button>
        <PhotoBrowser {photos} {thumbs} theme="dark" type="popup" bind:this={popupDark} />
        <Button fill onClick={() => popupDark.open()}>Popup</Button>
        <Button fill onClick={() => pageDark.open()}>Page</Button>