ConfigurationModule QML Type

This object holds the information of configuration module. More...

Import Statement: import org.kde.kirigamiaddons.settings
Inherited By:

ShortcutsConfigurationModule and SpellcheckingConfigurationModule

Properties

Detailed Description

Property Documentation

category : string [default: "_main_category"]

This property holds the category of the module.

This is used to group modules together on mobile.

Do not overwrite the default value if you want your module to be grouped in the default category.


icon : Private.ActionIconGroup [read-only]

This property holds the icon of the module.


initialProperties : var

This property holds the initial property that the page needs to be initialized with if any.

This is a function that returns an Javascript object.

initialProperties: () => {
    return {
        room: root._room,
        connection: root._connection
    };
}

moduleId : string [required]

This property holds the id of the module for when it needs to be referenced.

Primary use case is for setting a default module in ConfigurationView.


page : var [required]

This property holds a function that returns a Component.


text : string [required]

This property holds the name of the module.

This will be displayed in the list of modules.


visible : bool [default: true]

This property holds whether the module is visible.