Confirmed users
502
edits
Gaia/Settings/docs: Difference between revisions
Jump to navigation
Jump to search
→Panel
(→Panel) |
|||
| Line 20: | Line 20: | ||
All panels are delay loaded. HTML elements of a panel are created and appended to the DOM tree only when users navigate to the panel. Settings app then loads the associated module of the panel and execute it. | All panels are delay loaded. HTML elements of a panel are created and appended to the DOM tree only when users navigate to the panel. Settings app then loads the associated module of the panel and execute it. | ||
The associated module is usually deriving from '''SettingsPanel''' or '''Panel'''. '''Panel''' provides the basic functionality that allows settings app to control the visibility and life cycle. In addition to that, '''SettingsPanel''' further creates bindings between the UI elements and the settings database when the module is being initialized. Details of creating an associated module please refer to [https://github.com/mozilla-b2g/gaia/tree/master/apps/settings#modulepaneljs here]. | The associated module is usually deriving from "'''SettingsPanel'''"(js/modules/settings_panel.js) or "'''Panel'''"(js/modules/panel.js). '''Panel''' provides the basic functionality that allows settings app to control the visibility and life cycle. In addition to that, '''SettingsPanel''' further creates bindings between the UI elements and the settings database when the module is being initialized. Details of creating an associated module please refer to [https://github.com/mozilla-b2g/gaia/tree/master/apps/settings#modulepaneljs here]. | ||
=== Panel Navigation === | === Panel Navigation === | ||
'''navigate#SettingsService''' is used to navigate to any panel by providing the panel id and the options to be passed to the panel. Note that this function behaves like an url link and there is no way for the target panel to return any result. If you would like to share information among panels, you must create a shared module that can be used in the panels, or consider to use '''DialogService''' which allows to return results. | '''navigate#SettingsService''' is used to navigate to any panel by providing the panel id and the options to be passed to the panel. Note that this function behaves like an url link and there is no way for the target panel to return any result. If you would like to share information among panels, you must create a shared module that can be used in the panels, or consider to use '''DialogService''' which allows to return results. | ||