Navigation JSON File

Disclaimer: Portals require a license. These documents are to get you started with your portals. By no means is this the only way to make your portal, nor is this the only way to edit a json file.

Overview of the navigation.json file

• this .json file will personalize the banner that you navigate to different sections.

  • Examples: projects in the project tab, different tools you want immediate access to in the tool section.

If you have questions about how to use a json file, please view this section

Overview of the Sections of a portal and matching json files:

Example of the navigation.json file

The navigation.json file for this example is blank. These are the default items in the header

{

}

Sections in your navigation.json file

This file must be at least accessible to community members.

This file is optional. It allows you to edit the feature list of projects. _projects, _tools, and supportURL are all optional.

They can be

• null, which will remove the item from the header

• an array of objects

  • Text for the text of the new menu item,

  • url as the destination

  • newTab for if the link should open up a new tab

• If there is another entry, it indicated that a new navigation item needs to be added.

  • They can be objects with a url and optional parameters. newTab means a link in the navigation when you do this method

  • They can also be array of objects with text, url, and newTab (which will give it a dropdown menu with listed items)

Examples of items to add to a navigation.json:

{
 "_projects": null, #deletes the current list of projects 
 "_tools": [
  {"text": "Custom Menu Item", "url": "http://example.com"}, #creating a new item within tools 
  {"text": "Opens in New Tab", "url": "http://example.com", "newTab": true} #creating a new tab in tools 
 ],
 "_help": null, #removes help 
 "A New Menu": [
  {"text": "New Menu Item", "url": "http://example.com"}, #new menu 
 ],
 "A New Link": {"url": "http://example.com", "newTab": true} #new link 
}

Resources

Portal Documentation

Full Documentation

Please email [email protected] to create a support ticket if there are technical issues.