Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aui-framework/aui
Declarative UI toolkit for modern C++20
https://github.com/aui-framework/aui
c-plus-plus c-plus-plus-20
Last synced: 2 days ago
JSON representation
Declarative UI toolkit for modern C++20
- Host: GitHub
- URL: https://github.com/aui-framework/aui
- Owner: aui-framework
- License: mpl-2.0
- Created: 2021-01-05T05:59:01.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-16T05:40:52.000Z (3 days ago)
- Last Synced: 2025-01-16T06:32:53.431Z (3 days ago)
- Topics: c-plus-plus, c-plus-plus-20
- Language: C++
- Homepage:
- Size: 38.9 MB
- Stars: 102
- Watchers: 7
- Forks: 16
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- trackawesomelist - AUI (⭐91) - Declarative UI toolkit for C++20. \[MPL2] (Recently Updated / [Dec 23, 2024](/content/2024/12/23/README.md))
README
# AUI (Advanced Universal Interface)
[](https://www.codacy.com/gh/Alex2772/aui/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Alex2772/aui&utm_campaign=Badge_Grade)
Cross-platform high performance efficient module-based framework for developing and deploying hardware accelerated graphical desktop applications
using modern C++20.
The project aims to provide developers with the best possible experience (including, but not limited to: dependency
management, packaging, ui building, styling, debugger visualizing).
[Documentation](https://aui-framework.github.io) | [Getting started](https://aui-framework.github.io/master/md_docs_Getting_started_with_AUI.html) | [Roadmap](https://github.com/orgs/aui-framework/projects/3/views/1) | [News](https://github.com/aui-framework/aui/discussions/categories/announcements) | [Discussions](https://github.com/aui-framework/aui/discussions)
# Quickstart
## Linux dependencies
If you are using Linux, install following dependencies:
### Ubuntu
```bash
sudo apt install pkg-config libfontconfig-dev libxcursor-dev libxi-dev libxrandr-dev libglew-dev libstdc++-static libpulse-dev libdbus-1-dev
```
### Fedora
```bash
sudo dnf install fontconfig-devel libXi libglvnd-devel libstdc++-static glew-devel pulseaudio-libs-devel
```
## Your project CMake script
To link AUI to your project, use the following CMake script:
`CMakeLists.txt`:
```cmake
# Standard routine
cmake_minimum_required(VERSION 3.16)
project(aui_app)
# Tip: in a production project don't use branch name, use a specific name tag (i.e. v1.1.1),
# but for a sandbox project branch name is perfectly enough
set(AUI_VERSION master)
# Use AUI.Boot
file(
DOWNLOAD
https://raw.githubusercontent.com/aui-framework/aui/${AUI_VERSION}/aui.boot.cmake
${CMAKE_CURRENT_BINARY_DIR}/aui.boot.cmake)
include(${CMAKE_CURRENT_BINARY_DIR}/aui.boot.cmake)
# import AUI
auib_import(aui https://github.com/aui-framework/aui
COMPONENTS core views
VERSION ${AUI_VERSION})
# Create the executable. This function automatically links all sources from the src/ folder,
# creates CMake target and places the resulting executable to bin/ folder.
aui_executable(${PROJECT_NAME})
# Link required libs
aui_link(${PROJECT_NAME} PRIVATE aui::core aui::views)
```
`src/main.cpp`:
```cpp
#include
#include
#include
#include
#include
#include
using namespace declarative;
AUI_ENTRY {
auto w = _new("Window title", 300_dp, 200_dp);
w->setContents(Centered {
Vertical {
Centered { Label { "Hello world from AUI!" } },
Centered {
Button { "Visit GitHub page" }.clicked(w, [] {
APlatform::openUrl("https://github.com/aui-framework/aui");
}),
},
},
});
w->show();
return 0;
}
```
Result:
Visit [layout building page](https://aui-framework.github.io/master/group__layout__managers.html) and our [introduction
guide](https://aui-framework.github.io/master/md_docs_Getting_started_with_AUI.html) for more info.
Optionally, you can use one of [our IDE plugins](https://aui-framework.github.io/develop/md_docs_IDE_Plugins) to set up the project.
# Key features
- Extended common types (containers, strings, streams, etc...)
- Graphical User Interfaces, including framework tools for fast declarative UI producing using modern C++ capabilities
- Resource compiler (assets)
- Internationalization (i18n)
- DPI support
- CMake deployment scripts
- Model binding
- Encryption
- IO streams
- Networking, including http(s) requests
- Both asynchronous and synchronous application architecture support
## Module list
- `aui.core` - basic types (containers, strings, streams, etc...)
- `aui.crypt` - wrapper around OpenSSL for encryption functionality
- `aui.curl` - wrapper around libcurl for http/https requests
- `aui.image` - popular image format loader
- `aui.json` - JSON parser
- `aui.network` - networking
- `aui.toolbox` - resource compiler
- `aui.uitests` - UI testing based on GTest
- `aui.views` - UI toolkit
- `aui.xml` - XML parser
## Feature support
- `-` equals unsupported
- `?` equals planned
- `+` equals almost completely supported
- `#` equals fully supported
| Feature or module | Windows Vista+ | Windows XP | Linux | Android | MacOS | iOS |
|-------------------|----------------|------------|-------|---------|-------|-----|
| aui.core | # | # | # | # | # | # |
| aui.crypt | # | # | # | # | # | # |
| aui.curl | # | # | # | # | # | # |
| aui.image | # | # | # | # | # | # |
| aui.json | # | # | # | # | # | # |
| aui.network | # | # | # | # | + | + |
| aui.toolbox | # | # | # | - | # | - |
| aui.views | # | ? | + | + | + | + |
| aui.xml | # | # | # | # | # | # |
| Assets | # | # | # | # | + | + |
| Filesystem | # | # | # | # | + | + |
| Process creation | # | # | # | - | ? | - |
| Compiler | Support |
|------------------------------|---------------|
| MSVC 19+ (Visual Studio 20+) | Full |
| gcc (8+) | Full |
| MinGW (8+) | Won't compile |
| Cross-compile MinGW | Won't compile |
| clang | Full |
## Used libraries
- [libcurl](https://curl.se/) for http/https requests
- [OpenSSL](https://github.com/openssl/openssl) for encryption
- `OpenGL` as graphics hardware acceleration backend
- [glm](https://github.com/g-truc/glm) for linear algebra
- [stbimage](https://github.com/nothings/stb) for image loading
- [freetype2](https://github.com/freetype/freetype) for font rendering
- [LunaSVG](https://github.com/sammycage/lunasvg) for SVG rendering
- [GTest](https://github.com/google/googletest) for unit testing
- [Google Benchmark](https://github.com/google/benchmark) for benchmark testing
## IDE Plugins
[Refer to documentation page](https://aui-framework.github.io/develop/md_docs_IDE_plugins)
## Projects using AUI
- [AUI Telegram Client](https://github.com/aui-framework/telegram_client)
- [Magicsea Online](https://magicseaonline.com/)
- [Amplitude Studio](https://studio.amplitudeaudiosdk.com)
## Examples
Check the `examples/` folder.
# Licensing
Please refer to [LICENSE](https://github.com/aui-framework/aui/blob/master/LICENSE).
Our project is published under Mozilla Public License Version 2.0 (the License). In short, you can use AUI for free in
your private (i.e, that does not go outside your company) projects.
If you would like to publish your project (including, but not limited to: sell, sign, release in software stores like
Google Play or App Store), does not matter open source, closed source or proprietary, the License obligates you to:
- Mention your project uses "AUI Framework" in your legal notice.
- Release your changes to AUI (if any) under the same terms (the License).
As for the latter, you are welcome to upstream your changes (i.e., propose your changes to
[this repository](https://github.com/aui-framework/aui)). If you decided to not do so, please keep in mind that the
License allows us to take your changes and upstream them.
You are not obligated to disclose your own sources nor release your own project under the same terms (License).
# Maintaining
The AUI framework is maintained by Alexey Titov ([Alex2772](https://github.com/Alex2772), alex2772sc 'at' gmail.com)
with contributions from many other people.
Let us know if your contribution is not listed or mentioned incorrectly, and we'll make it right.
## Contributing
You are welcome to open issues and pull requests on our GitHub repository. This project is maintained by a team of
volunteers on a reasonable-effort basis. As such, we can accept your issue, but we can't guarantee resolution. It's all
depends on severity and our own needs. In fact, we'd be happy if you submit a pull request. In this case we'll do our
best to help you merge your changes to upstream.
Please refer to [CONTRIBUTING.md](https://github.com/aui-framework/aui/blob/master/CONTRIBUTING.md)