Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

ConfigurationModule QML Type

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

• Import Statement: import org.kde.kirigamiaddons.settings
• Inherited By: ShortcutsConfigurationModule and SpellcheckingConfigurationModule

#Detailed Description

#Property Documentation

#[default: "_main_category"] category : string

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.

#[read-only] icon : Private.ActionIconGroup

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
    };
}

#[required] moduleId : string

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.

#[required] page : var

This property holds a function that returns a Component.

#[required] text : string

This property holds the name of the module.

This will be displayed in the list of modules.

#[default: true] visible : bool

This property holds whether the module is visible.