README: Update content.
1. Add brief introduce for English and Chinese users. 2. Add some demo pictures.
|
@ -0,0 +1,68 @@
|
||||||
|
# RibbonUI
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="lib_source/resources/imgs/icon.png" alt="Logo" style="width:40%; height:auto;">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h1 align="center">Qt RibbonUI </h1>
|
||||||
|
|
||||||
|
- [RibbonUI](#ribbonui)
|
||||||
|
- [1. 介绍](#1-介绍)
|
||||||
|
- [2. 组件列表](#2-组件列表)
|
||||||
|
- [3. 支持平台](#3-支持平台)
|
||||||
|
- [Qt 6 分支 (main 分支)](#qt-6-分支-main-分支)
|
||||||
|
- [Qt 5 分支 (***TODO***)](#qt-5-分支-todo)
|
||||||
|
- [4. 鸣谢](#4-鸣谢)
|
||||||
|
- [5. 与我联系](#5-与我联系)
|
||||||
|
|
||||||
|
## 1. 介绍
|
||||||
|
RibbonUI是一个参考微软Ribbon风格(即Office 2016后的风格)设计的轻量级、简约且优雅的Qt组件库,用QML写就。
|
||||||
|
|
||||||
|
***[Click to view English README](README.md)***
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<div align="center">
|
||||||
|
<img src="documents/pictures/home-light-classic.png" alt="Home Light Classic" style="width:45%; height:auto;">
|
||||||
|
<img src="documents/pictures/home-dark-classic.png" alt="Home Light Classic" style="width:45%; height:auto;">
|
||||||
|
</div>
|
||||||
|
<p align="center">主界面浅色/深色主题 (经典风格) </p>
|
||||||
|
</div>
|
||||||
|
<div align="center">
|
||||||
|
<div align="center">
|
||||||
|
<img src="documents/pictures/home-light-modern.png" alt="Home Light Modern" style="width:45%; height:auto;">
|
||||||
|
<img src="documents/pictures/home-dark-modern.png" alt="Home Light Modern" style="width:45%; height:auto;">
|
||||||
|
</div>
|
||||||
|
<p align="center">主界面浅色/深色主题 (现代风格) </p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## 2. 组件列表
|
||||||
|
目前支持***30***种组件,后续会添加更多。
|
||||||
|
| 名称 | 介绍 | 展示图片|
|
||||||
|
|:----:|:----:|:----:|
|
||||||
|
| RibbonWindow | 基于framelesshelper实现的无边框窗口,支持退出确认弹窗及模糊/亚克力化背景。||
|
||||||
|
| RibbonTabBar | 支持多分组页面切换、自定义右上角工具栏、自由收放的工具栏,如同Word的。|  |
|
||||||
|
| RibbonTitleBar | 支持自定义背景色、自由添加工具按钮的窗口标题栏,针对Windows和macOS有不同的窗口按钮设计。|  |
|
||||||
|
| RibbonBottomBar | 支持添加自定义工具的底栏。 | |
|
||||||
|
|
||||||
|
其他组件的介绍会陆续更新。
|
||||||
|
|
||||||
|
## 3. 支持平台
|
||||||
|
目前是基于Qt 6 设计的,之后有时间会加入Qt 5的支持, ***因此目前仅支持Qt 6支持的平台***。
|
||||||
|
### Qt 6 分支 (main 分支)
|
||||||
|
+ Windows: Windows 10 (1809+), Windows 11.(X86/AMD64, aarch64)
|
||||||
|
+ macOS: macOS 11+.(AMD64, aarch64)
|
||||||
|
+ Linux: Ubuntu 22.04+ (X86/AMD64)
|
||||||
|
### Qt 5 分支 (***TODO***)
|
||||||
|
+ Windows: Windows 7+.(X86/AMD64)
|
||||||
|
+ macOS: MacOS X 10.13 - 10.15, macOS 11+.(AMD64, aarch64)
|
||||||
|
+ Linux: Ubuntu 18.04+ (X86/AMD64)
|
||||||
|
|
||||||
|
## 4. 鸣谢
|
||||||
|
+ 感谢[@wangwenx190](https://github.com/wangwenx190)的[framelesshelper](https://github.com/wangwenx190/framelesshelper)让RibbonWindow能实现无边框。
|
||||||
|
+ [@Microsoft](https://github.com/microsoft)的[fluentui-system-icons](https://github.com/zhuzichu520/FluentUI)提供的漂亮图标库.
|
||||||
|
+ 感谢[@zhuzichu520](https://github.com/zhuzichu520)的[FluentUI](https://github.com/zhuzichu520/FluentUI) 为我提供的灵感和参考。
|
||||||
|
|
||||||
|
## 5. 与我联系
|
||||||
|
+ Email: mentalflow@ourdocs.cn
|
||||||
|
+ Blog: [菜鸟技术猿的折腾史.](https://blog.ourdocs.cn)
|
||||||
|
+ ***欢迎发起PR或Issues,我会在空余时间尽快完善功能或修复bug,希望能一起让RibbonUI变得更好,尽情享受吧🎉!***
|
68
README.md
|
@ -1,2 +1,68 @@
|
||||||
# RibbonUI
|
# RibbonUI
|
||||||
A library of controls written in QML and designed with reference to the Microsoft Ribbon style.
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="lib_source/resources/imgs/icon.png" alt="Logo" style="width:40%; height:auto;">
|
||||||
|
</div>
|
||||||
|
<h1 align="center">Qt RibbonUI </h1>
|
||||||
|
|
||||||
|
- [RibbonUI](#ribbonui)
|
||||||
|
- [1. Introduction](#1-introduction)
|
||||||
|
- [2. Included Components](#2-included-components)
|
||||||
|
- [3. Supported platforms](#3-supported-platforms)
|
||||||
|
- [Qt 6 branch (main branch)](#qt-6-branch-main-branch)
|
||||||
|
- [Qt 5 branch (***TODO***)](#qt-5-branch-todo)
|
||||||
|
- [4. Acknowledgement](#4-acknowledgement)
|
||||||
|
- [5. Get in touch with me](#5-get-in-touch-with-me)
|
||||||
|
|
||||||
|
|
||||||
|
## 1. Introduction
|
||||||
|
RibbonUI is a lightweight, minimalist and elegant Qt component library written in QML and designed with reference to the Microsoft Ribbon style.
|
||||||
|
|
||||||
|
***[点击查看中文文档](README(zh-cn).md)***
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<div align="center">
|
||||||
|
<img src="documents/pictures/home-light-classic.png" alt="Home Light Classic" style="width:45%; height:auto;">
|
||||||
|
<img src="documents/pictures/home-dark-classic.png" alt="Home Light Classic" style="width:45%; height:auto;">
|
||||||
|
</div>
|
||||||
|
<p align="center">Home Light/Dark Theme (Classic Style) </p>
|
||||||
|
</div>
|
||||||
|
<div align="center">
|
||||||
|
<div align="center">
|
||||||
|
<img src="documents/pictures/home-light-modern.png" alt="Home Light Modern" style="width:45%; height:auto;">
|
||||||
|
<img src="documents/pictures/home-dark-modern.png" alt="Home Light Modern" style="width:45%; height:auto;">
|
||||||
|
</div>
|
||||||
|
<p align="center">Home Light/Dark Theme (Modern Style) </p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## 2. Included Components
|
||||||
|
Currently supports ***30*** components, more will be added later.
|
||||||
|
| Components | Introduction | Demo Picture|
|
||||||
|
|:----:|:----:|:----:|
|
||||||
|
| RibbonWindow | A Window component that relies on framelesshelper to support exit confirmation popups and blur style backgrounds. ||
|
||||||
|
| RibbonTabBar | A toolbar with support for page switching and retracting, and support for placing customized buttons in the upper right corner, just like Microsoft Word's. |  |
|
||||||
|
| RibbonTitleBar | A window title bar that supports custom colors and the free addition of secondary buttons, with different designs for Windows and macOS. |  |
|
||||||
|
| RibbonBottomBar | A bottom bar that supports adding custom tools. | |
|
||||||
|
|
||||||
|
***The introduction of other components will be updated later.***
|
||||||
|
|
||||||
|
## 3. Supported platforms
|
||||||
|
The current design is based on Qt 6, and support for Qt 5 will be added sometime later, ***so the current support list is consistent with Qt 6***.
|
||||||
|
### Qt 6 branch (main branch)
|
||||||
|
+ Windows: Windows 10 (1809+), Windows 11.(X86/AMD64, aarch64)
|
||||||
|
+ macOS: macOS 11+.(AMD64, aarch64)
|
||||||
|
+ Linux: Ubuntu 22.04+ (X86/AMD64)
|
||||||
|
### Qt 5 branch (***TODO***)
|
||||||
|
+ Windows: Windows 7+.(X86/AMD64)
|
||||||
|
+ macOS: MacOS X 10.13 - 10.15, macOS 11+.(AMD64, aarch64)
|
||||||
|
+ Linux: Ubuntu 18.04+ (X86/AMD64)
|
||||||
|
|
||||||
|
## 4. Acknowledgement
|
||||||
|
+ [@wangwenx190](https://github.com/wangwenx190)'s [framelesshelper](https://github.com/wangwenx190/framelesshelper) for frameless window (aka RibbonWindow's base).
|
||||||
|
+ [@Microsoft](https://github.com/microsoft)'s [fluentui-system-icons](https://github.com/zhuzichu520/FluentUI) for beautifully designed icons.
|
||||||
|
+ [@zhuzichu520](https://github.com/zhuzichu520)'s [FluentUI](https://github.com/zhuzichu520/FluentUI) for inspiration and reference.
|
||||||
|
|
||||||
|
## 5. Get in touch with me
|
||||||
|
+ Email: mentalflow@ourdocs.cn
|
||||||
|
+ Blog: [The Tossed History of a Rookie Technician.](https://blog.ourdocs.cn)
|
||||||
|
+ ***And PRs and Issues are welcome, I'll try to improve features or fix bugs as soon as I can in my spare time, let's make RibbonUI better together, enjoy!***
|
After Width: | Height: | Size: 46 KiB |
After Width: | Height: | Size: 199 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 518 KiB |
After Width: | Height: | Size: 669 KiB |
After Width: | Height: | Size: 550 KiB |
After Width: | Height: | Size: 630 KiB |