README: Added more component introduction and build tutorial.
This commit is contained in:
parent
eb9d4bed5f
commit
88111aaab7
GPG Key ID:
5AE68D4401A2EE71
|
|
@ -12,8 +12,9 @@
|
|||
- [3. 支持平台](#3-支持平台)
|
||||
- [Qt 6 分支 (main 分支)](#qt-6-分支-main-分支)
|
||||
- [Qt 5 分支 (***TODO***)](#qt-5-分支-todo)
|
||||
- [4. 鸣谢](#4-鸣谢)
|
||||
- [5. 与我联系](#5-与我联系)
|
||||
- [4. 如何使用?](#4-如何使用)
|
||||
- [5. 鸣谢](#5-鸣谢)
|
||||
- [6. 与我联系](#6-与我联系)
|
||||
|
||||
## 1. 介绍
|
||||
RibbonUI是一个参考微软Ribbon风格（即Office 2016后的风格）设计的轻量级、简约且优雅的Qt组件库，用QML写就。
|
||||
|
|
@ -43,6 +44,26 @@ RibbonUI是一个参考微软Ribbon风格（即Office 2016后的风格）设计
|
|||
| RibbonTabBar | 支持多分组页面切换、自定义右上角工具栏、自由收放的工具栏，如同Word的。|  |
|
||||
| RibbonTitleBar | 支持自定义背景色、自由添加工具按钮的窗口标题栏，针对Windows和macOS有不同的窗口按钮设计。|  |
|
||||
| RibbonBottomBar | 支持添加自定义工具的底栏。 | |
|
||||
| RibbonBlur | 为各种组件提供模糊化效果 |  |
|
||||
| RibbonButton | 支持有/无背景的纯文字/纯图标/图标加文字的按钮，支持鼠标覆盖显示提示信息 |  |
|
||||
| RibbonPushButton | 支持弹出菜单的大图标按钮，可以使用内置图标库或用户自选图片 |  |
|
||||
| RibbonSlider | 支持水平或垂直放置的滑动控制条 |  |
|
||||
| RibbonIcon | 图标组件，内置图标数百个来自微软的精美图标 |  |
|
||||
| RibbonText | 文字组件，可以允许/禁止选中文字或复制 |  |
|
||||
| RibbonCheckBox | 选择框组件，可自定义是否显示文字、文字显示位置（左/右） |  |
|
||||
| RibbonSwitchButton | 开关按钮，支持自定义背景颜色、是否显示提示文字或按钮文字，可自由调整文字显示位置（左/右） |  |
|
||||
| RibbonTheme | 主题支持浅色、深色、跟随系统三种模式 |  |
|
||||
| RibbonMenu | 菜单组件，支持二元选择及子菜单 |  |
|
||||
| RibbonPopup | 自动居中的弹出式窗口 |  |
|
||||
| RibbonPopDialog | 支持二元或三元选择的弹出式窗口 |  |
|
||||
| RibbonLineEdit | 支持设置图标和一键清除的单行文本输入控件 |  |
|
||||
| RibbonTextEdit | 支持设置图标和一键清除的多行文本输入控件，可随文本输入自动换行/滚动 |  |
|
||||
| RibbonTextEdit | 支持设置图标和一键清除的多行文本输入控件，可随文本输入自动换行/滚动 |  |
|
||||
| RibbonComboBox | 支持设置图标的下拉菜单选择控件，菜单支持用户输入添加 |  |
|
||||
| RibbonSpinBox | 支持设置图标的旋钮控件 |  |
|
||||
| RibbonSpinBox | 支持设置图标的旋钮控件 |  |
|
||||
| RibbonView | 与TabBar和BottomBar搭配使用的可滑动组件，两组件模糊化的背景均来源于它 |  |
|
||||
| RibbonPaperView | 类似Word中纸张的组件 |  |
|
||||
|
||||
其他组件的介绍会陆续更新。
|
||||
|
||||
|
|
@ -57,12 +78,51 @@ RibbonUI是一个参考微软Ribbon风格（即Office 2016后的风格）设计
|
|||
+ macOS: MacOS X 10.13 - 10.15, macOS 11+.(AMD64, aarch64)
|
||||
+ Linux: Ubuntu 18.04+ (X86/AMD64)
|
||||
|
||||
## 4. 鸣谢
|
||||
## 4. 如何使用?
|
||||
+ 安装前准备
|
||||
|
||||
安装Qt 6，推荐通过官方在线安装器安装**Qt 6.2.4 LTS版本**，**通过brew等方式安装可能会出现问题**。**Qt Quick相关模块**和**qt5compat qtshadertools qtimageformats**组件是必要的。
|
||||
|
||||
+ 编译例程和库
|
||||
- 下载仓库并进入
|
||||
```shell
|
||||
git clone https://github.com/mentalfl0w/RibbonUI.git --recursive
|
||||
cd RibbonUI
|
||||
```
|
||||
- 创建并进入build文件夹
|
||||
```shell
|
||||
mkdir build
|
||||
cd build
|
||||
```
|
||||
- 编译
|
||||
```shell
|
||||
# 如果想进行Debug编译, 请配置 -DCMAKE_BUILD_TYPE=Debug和--config Debug参数
|
||||
# 如果想编译静态库, 请在cmake参数中加入-DRIBBONUI_BUILD_STATIC_LIB=ON
|
||||
cmake -DCMAKE_MESSAGE_LOG_LEVEL=STATUS -DCMAKE_PREFIX_PATH=/Users/runner/work/RibbonUI/Qt/6.2.4/macos -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release -GNinja ..
|
||||
# -DCMAKE_PREFIX_PATH={你的Qt安装目录}
|
||||
cmake --build . --target all --config Release --parallel
|
||||
```
|
||||
+ 在其他项目中使用RibbonUI
|
||||
- 遵循***编译例程和库***的下载仓库和进入build目录步骤
|
||||
- 在CMakeLists.txt中加入以下语句
|
||||
```camke
|
||||
add_subdirectory(RibbonUI) # RibbonUI在你文件系统中的相对路径
|
||||
```
|
||||
- 编译
|
||||
```shell
|
||||
# 如果想进行Debug编译, 请配置 -DCMAKE_BUILD_TYPE=Debug和--config Debug参数
|
||||
# 如果想编译静态库, 请在cmake参数中加入-DRIBBONUI_BUILD_STATIC_LIB=ON
|
||||
cmake -DCMAKE_MESSAGE_LOG_LEVEL=STATUS -DCMAKE_PREFIX_PATH=/Users/runner/work/RibbonUI/Qt/6.2.4/macos -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release -DRIBBONUI_BUILD_EXAMPLES=OFF -GNinja ..
|
||||
# -DCMAKE_PREFIX_PATH={你的Qt安装目录}
|
||||
cmake --build . --target all --config Release --parallel
|
||||
```
|
||||
|
||||
## 5. 鸣谢
|
||||
+ 感谢[@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. 与我联系
|
||||
## 6. 与我联系
|
||||
+ Email: mentalflow@ourdocs.cn
|
||||
+ Blog: [菜鸟技术猿的折腾史.](https://blog.ourdocs.cn)
|
||||
+ ***欢迎发起PR或Issues，我会在空余时间尽快完善功能或修复bug，希望能一起让RibbonUI变得更好，尽情享受吧🎉！***
|
||||
66
README.md
66
README.md
|
|
@ -11,8 +11,9 @@
|
|||
- [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)
|
||||
- [4. How to use it?](#4-how-to-use-it)
|
||||
- [5. Acknowledgement](#5-acknowledgement)
|
||||
- [6. Get in touch with me](#6-get-in-touch-with-me)
|
||||
|
||||
|
||||
## 1. Introduction
|
||||
|
|
@ -43,6 +44,24 @@ Currently supports ***30*** components, more will be added later.
|
|||
| 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. | |
|
||||
| RibbonBlur | Provides blurring effects for various components |  |
|
||||
| RibbonButton | A button that supports plain text/plain icons/icons and text with/without backgrounds, with mouse overlay support for displaying alert messages |  |
|
||||
| RibbonPushButton | A large icon button that supports pop-up menus, either using the built-in icon library or a user-selected image |  |
|
||||
| RibbonSlider | Support for horizontally or vertically placed slider |  |
|
||||
| RibbonIcon | Icon component, built-in hundreds of beautiful icons from Microsoft |  |
|
||||
| RibbonText | Text component that allows/disallows selection of text or copying |  |
|
||||
| RibbonCheckBox | Checkbox component, customizable whether to display text, where to display text (left/right) |  |
|
||||
| RibbonSwitchButton | Switch button, support for customizing the background color, whether to display the prompt text or button text, free to adjust the text display position (left/right) |  |
|
||||
| RibbonTheme | Theme support light color, dark color, follow system three modes |  |
|
||||
| RibbonMenu | Menu component with binary selection and submenu support |  |
|
||||
| RibbonPopup | Auto-centered pop-ups |  |
|
||||
| RibbonPopDialog | Popups supporting binary or ternary selection |  |
|
||||
| RibbonLineEdit | Single-line text input control with support for icons and one-click clearing |  |
|
||||
| RibbonTextEdit | Multi-line text input control with support for icons and one-click clearing, automatic line feed/scrolling as text is entered |  |
|
||||
| RibbonComboBox | Supports drop-down menu selection controls with icons, and menus can be added with user input. |  |
|
||||
| RibbonSpinBox | SpinBox with support for setting icons |  |
|
||||
| RibbonView | Slidable component for use with TabBar and BottomBar, from which the blurred backgrounds of both components are derived. |  |
|
||||
| RibbonPaperView | Components similar to paper in Word |  |
|
||||
|
||||
***The introduction of other components will be updated later.***
|
||||
|
||||
|
|
@ -57,12 +76,51 @@ The current design is based on Qt 6, and support for Qt 5 will be added sometime
|
|||
+ macOS: MacOS X 10.13 - 10.15, macOS 11+.(AMD64, aarch64)
|
||||
+ Linux: Ubuntu 18.04+ (X86/AMD64)
|
||||
|
||||
## 4. Acknowledgement
|
||||
## 4. How to use it?
|
||||
+ Before Install
|
||||
|
||||
To install Qt 6, it is recommended to install the **Qt 6.2.4** LTS version via the official online installer, **installing via brew, etc. may cause problems**. **Qt Quick related modules** and the **qt5compat qtshadertools qtimageformats** component are required
|
||||
|
||||
+ Compile the example and library
|
||||
- Clone and enter the library folder
|
||||
```shell
|
||||
git clone https://github.com/mentalfl0w/RibbonUI.git --recursive
|
||||
cd RibbonUI
|
||||
```
|
||||
- Create and enter the build folder
|
||||
```shell
|
||||
mkdir build
|
||||
cd build
|
||||
```
|
||||
- Build
|
||||
```shell
|
||||
# if you want to make a Debug build, just let -DCMAKE_BUILD_TYPE=Debug, --config Debug
|
||||
# if you want a static build, add -DRIBBONUI_BUILD_STATIC_LIB=ON into command
|
||||
cmake -DCMAKE_MESSAGE_LOG_LEVEL=STATUS -DCMAKE_PREFIX_PATH=/Users/runner/work/RibbonUI/Qt/6.2.4/macos -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release -GNinja ..
|
||||
# -DCMAKE_PREFIX_PATH={YOUR QT INSTALL FOLDER}
|
||||
cmake --build . --target all --config Release --parallel
|
||||
```
|
||||
+ Use library with other project
|
||||
- Follow the same steps like clone and enter build folder as ***Compile the example and library***
|
||||
- Add the following code to your CMakeLists.txt
|
||||
```camke
|
||||
add_subdirectory(RibbonUI) # RibbonUI's path in your project file system
|
||||
```
|
||||
- Build
|
||||
```shell
|
||||
# if you want to make a Debug build, just let -DCMAKE_BUILD_TYPE=Debug, --config Debug
|
||||
# if you want a static build, add -DRIBBONUI_BUILD_STATIC_LIB=ON into command
|
||||
cmake -DCMAKE_MESSAGE_LOG_LEVEL=STATUS -DCMAKE_PREFIX_PATH=/Users/runner/work/RibbonUI/Qt/6.2.4/macos -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Release -DRIBBONUI_BUILD_EXAMPLES=OFF -GNinja ..
|
||||
# -DCMAKE_PREFIX_PATH={YOUR QT INSTALL FOLDER}
|
||||
cmake --build . --target all --config Release --parallel
|
||||
```
|
||||
|
||||
## 5. 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
|
||||
## 6. 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!***
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 272 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 193 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 502 KiB |
Loading…
Reference in New Issue