Skip to content

Options

  • start
  • blacklist - list of system paths to remove from menu
  • noSpeedDial - list of menu paths to remove speed dial
  • header
  • variant
  • animation
  • styles
  • classes
  • welcome
    • token
    • layoutId
  • form
    • token
    • tracker
  • extendBodyBehindAppBar (flutter/mobile only), if true, push the content to behind the app navigation bar
  • keepAlive (flutter/mobile only), if set to false, when user changed tab, page will be rebuild
  • ads: map (flutter only)
    • interval: integer to indicate how many dispatch to display before displaying the next ads (first ads is always display)
    • minHeight: minimum height for ad banner
    • maxHeight: maximum height for ad banner
    • mode: native | banner, banner is default
    • size: if mode is native, size is either small | medium
    • condition.rule, rule to evaluate, if eval to true, show ads (default to true)

Blacklisting screens

This list will turn off default screens

Styling

  • root
  • menuItem
  • menuText
  • orgItem
  • orgText
  • category
  • header

Animation

Use one of the animations defined at (Animate.css)[https://animate.style/]

  • root
  • menuItem
  • menuText
  • orgItem
  • orgText
  • category
  • header

Example

"options": {
    "start": {
      "index": "0"
    },
    "blacklist": [
      "outbox",
      "files",
      "globalSearch"
    ],
    "header": "{user.first}",
    "variant": "small",
    "animation": {
      "menuText": {
        "entry": "fadeInRight",
        "duration": "400ms"
      },
      "header": {
        "entry": "fadeInRight",
        "duration": "400ms"
      }
    },
    "styles": {
      "root": {
        "backgroundColor": "#96EECF",
        "borderLeft": "5px solid #1C5C57",
        "color": "#1C5C57",
        "marginTop": "-30px",
        "paddingTop": "30px",
        "minHeight": "calc(100vh + 30px)"
      },
      "header": {
        "marginTop": "150px",
        "marginLeft": "20px",
        "fontSize": "1.6rem",
        "color": "#1C5C57"
      },
      "menuItem": {
        "borderBottom": "5px solid #1C5C57"
      },
      "menuText": {
        "color": "#1C5C57"
      },
      "title": {
        "color": "#FFF",
        "fontSize": "2rem",
        "textAlign": "end",
        "position": "relative",
        "overflow": "hidden"
      },
      "textSlide": {
        "position": "absolute",
        "top": 0,
        "bottom": 0,
        "right": 0,
        "width": "100%"
      }
    },
    "classes": {
      "menuItem": "text-uppercase my-2",
      "category1": "d-none"
    }
  }