Use fluid components by Alagts · Pull Request #6432 · TYPO3-Documentation/TYPO3CMS-Reference-CoreApi

Alagts · 2026-03-24T07:53:24Z

This commits should provide an introduction to usage of the Fluid components. In the next patch I will include the PSR-14 events and the file Namespaces.php.

I had to remove the PSR events, because otherwise the patch would be too big. I decided to separate them into smaller parts. I added the new changes from the main branch that come into it during the time of preparing the pr.

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

brotkrueml · 2026-03-24T08:13:03Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+..  code-block:: php
+    :caption: EXT:my_extension/Configuration/Fluid/ComponentCollections.php
+
+    <?php


Can we put this into a separate file? This way, the file is automatically formatted.

brotkrueml · 2026-03-24T08:13:55Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+
+All arguments that are passed to a component need to be defined with 
+:html:`<f:argument>` in the component template, for example 
+:file:`Navigation.fluid.html`. 


You mention "Navigation.fluid.html", but is there an example available where someone can see the <f:argument>s?

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

brotkrueml · 2026-03-24T08:15:01Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+
+    <?php
+
+    return [


Please use a full example so it is clear where to put this snippet.

brotkrueml · 2026-03-24T08:15:51Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+that it defines all of its arguments with the
+`Argument ViewHelper <f:argument> <https://docs.typo3.org/permalink/t3viewhelper:typo3fluid-fluid-argument>`_.
+The `Slot ViewHelper <f:slot> <https://docs.typo3.org/permalink/t3viewhelper:typo3fluid-fluid-slot>`_
+can be used to receive other HTML content. With the Slot ViewHelper it is possible to nest components.


Please link "Slot ViewHelper" to the Fluid VH docs.

Just before this line it is linked. :)

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

brotkrueml · 2026-03-24T08:19:06Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+Migration and co-existence with class-based collections
+-------------------------------------------------------
+
+Since TYPO3 v14 you should use the configuration-based component collections over 


I suggest to first create a PR for v13 and main. When this is merged/backported (and all work done for v13), then the v14 part should be worked on which is then merged only to main.

Otherwise you end up with documentation for v14 in v13 docs - which is not really ideal.

I'd argue that Fluid Components shouldn't really be documented for TYPO3 v13. The fact that they could be used in v13 was kind of a hack, now official support is added with v14, which is when this should be documented in the TYPO3 documentation.

Nevertheless, if you come from v13, there should be a place that shows how to migrate the old implementation to the new one.

Okay, fine for me. As a "Releases" line is lacking, it was not obvious for which branches the PR is meant.

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>

sarahmccarthy123

Looks good:-) Just a a few language suggestions

sarahmccarthy123 · 2026-03-24T12:35:55Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+Description
+-----------
+
+With version 4.3 the concept of components was introduced into Fluid.


Maybe this needs a ".. versionadded:: 14.3" instead of a description?

It is about Fluid, I think it is sufficient to just mention it in the text.

sarahmccarthy123 · 2026-03-24T12:36:57Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+Registering component collections
+---------------------------------
+
+In order to use Fluid components register a component collection


Suggested change

In order to use Fluid components register a component collection

In order to use Fluid components, register a component collection

sarahmccarthy123 · 2026-03-24T12:37:27Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+        ],
+    ];
+
+in which you define the path your Fluid components can be found.


Suggested change

in which you define the path your Fluid components can be found.

in which you define the path where your Fluid components can be found.

sarahmccarthy123 · 2026-03-24T12:38:00Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+    ];
+
+in which you define the path your Fluid components can be found.
+Components in that collections can then be used in any Fluid template.


Suggested change

Components in that collections can then be used in any Fluid template.

Components in these collections can then be used in any Fluid template.

sarahmccarthy123 · 2026-03-24T12:38:22Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+
+    <my:organism.header.navigation />
+
+Note that by default, component collections use a folder structure that


Suggested change

Note that by default, component collections use a folder structure that

Note that, by default, component collections use a folder structure that

sarahmccarthy123 · 2026-03-24T12:42:26Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+The `Slot ViewHelper <f:slot> <https://docs.typo3.org/permalink/t3viewhelper:typo3fluid-fluid-slot>`_
+can be used to receive other HTML content. With the Slot ViewHelper it is possible to nest components.
+
+Example: How you could define a Fluid component


