When should I use a modal versus an overpanel?

Updated:

Related pages: showOverpanel, showModal

To start, let's define some terms:


Modal

A simplistic user dialog the platform presents as information to the user, and may optionally collect simple user feedback, such as "accept" vs. "cancel", as provided by the platform.


Overpanel

A complex user dialog which loads a tecton extension which is intended as an overlay style workflow, the function of which is provided by the extension developer.


Use Modals for purposes such as:

  • The application needs to display information in the basic forms available to the platform's modal interface. These generally consist of a simple message or list of messages, and/or a list of basic information about events such as transactions.
  • The application needs to collect a simple choice from a user via the use of buttons signifying the user's choice.
  • Examples:
    • A dialog to confirm or cancel a transaction prior to submitting it
    • A dialog that asks the user a question with up to 3 possible answers, such as a warning which asks before closing a workflow if the user would like to save, "close" without "saving," or "cancel."

Use Overpanels for purposes such as:

  • A complex workflow requiring user input beyond just "what button was pressed" (eg. user text / number / date input)
  • Custom presentation of data beyond what is provided by the platform
  • Buttons that deliver custom actions, not necessarily closing the overlay
  • Examples:
    • In a user management extension, pressing the "add user" button launches a custom workflow overlay to do just that
    • In the same user management extension, clicking on an existing user launches a custom overlay presenting complex data about that user, even offering edit capability.