Skip to content

czyt1988/SARibbon

Repository files navigation

SARibbon Introduction

中文文档点击这里

Project Documentation: https://czyt1988.github.io/SARibbon/en
Detailed User Guide: SARibbon User Guide

Windows (latest) Linux Ubuntu (latest) Mac (latest)
Qt 5.12 LTS Build Status Build Status Build Status
Qt 5.14 Build Status Build Status Build Status
Qt 5.15 LTS Build Status Build Status Build Status
Qt 6.2 LTS Build Status Build Status Build Status
Qt 6.5 LTS Build Status Build Status Build Status
Qt 6.8 LTS Build Status Build Status Build Status

This is a Ribbon UI control for Qt, providing an interface similar to Microsoft Office applications.

  • SARibbon is suitable for large-scale software, industrial applications, and complex UIs.
  • It adopts naming conventions inspired by MFC Ribbon interfaces.
  • The visual style draws from both Microsoft Office and WPS Office Ribbon interfaces, combining the best features of both.
  • SARibbon supports multiple customizable themes and allows rapid styling via Qt Style Sheets (QSS).
  • To facilitate development of large applications, SARibbon includes encapsulated common functional widgets, such as color picker buttons and color panels.

Features

Ribbon Layout and Display

Overview

  • Supports minimized mode, where only tabs are shown (double-clicking a tab toggles minimization by default). Contextual tabs are also supported.
    Minimized Mode

  • Supports Quick Access Bar (like Word’s quick menu) and Right Button Group, with adaptive layout behavior in different modes.

  • Supports four types of Ribbon buttons:

    • Standard push button
    • Delayed popup menu button
    • Menu button
    • Action menu button
      (The action menu button addresses one of the core challenges this Ribbon control aims to solve.)
      Ribbon Buttons
  • Offers four distinct layout styles.
    Layout Styles

  • Fully customizable via QSS, with real-time theme switching support. Includes 6 built-in themes:

    • Windows 7
      Win7 Theme
    • Office 2013
      Office 2013 Theme
    • Office 2016
      Office 2016 Theme
    • Office 2021
      Office 2021 Theme
    • Dark
      Dark Theme
    • Dark 2
      Dark 2 Theme
  • Provides a Gallery widget.
    Gallery

  • Supports horizontal scrolling and Option Actions.
    Option Action

  • Offers center-aligned mode.
    Center Alignment

  • Fully compatible with 4K displays and multi-monitor setups.

  • Supports Linux and macOS (UI not deeply optimized for these platforms).

  • Licensed under the MIT License — contributions and feedback are welcome!

Repositories


Building and Usage


More Screenshots

Screenshots of real applications built with SARibbon:

Data Workbench GIF
Data Workbench EN
Data Workbench CN

For actual Ribbon implementation code, see:
https://github.com/czyt1988/data-workbench/blob/master/src/APP/DAAppRibbonArea.cpp


Documentation Generation

You can generate documentation using Doxygen:

  • docs/Doxyfile-qch-en: generates .qch files for integration into Qt Creator as Qt Help documentation.
  • docs/Doxyfile-wiki-en: generates HTML documentation for browser viewing.

This project’s documentation is built with MkDocs and deployed to GitHub Pages:
https://czyt1988.github.io/SARibbon/en