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 --> 0006 0007 # Kirigami Addons 0008 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). 0012 0013 The API can be found in the [KDE API Reference website](https://api.kde.org/frameworks/kirigami-addons/html/index.html). 0014 0015 ## Components 0016 0017 Kirigami Add-ons contains many components, which are set up like so: 0018 0019 * General components that don't fit anywhere else, located under [src/components](src/components). 0020 * Date and Time components, located under [src/dateandtime](src/dateandtime). 0021 * Delegate components, located under [src/delegates](src/delegates). 0022 * FormCard components (formerly known as MobileForm), located under [src/formcard](src/formcard). 0023 * Categorized Settings components, located under [src/settings](src/settings). 0024 * Sound picker component for picking ringtones and notifications, located under [src/sounds](src/sounds). 0025 * TreeView component, located under [src/treeview](src/treeview). 0026 0027 ### See Also 0028 0029 If you can't find what you're looking for, it may exist in another repository instead: 0030 0031 * [Kirigami](https://invent.kde.org/frameworks/kirigami) is the QtQuick based components set that Kirigami Add-ons 0032 builds on top of. 0033 * [Kirigami Gallery](https://invent.kde.org/sdk/kirigami-gallery) is a gallery application used to showcase and test 0034 various Kirigami components. 0035 0036 ## Scope and Structure 0037 0038 To avoid this module losing scope as we have seen in other generic addons modules before, Kirigami Addons 0039 has clearly defined rules for things to go in here: 0040 0041 - Kirigami Addons is cross-platform, depending on other KF5 frameworks is fine, but things must still work on Android. 0042 Components can use platform specializations, e.g. native dialogs, but a generic implementation for all platforms has 0043 to exist. 0044 0045 - Components are grouped according to some topic, e.g. 'dateandtime' or 'chat'. 0046 Each group has its own source directory and QML import name. The name follows the scheme of 0047 'org.kde.kirigamiaddons.topic', e.g. 'org.kde.kirigamiaddons.dateandtime'. 0048 0049 - All user exposed QML items should have an example application in the tests folder. 0050 0051 In particular, Kirigami Addons is not: 0052 0053 - A place for exposing non-visual QML bindings. 0054 - A place for QML bindings for other libraries. 0055 - A place for API for a specific platform. 0056 0057 ## Building 0058 0059 The easiest way to make changes and test Kirigami Add-ons during development is 0060 to [build it with kdesrc-build](https://community.kde.org/Get_Involved/development/Build_software_with_kdesrc-build). 0061 0062 ## Contributing 0063 0064 Like other projects in the KDE ecosystem, contributions are welcome from all. This repository is managed 0065 in [KDE Invent](https://invent.kde.org/libraries/kirgiami-addons), our GitLab instance. 0066 0067 * Want to contribute code? See the [GitLab wiki page](https://community.kde.org/Infrastructure/GitLab) for a tutorial on 0068 how to send a merge request. 0069 * Reporting a bug? Please submit it on 0070 the [KDE Bugtracking System](https://bugs.kde.org/enter_bug.cgi?format=guided&product=kirigami-addons). Please do not 0071 use the Issues 0072 tab to report bugs. 0073 * Is there a part of Kirigami Add-ons that's not translated? See 0074 the [Getting Involved in Translation wiki page](https://community.kde.org/Get_Involved/translation) to see how 0075 you can help translate! 0076 0077 If you get stuck or need help with anything at all, head over to 0078 the [KDE New Contributors room](https://go.kde.org/matrix/#/#kde-welcome:kde.org) on Matrix. For questions about 0079 Kirigami Add-ons, please ask in the [Kirigami room](https://go.kde.org/matrix/#/#kirigami:kde.org). 0080 See [Matrix](https://community.kde.org/Matrix) for more details. 0081