Toggle the table of contents

Kirigami: Difference between revisions

From KDE Community Wiki

Latest revision as of 16:10, 22 August 2023

Introduction

Kirigami is KDE’s powerful but lightweight user interface framework for mobile and convergent applications. It allows Qt developers to easily create applications that run on most major mobile and desktop platforms without modification (though adapted user interfaces for different form-factors are supported and recommended for optimal user experience). It extends the touch-friendly Qt Quick Controls 2 with larger application building blocks, following the design philosophy laid out in the KDE Human Interface Guidelines.

You can try out Kirigami in action with the Kirigami Gallery app which is available on most Linux distributions. On Android, you can download it from Google Play Store. The source code of kirigami-gallery can be found at this Git repository.

Kirigami uses CMake as its build system of choice. If you're unfamiliar with CMake, the CMake Manual for Qt is a good starting point to learn more about it.

Get It!

Kirigami is part of KDE Frameworks and is released together with other frameworks every month. In most cases, you'll want to use your Linux distribution's packages. You can also find source tarballs for the latest stable releases from download.kde.org. If you want to get the latest version of the source code, you can clone Kirigami from this Git repository. Check out this handy guide to building software from source.

Documentation

The Kirigami framework is composed of QML components as well as C++ classes that power them. Documentation for both can be found on KDE's API Documentation website. Kirigami also follows KDE's Human Interface Guidelines for its visual appearance and behavior.

COMING SOON: Kirigami Documentation. Watch this space.

Get in Touch

Have a burning question about Kirigami? You can find us up on the Libera Chat IRC server at the #kde-kirigami channel or on Matrix.

The team also has a shiny new dedicated mailing list for all things Kirigami, but older emails have also been archived on the KDE and Plasma development mailing lists as well.

For bugs, please use the KDE bug tracker so we can keep tabs on issues better.

Important Links

Source Code:
Documentation
- API documentation
- Coming Soon Kirigami Documentaiton
- KDE Human Interface Guidelines
Communication
- IRC: #kde-kirigami on irc.libera.chat
- Telegram: Telegram group
- Matrix: Kirigami on Matrix
- Mailing lists:
- Bugs: KDE Bug tracker

Retrieved from "https://community.kde.org/index.php?title=Kirigami&oldid=98015"

@@ Line 1: / Line 1: @@
-{{Note | Placeholder page for future Kirigami project landing page}}
+== Introduction ==
-= Introduction =
 [https://kde.org/products/kirigami/ Kirigami] is KDE’s powerful but lightweight user interface framework for mobile and convergent applications. It allows Qt developers to easily create applications that run on most major mobile and desktop platforms without modification (though adapted user interfaces for different form-factors are supported and recommended for optimal user experience). It extends the touch-friendly [http://doc.qt.io/qt-5/qtquickcontrols-index.html Qt Quick Controls 2] with larger application building blocks, following the design philosophy laid out in the [https://hig.kde.org/ KDE Human Interface Guidelines].
@@ Line 9: / Line 7: @@
 Kirigami uses CMake as its build system of choice. If you're unfamiliar with CMake, the [http://doc.qt.io/qt-5/cmake-manual.html CMake Manual for Qt] is a good starting point to learn more about it.
-= Get It! =
+== Get It! ==
 Kirigami is part of [[Frameworks|KDE Frameworks]] and is released together with other frameworks every month. In most cases, you'll want to use your Linux distribution's packages. You can also find source tarballs for the latest stable releases from [https://download.kde.org/stable/frameworks/ download.kde.org]. If you want to get the latest version of the source code, you can clone Kirigami from [https://cgit.kde.org/kirigami.git/ this Git repository]. Check out this [[Guidelines_and_HOWTOs/Build_from_source|handy guide]] to building software from source.
-= Documentation =
+== Documentation ==
 The Kirigami framework is composed of QML components as well as C++ classes that power them. Documentation for both can be found on [https://api.kde.org/frameworks/kirigami/html/index.html KDE's API Documentation] website. Kirigami also follows KDE's [https://hig.kde.org/ Human Interface Guidelines] for its visual appearance and behavior.
@@ Line 19: / Line 17: @@
 '''COMING SOON:''' Kirigami Documentation. Watch this space.
-= Get in Touch =
+== Get in Touch ==
-Have a burning question about Kirigami? You can find us up on the Freenode IRC server at the [http://webchat.freenode.net/?channels=kde-kirigami #kde-kirigami] channel or on
+Have a burning question about Kirigami? You can find us up on the Libera Chat IRC server at the [https://web.libera.chat/#kde-kirigami #kde-kirigami] channel or on [https://webchat.kde.org/#/room/#kirigami:kde.org Matrix].
-[https://telegram.me/joinchat/BbOuVj6l7b5aZ_WbupyFFw Telegram] and [https://webchat.kde.org/#/room/#kirigami:kde.org Matrix] (channels are bridged and messages are mirrored to each other).
 The team also has a shiny new [https://mail.kde.org/mailman/listinfo/kirigami dedicated mailing list] for all things Kirigami, but older emails have also been archived on the  [https://mail.kde.org/mailman/listinfo/kde-devel KDE] and [https://mail.kde.org/mailman/listinfo/plasma-devel Plasma] development mailing lists as well.
@@ Line 28: / Line 25: @@
 For bugs, please use the KDE [https://bugs.kde.org/describecomponents.cgi?product=frameworks-kirigami bug tracker] so we can keep tabs on issues better.
-= Important Links =
+== Important Links ==
 * Source Code:
@@ Line 39: / Line 36: @@
 ** [https://hig.kde.org/ KDE Human Interface Guidelines]
 * Communication
-** IRC: [http://webchat.freenode.net/?channels=kde-kirigami #kde-kirigami on irc.freenode.net]
+** IRC: [https://web.libera.chat/#kde-kirigami #kde-kirigami on irc.libera.chat]
 ** Telegram: [https://telegram.me/joinchat/BbOuVj6l7b5aZ_WbupyFFw Telegram group]
 ** Matrix: [https://webchat.kde.org/#/room/#kirigami:kde.org Kirigami on Matrix]
@@ Line 46: / Line 43: @@
 *** [https://mail.kde.org/mailman/listinfo/kde-devel Mailing list for general KDE development discussion]
 *** [https://mail.kde.org/mailman/listinfo/plasma-devel Former mailing list for Kirigami development]
-** Bugs: https://bugs.kde.org/ KDE Bug tracker]
+** Bugs: [https://bugs.kde.org/ KDE Bug tracker]