COSMIC keyboard layout

Protocol to control keyboard layout group

This protocol notifies clients of the active keyboard layout group, and allows setting a new value.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

keyboard layout manager

Manager for creating `zcosmic_keyboard_layout_v1` instances.

get_keyboard_layout(keyboard_layout: new_id<zcosmic_keyboard_layout_v1>, keyboard: object<wl_keyboard>)
Get keyboard layout object

Create a `zcosmic_keyboard_layout_v1` to get and set group for given keyboard.

destroy()
delete this object

Object to get and set `group` for a particular `wl_keyboard`.

set_group(group: uint)
Argument
Type
Description
groupuint
set layout group

On success, the `group` event will be generated for all clients, and the focused client will receive `wl_keyboard::modifiers` with the new group.

The request will be ignored if `group` is out of bounds.

destroy()
delete this object
group(group: uint)
Argument
Type
Description
groupuint
layout group changed

Unlike `wl_keyboard::modifiers`, this event is received even when the client has no focused window.


Compositor Support

zcosmic_keyboard_layout_manager_v1↓
Compositors
CageCage0.3.0
x
COSMICCOSMIC1.11.0
1
flakewm3.0.5
x
GameScopeGameScope3.17.0
x
HyprlandHyprland0.57.2
x
Jay1.14.0
x
KWinKWin6.7
x
LabwcLabwc0.20.2
x
LouvreLouvre2.14.1
x
MangoMango0.16.3
x
MirMir2.26
x
MuffinMuffin6.7.4
x
MutterMutter51
x
niriniri26.04
x
phocphoc0.55
x
Pila0.5.1
x
QtileQtile0.37.1
x
riverriver0.5.0
x
SwaySway1.11
x
TreelandTreeland0.8.0
x
WayfireWayfire0.9.0
x
WestonWeston15.0.1
x

Copyright © 2026 System76, Inc

Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.