Kirigami Addons
Reusable controls and visual components for Kirigami applications..
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 Qt module's C++ API requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.
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
- Kirigami Addons App C++ Classes
- Kirigami Addons FormCard QML Types
- Kirigami Addons Delegates QML Types
- Kirigami Addons Settings QML Types
- Kirigami Addons TreeView QML Types
- Kirigami Addons TableView QML Types
- Kirigami Addons Components QML Types
- Kirigami Addons Components (Labs) QML Types
- Kirigami Addons Sounds QML Types
- Kirigami Addons Actions QML Types
- Kirigami Addons Actions (Labs) QML Types
- Kirigami Addons Onboarding QML Types
Examples
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.