Skip to content

Commit 26a9117

Browse files
authored
[TASK] Display warning for internal ViewHelpers (#629)
1 parent 7c48769 commit 26a9117

File tree

4 files changed

+1213
-0
lines changed

4 files changed

+1213
-0
lines changed

packages/typo3-docs-theme/resources/template/body/directive/viewhelper.html.twig

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
{{ docTag }}
99
</article>
1010
</div>
11+
{% elseif key == '@internal' %}
12+
<div class="admonition warning" role="alert">
13+
<p class="admonition-title">Internal</p>
14+
<p>This ViewHelper is marked as internal. It is subject to be
15+
changed without notice. Use at your own risk.</p>
16+
</div>
17+
{% elseif key == '@api' %}
1118
{% else %}
1219
<p>{{ key }}: {{ docTag }}</p>
1320
{% endif %}

tests/Integration/tests/viewhelper/expected/index.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,23 @@ <h2>Source code</h2>
275275
</p>
276276

277277

278+
</section>
279+
<section class="section" id="formvh-be-maximumfilesize">
280+
<h2>formvh:be.maximumFileSize<a class="headerlink" href="#formvh-be-maximumfilesize" data-bs-toggle="modal" data-bs-target="#linkReferenceModal" title="Reference this headline"></a></h2>
281+
<div class="admonition warning" role="alert">
282+
<p class="admonition-title">Internal</p>
283+
<p>This ViewHelper is marked as internal. It is subject to be
284+
changed without notice. Use at your own risk.</p>
285+
</div>
286+
287+
288+
<p>Return the max file size for use in the form editor</p>
289+
290+
<p>Scope: backend</p>
291+
292+
293+
294+
278295
</section>
279296
</section>
280297
<!-- content end -->

tests/Integration/tests/viewhelper/input/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,10 @@ f:deprecated
1919

2020
.. typo3:viewhelper:: deprecated
2121
:source: resources/global_viewhelpers_demo.json
22+
23+
24+
formvh:be.maximumFileSize
25+
=========================
26+
27+
.. typo3:viewhelper:: be.maximumFileSize
28+
:source: resources/Form.json

0 commit comments

Comments
 (0)