Menu Settings

Enabling / Disabling the Menu

Use the editor.menu.show key to enable or disable the menu (default: true).

// synapeditor.config.js
{
  'editor.menu.show': true
}

Menu Structure

Use editor.menu.list to define the top-level (depth 1) menu.

// synapeditor.config.js
{
  'editor.menu.list': [
    'file',
    'edit',
    'view',
    'insert',
    'format',
    'table',
    'tools'
  ]
}

Use editor.menu.definition to define the sub-menus.

// synapeditor.config.js
{
  'editor.menu.definition': {
    'file': [
      'new',
      'open',
      '-',
      'template',
      'autoSave',
      'print',
      'pageBreak'
    ],
    'edit': [
      'undo',
      'redo',
      '-',
      'copy',
      '-',
      'find'
    ],
    'view': [
      'fullScreen',
      '-',
      'source',
      'preview'
    ],
    'insert': [
      'link',
      'image',
      'background',
      '-',
      'video',
      'file',
      'horizontalLine',
      '-',
      'specialCharacter',
      'emoji'
    ],
    'format': [
      'bold',
      'italic',
      'underline',
      'strike',
      '-',
      'superScript',
      'subScript',
      '-',
      {
        'groupName': 'list',
        'subMenuItems': [
          'bulletList',
          'numberedList',
          'multiLevelList'
        ]
      },
      'increaseIndent',
      'decreaseIndent',
      '-',
      {
        'groupName': 'align',
        'subMenuItems': [
          'alignLeft',
          'alignCenter',
          'alignRight',
          'alignJustify'
        ]
      },
      {
        'groupName': 'format',
        'subMenuItems': [
          'copyRunStyle',
          'pasteRunStyle',
          'removeRunStyle'
        ]
      },
      'paragraphProperties'
    ],
    'table': [
      'table',
      'deleteTable',
      'tableProperties',
      '-',
      {
        'groupName': 'row',
        'subMenuItems': [
          'insertRowBefore',
          'insertRowAfter',
          'deleteRow'
        ]
      },
      {
        'groupName': 'column',
        'subMenuItems': [
          'insertColBefore',
          'insertColAfter',
          'deleteCol'
        ]
      },
      {
        'groupName': 'cell',
        'subMenuItems': [
          'mergeCell',
          'splitCell',
          'cellProperties'
        ]
      }
    ],
    'tools': [
      {
        'groupName': 'conversion',
        'subMenuItems': ['upperCase', 'lowerCase', 'titleCase', 'toggleCase']
      }
    ]
  }
}

Examples

<table> <thead> <tr><th>Menu config</th><th>Result</th><th>Menu config</th><th>Result</th></tr> </thead> <tbody> <tr> <td>

'file': [
  'new',
  'open',
  '-',
  'template',
  'autoSave',
  'print',
  'pageBreak'
]

</td> <td>

'edit': [
  'undo',
  'redo',
  '-',
  'copy',
  '-',
  'find'
]

</td> <td>

</td> </tr> <tr> <td>

'view': [
  'fullScreen',
  '-',
  'source',
  'preview'
]

</td> <td>

'insert': [
  'link',
  'image',
  'background',
  '-',
  'video',
  'file',
  'horizontalLine',
  '-',
  'specialCharacter',
  'emoji'
]

</td> <td>

</td> </tr> <tr> <td>

'format': [
  'bold',
  'italic',
  'underline',
  'strike',
  '-',
  'superScript',
  'subScript',
  '-',
  {
    'groupName': 'list',
    'subMenuItems': [
      'bulletList',
      'numberedList',
      'multiLevelList'
    ]
  },
  'increaseIndent',
  'decreaseIndent',
  '-',
  {
    'groupName': 'align',
    'subMenuItems': [
      'alignLeft',
      'alignCenter',
      'alignRight',
      'alignJustify'
    ]
  },
  {
    'groupName': 'style',
    'subMenuItems': [
      'copyRunStyle',
      'pasteRunStyle',
      'removeRunStyle'
    ]
  },
  'paragraphProperties'
]

</td> <td>

'table': [
  'table',
  'deleteTable',
  'tableProperties',
  '-',
  {
    'groupName': 'row',
    'subMenuItems': [
      'insertRowBefore',
      'insertRowAfter',
      'deleteRow'
    ]
  },
  {
    'groupName': 'column',
    'subMenuItems': [
      'insertColBefore',
      'insertColAfter',
      'deleteCol'
    ]
  },
  {
    'groupName': 'cell',
    'subMenuItems': [
      'mergeCell',
      'splitCell',
      'cellProperties'
    ]
  }
]

</td> <td>

</td> </tr> <tr> <td>

'tools': [
  {
    'groupName': 'conversion',
    'subMenuItems': [
      'upperCase',
      'lowerCase',
      'titleCase',
      'toggleCase'
    ]
  }
]

</td> <td>

</td> <td></td> <td></td> </tr> </tbody> </table>