Skip to content

Commit 3df660f

Browse files
authored
[TASK] Migrate dependsOnSubmodules to appearance array (#6134)
References: TYPO3-Documentation/Changelog-To-Doc#1379 Releases: main
1 parent ea26a29 commit 3df660f

File tree

1 file changed

+25
-26
lines changed
  • Documentation/ApiOverview/Backend/BackendModules/ModuleConfiguration

1 file changed

+25
-26
lines changed

Documentation/ApiOverview/Backend/BackendModules/ModuleConfiguration/Index.rst

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,33 @@ Module configuration options
8282
:name: backend-module-appearance
8383
:type: array
8484

85-
Allows to define additional appearance options. Currently only
86-
:confval:`backend-module-appearance-renderInModuleMenu` is available.
85+
Allows to define additional appearance options.
8786

88-
.. confval:: appearance.renderInModuleMenu
89-
:name: backend-module-appearance-renderInModuleMenu
90-
:type: bool
87+
.. confval:: appearance.dependsOnSubmodules
88+
:name: backend-module-appearance-dependsOnSubmodules
89+
:type: bool
90+
:Default: false
91+
92+
.. versionadded:: 14.0
93+
94+
If true, the module will only be displayed in the module menu if at least one of its
95+
`submodules <https://docs.typo3.org/permalink/t3coreapi:backend-modules-third-level-module>`_
96+
is available to the current user.
97+
98+
If all submodules are either disabled, removed, or the user lacks access
99+
permissions to them, the parent module will automatically be hidden from
100+
the module menu.
101+
102+
The :guilabel:`Content > Info` module leverages this feature to seamlessly disappear
103+
from the module menu when extensions are uninstalled or users lack permissions
104+
to access its submodules, preventing dead-end navigation paths and enhancing
105+
the overall backend experience.
106+
107+
.. confval:: appearance.renderInModuleMenu
108+
:name: backend-module-appearance-renderInModuleMenu
109+
:type: bool
91110

92-
If set to false the module is not displayed in the module menu.
111+
If set to false the module is not displayed in the module menu.
93112

94113
.. confval:: iconIdentifier
95114
:name: backend-module-iconIdentifier
@@ -212,26 +231,6 @@ Module configuration options
212231
:language: php
213232
:caption: Excerpt of EXT:my_extension/Configuration/Backend/Modules.php
214233

215-
.. confval:: dependsOnSubmodules
216-
:name: backend-module-dependsOnSubmodules
217-
:type: bool
218-
:Default: false
219-
220-
.. versionadded:: 14.0
221-
222-
If true, the module will only be displayed in the module menu if at least one of its
223-
`submodules <https://docs.typo3.org/permalink/t3coreapi:backend-modules-third-level-module>`_
224-
is available to the current user.
225-
226-
If all submodules are either disabled, removed, or the user lacks access
227-
permissions to them, the parent module will automatically be hidden from
228-
the module menu.
229-
230-
The :guilabel:`Web > Info` module leverages this feature to seamlessly disappear
231-
from the module menu when extensions are uninstalled or users lack permissions
232-
to access its submodules, preventing dead-end navigation paths and enhancing
233-
the overall backend experience.
234-
235234
.. confval:: routeOptions
236235
:name: backend-module-routeOptions
237236
:type: array

0 commit comments

Comments
 (0)