ModernUI Workbench

From FreeCAD Documentation
Jump to navigation Jump to search

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Modern UI workbench icon


The ModernUI Workbench is an external workbench that replaces the standard user interface with modern features such as:

  • each workbench has its ribbon tab
  • Modern UI ribbon tab replaces top-level menu
  • activating a workbench's ribbon tab shows groups of the workbench's tools
  • Panels such as Combo View are collapsed/expanded upon mouse-over


Limitations and Troubleshooting

  • If you experience unexpected behavior, always try first to uninstall and then reinstall the ModernUI workbench.
  • The workbench is primarily tested with English and may exhibit unexpected behavior in other languages.
  • Installing more workbenches after installing ModernUI may cause problems.


Install with the AddonManager.svg Addon Manager.

Note: To uninstall, you will have to create a macro and execute it. If you do not feel confident about this, consider to not install.

Running Modern UI in a self-contained directory

introduced in version 0.19 To easily test Modern UI without interfering with your standard configuration, you can contain it in a separate directory. Uninstalling Modern UI is then simply accomplished by deleting the directory.


For example:

 $ mkdir modernUI  # new directory that contains Modern UI
 $ cd modernUI

When starting FreeCAD like this for the first time, you have a new default configuration. Now install (and configure) Modern UI. This is essentially a portable FreeCAD version.

Instead of using the command line, you can also create a dedicated desktop icon.


There are not dedicated instructions for Windows yet, however, it is very similar to creating a portable version of FreeCAD on a USB medium.


Detailed instructions are found at GitHub.

The uninstall sequence is as follows:

  • 1. Uninstall with the AddonManager.svg Addon Manager.
  • 2. Restart FreeCAD
  • 3. Create a macro with this code
from PySide2 import QtCore, QtGui, QtWidgets
mw = FreeCADGui.getMainWindow()

WBList = FreeCADGui.listWorkbenches()
for WB in WBList:
    for tb in mw.findChildren(QtWidgets.QToolBar):
  • 4. Execute macro
  • 5. Restart FreeCAD