Kirigami Addons

Kirigami Addons is an additional set of visual components that work well on mobile and desktop and are guaranteed to be cross-platform.

It uses Kirigami under the hood to create its components and should look native with any QtQuick Controls style.

A tutorial for Kirigami Addons can be found over the KDE Developer Platform.

Using the Module

Using a KDE module's C++ API requires linking against the module library. The preferred way of consuming the library is through CMake.

Building with CMake

To import each Kirigami Addons QML module individually:

ecm_find_qmlmodule(org.kde.kirigamiaddons.formcard REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.delegates REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.settings REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.treeview REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.tableview REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.components REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.labs.components REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.sounds REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.actions REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.actions.labs REQUIRED)
ecm_find_qmlmodule(org.kde.kirigamiaddons.onboarding REQUIRED)

To import Kirigami Addons into your project using CMake:

find_package(KF6 REQUIRED COMPONENTS KirigamiAddons)

API Reference

Examples

Onboarding Tutorial

Licenses

Kirigami Addons is free software, licensed primarily under the GNU Lesser General Public License, so that it can be used by both free and proprietary software.

The project follows the REUSE specification: every file carries its own SPDX-License-Identifier, and the full text of each license in use is available in the LICENSES directory of the source repository.

Contents