ConfigurationModule Class Reference

Inheritance diagram for ConfigurationModule:

Properties
string	category
PrivateActionIconGroup	icon
var	initialProperties
string	moduleId
var	page
string	text
bool	visible

Detailed Description

This object holds the information of configuration module.

Since

KirigamiAddons 1.3.0

Definition at line 9 of file ConfigurationModule.qml.

Property Documentation

category

string ConfigurationModule::category

read

This property holds the category of the module.

This will be 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.

Definition at line 58 of file ConfigurationModule.qml.

icon

PrivateActionIconGroup ConfigurationModule::icon

read

This property holds the icon of the module.

Remarks

This property is read-only

Definition at line 26 of file ConfigurationModule.qml.

initialProperties

var ConfigurationModule::initialProperties

read

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

Definition at line 50 of file ConfigurationModule.qml.

moduleId

string ConfigurationModule::moduleId

read

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

Primary use case if for setting a default module in ConfigDialog

Definition at line 16 of file ConfigurationModule.qml.

page

var ConfigurationModule::page

read

This property holds a function that returns a Component.

Definition at line 30 of file ConfigurationModule.qml.

text

string ConfigurationModule::text

read

This property holds the name of the module.

This will be displayed in the list of modules.

Definition at line 21 of file ConfigurationModule.qml.

visible

bool ConfigurationModule::visible

read

This property holds whether the module is visible.

Definition at line 34 of file ConfigurationModule.qml.

---

The documentation for this class was generated from the following file:

• ConfigurationModule.qml