Dialog

Dialog is a small content pane that pops up over App’s main content. Dialogs are usualy used to ask something from a user, or to notify or warn a user. Dialog, as all other modals, is part of so called “Temporary Views”.

Dialog can only be opened by using JavaScript. So lets look at related App methods to work with dialogs.

Dialog App Methods

Lets look at related App methods to work with Dialog:

app.dialog.create(parameters)- create Dialog instance

• parameters - object. Object with dialog parameters

Method returns created Dialog’s instance

app.dialog.destroy(el)- destroy Dialog instance

• el - HTMLElement or string (with CSS Selector) or object. Dialog element or Dialog instance to destroy.

app.dialog.get(el)- get Dialog instance by HTML element

• el - HTMLElement or string (with CSS Selector). Dialog element.

Method returns Dialog’s instance

app.dialog.open(el, animate)- opens Dialog

• el - HTMLElement or string (with CSS Selector). Dialog element to open.
• animate - boolean. Open Dialog with animation.

Method returns Dialog’s instance

app.dialog.close(el, animate)- closes Dialog

• el - HTMLElement or string (with CSS Selector). Dialog element to close.
• animate - boolean. Close Dialog with animation.

Method returns Dialog’s instance

Dialog Parameters

Now lets look at list of available parameters we need to create Dialog:

var dialog = app.dialog.create({
  text: ‘Hello World’,
  on: {
    opened: function () {
      console.log(‘Dialog opened’)
    }
  }
})

Button Parameters

Each Button in buttons array must be presented as object with button parameters:

Dialog Methods & Properties

So to create a Dialog we have to call:

var dialog = app.dialog.create({ /* parameters */ })

After that we have its initialized instance (like dialog variable in example above) with useful methods and properties:

Dialog Events

Dialog will fire the following DOM events on dialog element and events on app and dialog instance:

DOM Events

App and Dialog Instance Events

Dialog instance emits events on both self instance and app instance. App instance events has same names prefixed with dialog.

Dialog Shortcuts

There are a few shortcut methods which that make creating dialogs much easier.

First lets check the global app parameters which help to configure such shortcuts and also used for localization purposes.

Dialog Shortcuts Parameters

The following global dialog shortcut parameters can be passed on app initialization under dialog property:

var app = new Framework7({
  dialog: {
    // set default title for all dialog shortcuts
    title: 'My App',
    // change default "OK" button text
    buttonOk: 'Done',
    ...
  }
});

Now lets look at available dialog shortcuts

Alert

To create Alert dialog we need to use the following app methods:

app.dialog.alert(text, title, callback)- create Alert Dialog and open it

• text - string. Alert dialog text
• title - string. Alert dialog title
• callback - function. Optional. Callback function that will be executed after user clicks on Alert button

Method returns created Dialog’s instance

app.dialog.alert(text, callback)- create Alert Dialog with default title and open it

Method returns created Dialog’s instance

Confirm

Confirm dialog is usualy used when it is required to confirm some action. To open the Confirm modal we should also call one of the following App methods:

app.dialog.confirm(text, title, callbackOk, callbackCancel)- create Confirm Dialog and open it

• text - string. Confirm dialog text
• title - string. Confirm dialog title
• callbackOk - function. Optional. Callback function that will be executed when user click “Ok” button on Confirm dialog (when user confirms action)
• callbackCancel - function. Optional. Callback function that will be executed when user click “Cancel” button on Confirm dialog (when user dismisses action)

Method returns created Dialog’s instance

app.dialog.confirm(text, callbackOk, callbackCancel)- create Confirm Dialog with default title and open it

Method returns created Dialog’s instance

Prompt

Prompt dialog is used when it is required to get some data/answer from user. To open Prompt dialog we should also call one of the following App methods:

app.dialog.prompt(text, title, callbackOk, callbackCancel, defaultValue)- create Prompt Dialog and open it

• text - string. Prompt dialog text
• title - string. Prompt dialog title
• callbackOk - function(value). Optional. Callback function that will be executed when user click “Ok” button on Prompt dialog. As an argument function receives value of text input
• callbackCancel - function(value). Optional. Callback function that will be executed when user click “Cancel” button on Prompt dialog. As an argument function receives value of text input
• defaultValue - string. Optional. Prompt input default value

app.dialog.prompt(text, callbackOk, callbackCancel, defaultValue)- create Prompt Dialog with default title and open it

Method returns created Dialog’s instance

Login

app.dialog.login(text, title, callbackOk, callbackCancel)- create Login Dialog and open it

• text - string. Login dialog text
• title - string. Login dialog title
• callbackOk - function(username, password). Optional. Callback function that will be executed when user click “Ok” button on Login dialog. As an argument function receives username and password values
• callbackCancel - function(username, password). Optional. Callback function that will be executed when user click “Cancel” button on Login dialog. As an argument function receives username and password values

