<hr> <div align="center"> <img src="https://github.com/saucer/saucer.github.io/blob/v7/src/assets/logo-alt.svg?raw=true" height="312" /> </div> <p align="center"> Build small, fast and modern cross-platform desktop apps with C++ & Web Technologies </p>

Documentation

The documentation can be found here.

Examples

Examples can be found here.

Getting started

Learn how to create your first saucer app here.

Community

Get in touch: Discord, Matrix

Mirrors

Saucer is available on: GitHub, Codeberg

</div>

👽 Introduction

Saucer is a modern C++ webview library that allows you to build cross-platform desktop applications with ease.
It supports all three major desktop operating systems (Windows, Linux, MacOS) and has several backend implementations.

🛸 Features

⚖️ FOSS

Licensed under MIT!
🪶 Lightweight

By using the operating systems native web renderer[^1], it is possible to create binaries as small as ~250KB
🔀 Seamless C++ / JavaScript interoperability

Convenient API (powered by reflection) to evaluate JavaScript Code or expose C++ functions to JavaScript!
> Example
👾 Feature-Rich

Supports custom schemes, script injection, favicons, and much more!
㊗️ Unicode Support
🚀 Coroutine Support

See Code Example below!
📦 Supports Embedding Frontend into binary

Ship a contained binary with ease!
> Documentation
🦺 Thread-Safe
🧨 No Exceptions[^3]

Compiles with -fno-exceptions!
🏃 No RTTI

Compiles with -fno-rtti!
🪟 Built-in support for frame-less windows and transparency

Supports data-webview attributes to allow effortless custom title-bars.
> Documentation
🧰 Customizable

Exposes platform specific implementations, making it possible to tweak the library to your hearts content!
> Documentation

Saucer also provides official extensions in the form of modules:

| Module | Description | | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | saucer/desktop | 📂 File-Picker, Mouse-Position retrieval and URI-Launch support <br> > Example | | saucer/pdf | 📄 Export current page as PDF <br> > Example | | saucer/loop | 🛞 "Legacy"[^2] loop implementation <br> > Example |
💻 Supports various backends
<table> <tr> <th>Platform</th> <th colspan="2">Backends</th> </tr> <tr> <td><b>Windows</b></td> <td>Win32 & WebView2</td> <td rowspan="3">Qt + QWebEngine</td> </tr> <tr> <td><b>Linux</b></td> <td>GTK4 & WebKitGtk</td> </tr> <tr> <td><b>MacOS</b></td> <td>Cocoa & WKWebView</td> </tr> </table>
🏗️ Bindings

Saucer also exposes a C-Interface, thus making it possible to write bindings for it in your favorite language!

| Language | Repository | | -------- | ------------------------------------ | | Java | https://github.com/saucer/saucer4j | | PHP | https://github.com/boson-php | | Rust | https://github.com/skjsjhb/saucers |

Please note: All bindings are community maintained!
🦥 ... and more!

[^1]: ... or a commonly used one

[^2]: For lack of a better word

[^3]: Saucer catches exceptions thrown in exposed functions - if not compiled with -fno-exceptions - by default. This can be explicitly disabled via set(saucer_exceptions OFF)

📦 Installation

<table> <tr> <th> <a href="https://github.com/cpm-cmake/CPM.cmake" target="_blank">CPM</a> </th> <th> FetchContent </th> </tr> <tr> <td>

CPMFindPackage(
  NAME           saucer
  VERSION        8.0.5
  GIT_REPOSITORY "https://github.com/saucer/saucer"
)

</td> <td>

FetchContent_Declare(
  saucer 
  GIT_TAG v8.0.5
  GIT_REPOSITORY "https://github.com/saucer/saucer" 
)

FetchContent_MakeAvailable(saucer)

</td> </tr> <tr> <td colspan="2">

Note: Replace <target> with your respective target:

</td> </tr> <tr> <td colspan="2">

target_link_libraries(<target> saucer::saucer)

</td> </tr> </table>

See the documentation for more information!

✍️ Code Example

#include <print>
#include <saucer/smartview.hpp>

coco::stray start(saucer::application *app)
{
    auto window  = saucer::window::create(app).value();
    auto webview = saucer::smartview::create({.window = window});

    window->set_title("Hello World!");
    window->set_size({.w = 800, .h = 600});

    webview->expose("add_demo", [&](double a, double b) -> coco::task<double>
    {
        co_return a + b + *co_await webview->evaluate<double>("Math.random()");
    });

    auto index = saucer::url::from("index.html");

    if (!index.has_value())
    {
        co_return std::println("{}", index.error());
    }

    webview->set_url(index.value());
    window->show();

    co_await app->finish();
}

int main()
{
    return saucer::application::create({.id = "example"})->run(start);
}

🔍 See more examples!

🍵 Buy me a tea

Saucer is a passion project and I develop it in my free-time. If you'd like to support me, consider sponsoring my tea-addiction 🫂

🌐 Who's using saucer?

| <img src="https://casterlabs.co/images/product/caffeinated/multi-chat.png" width="1000" /> | <img src="https://raw.githubusercontent.com/SamsidParty/TopNotify/main/Docs/Screenshot3.png" width="1250" /> | | :----------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------: | | Casterlabs - Caffeinated | TopNotify | | (Built on saucer4j) | (Built on their C# Saucer Bindings "IgniteView") |

</div> <br/>

🎉 Become part of this list!

⭐ Star History

Saucer is 100% human written. No AI-Tools were used in the development process.

Saucer

Install / Use

README