Suggested change

Example: How you could define a Fluid component

Here is an example of how you could define a Fluid component:

sarahmccarthy123 · 2026-03-24T12:43:28Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+
+You can learn more about components in
+`Defining Components <https://docs.typo3.org/permalink/fluid:components-definition>`_. Note
+that this is part of the documentation of Fluid Standalone, which means that it doesn't mention


Suggested change

that this is part of the documentation of Fluid Standalone, which means that it doesn't mention

that this is part of the Fluid Standalone documentation, which means that it doesn't mention

sarahmccarthy123 · 2026-03-24T12:44:07Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+In TYPO3 v13 it is possible to use components in TYPO3 projects by creating a custom
+:php:`ComponentCollection` class that essentially connects a folder of template files
+to a Fluid ViewHelper namespace. Using that class it is also possible to use an
+alternative folder structure for a component collection and to allow passing


Suggested change

alternative folder structure for a component collection and to allow passing

alternative folder structure for a component collection and to allow

sarahmccarthy123 · 2026-03-24T12:44:24Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+:php:`ComponentCollection` class that essentially connects a folder of template files
+to a Fluid ViewHelper namespace. Using that class it is also possible to use an
+alternative folder structure for a component collection and to allow passing
+arbitrary arguments to components within that collection.


Suggested change

arbitrary arguments to components within that collection.

arbitrary arguments to be passed to components in that collection.

sarahmccarthy123 · 2026-03-24T12:46:01Z

Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

+a component collection. Since the configuration-based approach is not available in TYPO3 v13, 
+it is possible to ship both variants to provide backwards-compatibility: 
+if a specific component collection is
+defined both via class and via configuration, in TYPO3 v13 the class will be used,


Suggested change

defined both via class and via configuration, in TYPO3 v13 the class will be used,

defined both by class and by configuration, in TYPO3 v13 the class will be used,

This pr adds all new Fluid events needed as code snippets in the documentation. Releases: main

… to the top

Alagts added 3 commits March 17, 2026 16:24

Using Fluid components

46bfde6

Split commit in smaller parts

2a7d25a

Update branch with new changes from main

34d61e1

Alagts mentioned this pull request Mar 24, 2026

[FEATURE] Fluid components integration TYPO3-Documentation/Changelog-To-Doc#1531

Open

brotkrueml reviewed Mar 24, 2026

View reviewed changes

Alagts and others added 4 commits March 24, 2026 09:28

Update Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

c7f9ecd

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>

Update Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

1daa287

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>

Update Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

160acd9

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>

Update Documentation/ApiOverview/Fluid/UsingFluidInTypo3.rst

32de3e2

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>

sarahmccarthy123 reviewed Mar 24, 2026

View reviewed changes

Alagts and others added 4 commits March 24, 2026 15:59

Add codesnippets (TYPO3-Documentation#6433)

d660017

Add codesnippets for Fluid events (TYPO3-Documentation#6435)

b063e36

This pr adds all new Fluid events needed as code snippets in the documentation. Releases: main

Outsource ComponentsCollection.php, put Fluid components introduction…

4af1e10

… to the top

Resolve conflicts

53b4984

	In order to use Fluid components register a component collection
	In order to use Fluid components, register a component collection

	in which you define the path your Fluid components can be found.
	in which you define the path where your Fluid components can be found.

	Components in that collections can then be used in any Fluid template.
	Components in these collections can then be used in any Fluid template.


		<my:organism.header.navigation />

		Note that by default, component collections use a folder structure that

	Note that by default, component collections use a folder structure that
	Note that, by default, component collections use a folder structure that

	Example: How you could define a Fluid component
	Here is an example of how you could define a Fluid component:

	that this is part of the documentation of Fluid Standalone, which means that it doesn't mention
	that this is part of the Fluid Standalone documentation, which means that it doesn't mention

	alternative folder structure for a component collection and to allow passing
	alternative folder structure for a component collection and to allow

	arbitrary arguments to components within that collection.
	arbitrary arguments to be passed to components in that collection.

	defined both via class and via configuration, in TYPO3 v13 the class will be used,
	defined both by class and by configuration, in TYPO3 v13 the class will be used,

Conversation

Alagts commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sarahmccarthy123 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Alagts commented Mar 24, 2026 •

edited

Loading