app.dialog.login(text, callbackOk, callbackCancel)- create Login Dialog with default title and open it

Method returns created Dialog’s instance

Password

Password dialog is useful in case you need to request only the password

app.dialog.password(text, title, callbackOk, callbackCancel)- create Password Dialog and open it

• text - string. Password dialog text
• title - string. Password dialog title
• callbackOk - function(password). Optional. Callback function that will be executed when user click “Ok” button on Password dialog. As an argument function receives password value
• callbackCancel - function(password). Optional. Callback function that will be executed when user click “Cancel” button on Password dialog. As an argument function receives password value

app.dialog.password(text, callbackOk, callbackCancel)- create Password Dialog with default title and open it

Method returns created Dialog’s instance

Preloader

Preloader dialog is used to indicate some background activity (like Ajax request) and to block any user actions during this activity. To open Preloader dialog we should also call appropriate App method:

app.dialog.preloader(title, color)- create Preloader Dialog and open it

• title - string. Optional. Preloader dialog title
• color - string. Optional. Preloader color. One of the default colors

Method returns created Dialog’s instance

Progress

Same as Preloader dialog but with progressbar instead of preloader.

app.dialog.progress(title, progress, color)- create Progress Dialog and open it

• title - string. Optional. Progress dialog title
• progress - number. Optional. Progressbar progress (from 0 to 100). If no number passed then it will have infinite progressbar.
• color - string. Optional. Progressbar color. One of default colors

Method returns created Dialog’s instance

CSS Variables

Below is the list of related CSS variables (CSS custom properties).

Note that commented variables are not specified by default and their values is what they fallback to in this case.

:root {
  --f7-dialog-button-text-color: var(--f7-theme-color);
  --f7-dialog-button-text-align: center;
  --f7-dialog-input-bg-color: #fff;
}
.ios {
  --f7-dialog-bg-color: rgba(255, 255, 255, 0.95);
  --f7-dialog-box-shadow: none;
  --f7-dialog-width: 270px;
  --f7-dialog-inner-padding: 15px;
  --f7-dialog-border-radius: 13px;
  --f7-dialog-text-color: #000;
  --f7-dialog-text-align: center;
  --f7-dialog-font-size: 14px;
  --f7-dialog-title-text-color: inherit;
  --f7-dialog-title-font-size: 18px;
  --f7-dialog-title-font-weight: 600;
  --f7-dialog-title-line-height: inherit;
  --f7-dialog-button-font-size: 17px;
  --f7-dialog-button-height: 44px;
  --f7-dialog-button-letter-spacing: 0;
  --f7-dialog-button-font-weight: 400;
  --f7-dialog-button-text-transform: none;
  --f7-dialog-button-pressed-bg-color: rgba(230, 230, 230, 0.95);
  --f7-dialog-input-border-radius: 4px;
  --f7-dialog-input-font-size: 14px;
  --f7-dialog-input-height: 32px;
  --f7-dialog-input-border-color: rgba(0, 0, 0, 0.3);
  --f7-dialog-input-border-width: 1px;
  --f7-dialog-input-placeholder-color: #a9a9a9;
  --f7-dialog-preloader-size: 34px;
}
.md {
  --f7-dialog-bg-color: #fff;
  --f7-dialog-box-shadow: var(--f7-elevation-24);
  --f7-dialog-width: 280px;
  --f7-dialog-inner-padding: 24px;
  --f7-dialog-border-radius: 4px;
  --f7-dialog-text-color: #757575;
  --f7-dialog-text-align: left;
  --f7-dialog-font-size: 16px;
  --f7-dialog-title-text-color: #212121;
  --f7-dialog-title-font-size: 20px;
  --f7-dialog-title-font-weight: 500;
  --f7-dialog-title-line-height: 1.3;
  --f7-dialog-button-font-size: 14px;
  --f7-dialog-button-height: 36px;
  --f7-dialog-button-letter-spacing: 0.03em;
  --f7-dialog-button-font-weight: 500;
  --f7-dialog-button-text-transform: uppercase;
  --f7-dialog-button-pressed-bg-color: rgba(0, 0, 0, 0.1);
  --f7-dialog-input-border-radius: 0px;
  --f7-dialog-input-font-size: 16px;
  --f7-dialog-input-height: 36px;
  --f7-dialog-input-border-color: transparent;
  --f7-dialog-input-border-width: 0px;
  --f7-dialog-input-placeholder-color: rgba(0, 0, 0, 0.35);
  --f7-dialog-preloader-size: 32px;
}
.aurora {
  --f7-dialog-bg-color: #fff;
  --f7-dialog-box-shadow: 0 0 20px 0 rgba(0, 0, 0, 0.15), 0 25px 30px 0 rgba(0,0,0,0.35);
  --f7-dialog-width: 300px;
  --f7-dialog-inner-padding: 20px;
  --f7-dialog-border-radius: 4px;
  --f7-dialog-text-color: #000;
  --f7-dialog-text-align: left;
  --f7-dialog-font-size: 14px;
  --f7-dialog-title-text-color: inherit;
  --f7-dialog-title-font-size: 14px;
  --f7-dialog-title-font-weight: 700;
  --f7-dialog-title-line-height: inherit;
  --f7-dialog-button-text-color: #fff;
  --f7-dialog-button-font-size: 13px;
  --f7-dialog-button-height: 28px;
  --f7-dialog-button-letter-spacing: 0;
  --f7-dialog-button-font-weight: 500;
  --f7-dialog-button-text-transform: none;
  /*
  --f7-dialog-button-pressed-bg-color: var(--f7-theme-color-shade);
  */
  --f7-dialog-input-border-radius: 4px;
  --f7-dialog-input-font-size: 13px;
  --f7-dialog-input-height: 24px;
  --f7-dialog-input-border-color: rgba(0, 0, 0, 0.12);
  --f7-dialog-input-border-width: 1px;
  --f7-dialog-input-placeholder-color: rgba(0, 0, 0, 0.32);
  --f7-dialog-preloader-size: 24px;
}

