Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for application developers who want to provide one or more menus for application users.

Overview

You can add menus to help the users of your Application or Stream View.

When you create an application, PhixFlow automatically creates an empty menu item in the repository. When you add an menu items to this menu and refresh the browser window, PhixFlow displays the menu(s) for the loaded application. 

For applications that are designed for use on both PCs and mobile devices, consider the usability of your menu on a small screen. A single menu may work in both form-factors. However, it can be helpful to have an alternative menu for mobile display. 

To specify a default menu for an application, In the repository, right-click on it the menu name and select:

  • either Make Default Desktop Menu
  • or Make Default Mobile Menu.

To specify an alternative menu to display instead of the default, provide users with a URL to the application that specifies the alternative menu.

Adding Menu Items to the Repository

To add menu items, in the repository for your application, find the Menus branch. For a new application there is always one menu item, which is created by Phixflow when you create the application.

...

Insert excerpt
_Banners
_Banners
nameproperties
nopaneltrue

Insert excerpt
_

...

property_tabs

...

_property_tabs
namebasic-h
nopaneltrue

...

Insert excerpt
_

...

parent
_

...

parent
nopaneltrue

...

  • Add a new sub-menu
  • Add a new menu item 

...

When you have selected an action, PhixFlow shows the name that will appear in the menu bar or menu.  To change the display name, 

find the action in the repository

...

Basic Settings

FieldDescription
Name

Only available for the top-level menu item and sub-menu items.

The structure of the menu items in the repository reflects the menu structure you have created, for example:

Image Removed

  • Top-level menu
    Top of a tree of menus in the repository. The menu items listed in the top-level menu populates the menu bar at the top of the screen. The top-level menu does not have a display name because it acts as a container for the menus, rather than being a menu option itself.
  • Menu options
    Menu options are associated with an action. Actions are often linked to underlying streams. When a use clicks the option PhixFlow runs the action. For example, if your application has a form to which a user can add data, the menu option "Save Changes" would save the data to the underlying stream.
  • Sub-menu:
    A sub-menu contains more menu options. It is not associated with an action.

You can add 

  • top-level menu items
  • sub-menus
  • sub-menu items

PhixFlow displays menu options on the menu bar. 

Image Removed

Menu Properties

...

For each top level application menu, the following fields are configured:

...

Enter the repository name for the menu item.

Display Name

You can only enter a display name for sub-menus. Enter the sub-menu name for PhixFlow to display either on the menu bar or in another menu.

For menu options, PhixFlow shows the display name inherited from the action. To change the action's display name, 

  1. Find the action in the repository.
  2. Change the action properties Basic Settings → Display Name.
Order

Enter the order in which the menu will appear, either on the menu bar or in the sub-menu list. PhixFlow reorganises existing entries if you add an order that is already in use. 

The order for menu items is:

  • On the menu bar, left to right, with the last option aligned to the right of the screen.
  • In a sub-menu, top to bottom in the list.
Default Action

...

Only available for the top-level menu item. Optionally, select an action that will run when the menu is opened.
ActionOnly available for menu options. Select an action that will run when the user clicks the option in the menu.
Hide the Menu Bar

Only available for the top-level menus.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to display the menu bar at the top of your application

...

; see Design and Application Mode for screenshots showing the default menu bar.

Insert excerpt
_check_box_

...

tick
_check_box_

...

tick
nopaneltrue
 to hide the menu bar. Use this option for a cleaner look to your application if it does not require menu options for the user.

...

You can have a different setting for default desktop and default mobile menus.


HTML Comment
hiddentrue

Menu Items

This section is available

...

when Hide the Menu Bar is not ticked.

...

The grid shows the list of menu items

...

Order - the order in which items appear 

either on the menu bar. 1 means the option appears at the right of the line of the menu options. The highest number order appears on the far left of the menu bar

or in a sub-menu, the order in the list, with 1 at the top.

...

, including their:

  • Order
  • List: ticked indicates a sub-menu

...

  • Name
  • Display Name
  • Description

To add sub-menus and menu items

...

In stream views and under top level application menus, you can create sub-menus and menu items. Menu items make actions available to users on forms.

The following fields are configured for menu items:

...

The order in which the menu items will be presented

...

, use the 

Insert excerpt
_new
_new
nopaneltrue
 button in the section toolbar; see Adding Menu Options, above.

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Learn More