Kirigami Addons

Introduction

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 Develop.

Most common components

Kirigami Addons provides several QML modules. Each module may contain one or multiple components.

The following components are either commonly used or serve as entrypoints for using other API in their respective modules:

• Components Module
  • AlbumMaximizeComponent
  • SearchPopupField
• Date and Time Module
  • TimePopup
  • DatePopup
• Delegates Module
  • IndicatorItemDelegate
  • RoundedItemDelegate
  • RoundedTreeDelegate
• Form Card Module
  • AboutKDE
  • AboutPage
  • FormCard
  • FormHeader
  • FormCardPage
• Categorized Settings Module
  • CategorizedSettings
  • SettingAction
• Sounds Module
  • SoundsPicker
• TreeView Module
  • TreeViewDecoration

List of modules and components

Each component can be used with an import statement following this pattern:

import org.kde.kirigamiaddons.<module_name> <version>

Starting with Qt6, the version is optional.

The following list can be used to check which component belongs to which module:

org.kde.kirigamiaddons.components

• AbstractMaximizeComponent
• AlbumMaximizeComponent
• AlbumModelItem
• Avatar
• AvatarButton
• FloatingButton
• DoubleFloatingButton
• ImageMaximizeDelegate
• VideoMaximizeDelegate
• SearchPopupField

org.kde.kirigamiaddons.dateandtime

• DatePicker
• DatePopup
• TimePicker

org.kde.kirigamiaddons.delegates

• IndicatorItemDelegate
• RoundedItemDelegate
• RoundedTreeDelegate

org.kde.kirigamiaddons.formcard

• AboutKDE
• AboutPage
• AbstractFormDelegate
• FormArrow
• FormButtonDelegate
• FormCard
• FormCardPage
• FormCheckDelegate
• FormComboBoxDelegate
• FormDateTimeDelegate
• FormDelegateBackground
• FormDelegateSeparator
• FormGridContainer
• FormHeader
• FormRadioDelegate
• FormSectionText
• FormSpinBoxDelegate
• FormSwitchDelegate
• FormTextDelegate
• FormTextFieldDelegate

org.kde.kirigamiaddons.settings

• CategorizedSettings
• SettingAction

org.kde.kirigamiaddons.sounds

• SoundsPicker

org.kde.kirigamiaddons.treeview

• TreeViewDecoration

  License(s)

  LGPLv2