Examples

<body>
  ...
    <div class="page-content">
      <div class="block block-strong">
        <p class="row">
          <button class="col button open-alert">Alert</button>
          <button class="col button open-confirm">Confirm</button>
          <button class="col button open-prompt">Prompt</button>
        </p>
        <p class="row">
          <button class="col button open-login">Login</button>
          <button class="col button open-password">Password</button>
        </p>
      </div>
      <div class="block-title">Vertical Buttons</div>
      <div class="block block-strong">
        <p>
          <button class="button open-vertical">Vertical Buttons</button>
        </p>
      </div>
      <div class="block-title">Preloader Dialog</div>
      <div class="block block-strong">
        <p class="row">
          <button class="col button open-preloader">Preloader</button>
          <button class="col button open-preloader-custom">Custom Title</button>
        </p>
      </div>
      <div class="block-title">Progress Dialog</div>
      <div class="block block-strong">
        <p class="row">
          <button class="col button open-progress">Determined</button>
          <button class="col button open-progress-infinite">Infinite</button>
        </p>
      </div>
    </div>
  ...
</body>

var app = new Framework7();
var $$ = Dom7;
// Alert
$$('.open-alert').on('click', function () {
  app.dialog.alert('Hello');
});
// Confirm
$$('.open-confirm').on('click', function () {
  app.dialog.confirm('Are you feel good today?', function () {
    app.dialog.alert('Great!');
  });
});
// Prompt
$$('.open-prompt').on('click', function () {
  app.dialog.prompt('What is your name?', function (name) {
    app.dialog.confirm('Are you sure that your name is ' + name + '?', function () {
      app.dialog.alert('Ok, your name is ' + name);
    });
  });
});
// Login
$$('.open-login').on('click', function () {
  app.dialog.login('Enter your username and password', function (username, password) {
    app.dialog.alert('Thank you!<br>Username:' + username + '<br>Password:' + password);
  });
});
// Password
$$('.open-password').on('click', function () {
  app.dialog.password('Enter your username and password', function (password) {
    app.dialog.alert('Thank you!<br>Password:' + password);
  });
});
// Vertical Buttons
$$('.open-vertical').on('click', function () {
  app.dialog.create({
    title: 'Vertical Buttons',
    text: 'Dialog with vertical buttons',
    buttons: [
      {
        text: 'Button 1',
      },
      {
        text: 'Button 2',
      },
      {
        text: 'Button 3',
      },
    ],
    verticalButtons: true,
  }).open();
});
// Preloader
$$('.open-preloader').on('click', function () {
  app.dialog.preloader();
  setTimeout(function () {
    app.dialog.close();
  }, 3000);
});
// Preloader with custom text
$$('.open-preloader-custom').on('click', function () {
  app.dialog.preloader('My text...');
  setTimeout(function () {
    app.dialog.close();
  }, 3000);
});
// Progress
$$('.open-progress').on('click', function () {
  var progress = 0;
  var dialog = app.dialog.progress('Loading assets', progress);
  dialog.setText('Image 1 of 10');
  var interval = setInterval(function () {
    progress += 10;
    dialog.setProgress(progress);
    dialog.setText('Image ' + ((progress) / 10) + ' of 10');
    if (progress === 100) {
      clearInterval(interval);
      dialog.close();
    }
  }, 300)
});
// Progress Infinite
$$('.open-progress-infinite').on('click', function () {
  app.dialog.progress();
  setTimeout(function () {
    app.dialog.close();
  }, 3000);
});