Kirigami-addons Documentation

Kirigami Addons

A set of "widgets" i.e visual end user components along with a code to support them. Components are usable by both touch and desktop experiences providing a native experience on both, and look native with any QQC2 style (qqc2-desktop-theme, Material or Plasma).

The API can be found in the KDE API Reference website.


Kirigami Add-ons contains many components, which are set up like so:

See Also

If you can't find what you're looking for, it may exist in another repository instead:

Scope and Structure

To avoid this module losing scope as we have seen in other generic addons modules before, Kirigami Addons has clearly defined rules for things to go in here:

  • Kirigami Addons is cross-platform, depending on other KF5 frameworks is fine, but things must still work on Android. Components can use platform specializations, e.g. native dialogs, but a generic implementation for all platforms has to exist.
  • Components are grouped according to some topic, e.g. 'dateandtime' or 'chat'. Each group has its own source directory and QML import name. The name follows the scheme of 'org.kde.kirigamiaddons.topic', e.g. 'org.kde.kirigamiaddons.dateandtime'.
  • All user exposed QML items should have an example application in the tests folder.

In particular, Kirigami Addons is not:

  • A place for exposing non-visual QML bindings.
  • A place for QML bindings for other libraries.
  • A place for API for a specific platform.


The easiest way to make changes and test Kirigami Add-ons during development is to build it with kdesrc-build.


Like other projects in the KDE ecosystem, contributions are welcome from all. This repository is managed in KDE Invent, our GitLab instance.

If you get stuck or need help with anything at all, head over to the KDE New Contributors room on Matrix. For questions about Kirigami Add-ons, please ask in the Kirigami room. See Matrix for more details.

This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Sep 27 2023 03:57:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.