Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mr-1311/wayland_layer_shell
A flutter plugin to create desktop components for Wayland using the Layer Shell protocol
https://github.com/mr-1311/wayland_layer_shell
Last synced: 10 days ago
JSON representation
A flutter plugin to create desktop components for Wayland using the Layer Shell protocol
- Host: GitHub
- URL: https://github.com/mr-1311/wayland_layer_shell
- Owner: Mr-1311
- License: mit
- Created: 2023-12-10T20:25:33.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-30T23:30:15.000Z (about 1 month ago)
- Last Synced: 2024-12-31T00:23:46.397Z (about 1 month ago)
- Language: Dart
- Size: 642 KB
- Stars: 11
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wayland_layer_shell
This plugin exposes the `zwlr_layer_shell_v1` protocol using the [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell) library, enabling the creation of desktop components such as panels, taskbars, application launchers, etc. with Flutter on Wayland systems.
## Supported Compositors
This plugin exclusively functions on Wayland and is compatible only with Wayland compositors that support the `zwlr_layer_shell_v1` protocol. The Layer Shell protocol is supported on:
- wlroots-based compositors (such as Sway, Hyprland, etc.)
- KDE Plasma on Wayland
- Mir-based compositors (some may not enable the protocol by default and require `--add-wayland-extension zwlr_layer_shell_v1`)
Layer Shell is not supported on:
- Gnome-on-Wayland
- Any X11 desktop
## Getting Started
Add this to your project's pubspec.yaml file:
```yaml
dependencies:
wayland_layer_shell: ^1.0.1
```
Using the gtk header bar and displaying the gtk window before initializing the layer surface prevents the initialization of the layer surface, hence some changes are required in Flutter's gtk window initialization code.
Update the file `linux/runner/my_application.cc` as follows:
```diff
...
// Implements GApplication::activate.
static void my_application_activate(GApplication* application) {
...
- gboolean use_header_bar = TRUE;
+ gboolean use_header_bar = FALSE;
...
gtk_window_set_default_size(window, 1280, 720);
- gtk_widget_show(GTK_WIDGET(window));
+ gtk_widget_realize(GTK_WIDGET(window));
g_autoptr(FlDartProject) project = fl_dart_project_new();
...
```
## Dependencies
This plugin relies on the [gtk-layer-shell-0](https://github.com/wmww/gtk-layer-shell/tree/master) library. Ensure that it is available on the platforms where apps using this plugin are installed. The library can be found in the repositories of major distributions: [Distro packages](https://github.com/wmww/gtk-layer-shell?tab=readme-ov-file#distro-packages)
## Usage
For usage check out the example app inside [example](./example) folder.