Skip to content

Setting up navigation

Navigation is defined separately for web and mobile but the structure is the same.

{
    "primary": [
        ... entry ...
    ],
    "secondary": [
        ... entry ...
    ],
    "options": { .. options ... },
    "background: []
}

Options

Entries

  • target: Enumeration - valid target
  • title: String - title to appear in the menu
  • icon: String - icons from latest version of https://fontawesome.com
  • name: String - unqiue name when targets are duplicated
  • options: Object - based on target
  • condition: Condition rule

Targets

Target Description Documentation
stream Display a stream of dispatch data See Stream
join Allow users to enter a join code
calendar Calendar view with dispatch data See Calendar
page Markup language page See Page
chat Main chat entry --
chart Chart explorer --
grid Grid with dispatch data See Grid
page-grid Grid with dispatch data and layouts See Page grid
page-search Similar to page grid See PageSearch
roster User list based on viewers security See Roster
script A form for executing a script See Script
link Open an external URL See Link
notebooks Root level wiki pages See Wiki
wiki Specific wiki page See Wiki
schedule Allows the user to configure a recurrent dispatch --
catalog Displays the program catalog --
relations Displays the current user's related users See Relations
post Works the same as the post shortcut See Post
icalendar-links iCalendar links available for the user See iCalendar
query-carousel Display a carousel based on provided query it's based on dispatches and users results See Query Carousel
program-popup Display a Program Popup based on variant See Program Popup
calendar-carousel Display touch friendly date carousel See Calendar Carousel
background-carousel Display a Carousel with background image. See Background Carousel
dispatch-carousel Display a Carousel with using dispatches and configurable layouts. See Dispatch Carousel
user-admin Allow to a find users and create user within an org --
droplets Display a specific droplets See Droplets
video Display a video with twilio-video --
System Display a system/Org management screen or system information --
Admin Display an org admin management screen --
create-related-user Create a relation with user that org --
create-relation Create a relation by searching the users --
designer-creation Display a wizard for Designer Program Design --
program-creation Display a wizard for Program --
storybook Display a list of layout within an org --
action Display a component based on actions See Action
inbox
outbox
open-programs-dashboard Display a dashboard for programs --
user-program-dashboard Display a program dashboard for provided query See user program dashboard
programs-dashboard Display an all program dashboard --
all-programs Display a program all programs history view See AllPrograms
programs-list Display users all programs history view See Program list
programs Display a Program history with a catalog and upcoming programs details --
experimental Display a program carousel with a clipboard See Experimental
schedule Allow user to add and view their schedule --
content Display various component based on passed params --
programBrowser Display a program carousel with animated shape See programBrowser
dashboard Display dashboard with timeline view with provided a layout See dashboard
notifications Global notification --
profile Display a current user profile screen --
orgs Display a user organization with pinned organization feature See Orgs

Paths

These targets require an additional path parameter.

Target Description Required fields
user/<user id> User custom page

System targets

These targets are supplied automatically. They can be removed using blacklist.

Target Description Required fields
about About
profile User profile
inbox User inbox

Native targets

These targets work only on mobile and require additional org authorization to function.

Target Description Required fields
phone VOIP phone
contacts Access the users address book

Example entry

{
    "title": "Calendar",
    "icon": "far fa-calendar",
    "target": "calendar",
    "options": {
        "query": "all users",
        "dayFormat": [":icon", ":templateMultiline"]
    }
}