Warning, /libraries/kirigami-addons/README.md is written in an unsupported language. File is not indexed.

0001 <!--
0002 SPDX-FileCopyrightText: 2019 David Edmundson <kde@davidedmundson.co.uk>
0003 SPDX-FileCopyrightText: 2020 Nicolas Fella <nicolas.fella@gmx.de>
0004 SPDX-License-Identifier: CC-BY-SA-4.0
0005 -->
0007 # Kirigami Addons
0009 A set of "widgets" i.e visual end user components along with a code to support them.
0010 Components are usable by both touch and desktop experiences providing a native experience on both,
0011 and look native with any QQC2 style (qqc2-desktop-theme, Material or Plasma)
0013 ## Scope and Structure
0015 To avoid this module losing scope as we have seen in other generic addons modules before, Kirigami Addons
0016 has clearly defined rules for things to go in here:
0018 - Kirigami Addons is cross-platform, depending on other KF5 frameworks is fine, but things must still work on Android.
0019 Components can use platform specializations, e.g. native dialogs, but a generic implementation for all platforms has to exist.
0021 - Components are grouped according to some topic, e.g. 'dateandtime' or 'chat'.
0022 Each group has its own source directory and QML import name. The name follows the scheme of
0023 'org.kde.kirigamiaddons.topic', e.g. 'org.kde.kirigamiaddons.dateandtime'.
0025 - All user exposed QML items should have an example application in the tests folder.
0027 In particular, Kirigami Addons is not:
0028  - a place for exposing non-visual QML bindings
0029  - a place for QML bindings for other libraries
0030  - a place for API for a specific platform