Branding 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 branding.json file

• this .json file will edit the branding portion of the portal.

• You can add different sections, links, projects, etc into the json file

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 branding.json file

This is the file to create what you see above

{
 "header": {
"logo": "#logo_header.png", 
   "logoOpensNewTab": true, 
   "hideCommunitySwitch": true,
   "colors": {
     "background": "#EEEEEE", 
     "border": "#EEEEEE",
     "text": "#000000"  
   }
}, 
"homeURL": "http://academy.dnanexus.com" 
}

Other Sections in your home.json file

Header:

{
 "header": {
   "logo": "#logo_header.png",  #image for the logo; has to be an appropriate size. min 15x15px, max 50x30px
   "logoOpensNewTab": true,  #opens new tab if you select the logo 
   "hideCommunitySwitch": true,
   "colors": {
     "background": "#123456", #background color for the header 
     "border": "#123456", #border color for the header
     "text": "#123456", #text color
   }
   }

Other parameters to the header section

 "header": {
   "colors": {
     "hoverBackground": "#123456", #hover background color 
     "userColors": ["#123456", "#234567", "#345678"], #user colors 
     "button": {"success": {"border-color": "green", "background":
      "pink", "hover": {"background": "dusk"}}} #setting colors for buttons or hover selections
   }

Login (optional):

"login": {
   "logo": "#logo_login.png", #image for login 
   "text": "# ADD TEXT IN MARKDOWN FORMAT HERE.",
   "colors": {
     "loginButton": "#123456" #set color for login button here 
   }

Register (optional):

"register": {
   "disable": true,
   "logo": "#logo_register.png", #image for registering 
   "text": "#ADD TEXT IN MARKDOWN FORMAT HERE.",
   "agreeToText": "Plain text you need to agree to before registering", #plain text, string 
   "region": "aws:us-east-1",
   "colors": {
     "registerButton": "#123456" #color for register button 
   }

Other Parameters (optional):

"homeURL": "http://example.com", #url for logo 
 "supportURL": "http://example.com/support", #support URL 
 "hideCommunitySwitch": true,
 "description": "A short description of two or three lines for the community selector" #description for the community 

Resources

Portal Documentation

Full Documentation

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