Add attributes variable to templates #2292

koertho · 2020-09-14T07:04:46Z

Q	A
Address	https://contao.slack.com/archives/CK4J0KNDB/p1599547582289200

This litte PR adds an attributes variable to the body tag to add custom (data) attributes to the body tag without the need to complete override the fe_page template. As this is a very small addition, I would love to see this also merged in the contao 4.9 and 4.4 branch.

Usage example:

/**
 * @Hook("generatePage")
 */
class GeneratePageListener
{
    public function __invoke(PageModel $pageModel, LayoutModel $layout, PageRegular $pageRegular): void
    {

        $pageRegular->Template->attributes = $pageRegular->Template->attributes
            ? $pageRegular->Template->attributes .' data-custom-attribute="myCustomAttribute"'
            : 'data-custom-attribute="myCustomAttribute"';
    }
}

Update:
After discussion this pull request also adds the attributes variable to block templates and all module and element template not inheriting from block templates.

fritzmg

I am in favor of this - however I would like this to be expanded to other templates as well, e.g.

block_searchable
block_unsearchable

and any template that does not inherit from the block templates, e.g. ce_headline for example.

<<?= $this->hl ?> class="<?= $this->class ?>"<?= $this->cssID ?><?php if ($this->style): ?> style="<?= $this->style ?>"<?php endif; ?><?= $this->attributes ?>>
  <?= $this->headline ?>
</<?= $this->hl ?>>

Although technically you could (mis)use $this->cssID for that purpose in those templates.

fritzmg · 2020-09-15T08:52:36Z

core-bundle/src/Resources/contao/templates/frontend/fe_page.html5

@@ -21,7 +21,7 @@
  <?php $this->endblock(); ?>

 </head>
-<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage">
+<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage"<?php if ($this->attributes): ?> <?= $this->attributes ?><?php endif; ?>>


Suggested change

<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage"<?php if ($this->attributes): ?> <?= $this->attributes ?><?php endif; ?>>

<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage"<?= $this->attributes ?>>

I think it should be without a space, as the same concept is used in a few other templates already.

I changed it in my latest commit.

asaage · 2020-09-15T11:24:09Z

There would still be a subpalette or wizard required to make use of that right?
I suggested that a long time ago but can't find the issue anymore.
The response was more or less: "make it an extension!" (which i never did)

fritzmg · 2020-09-15T11:57:40Z

There would still be a subpalette or wizard required to make use of that right?

Not necessarily. I'd just use it in an parseTemplate hook.

koertho · 2020-09-15T14:41:58Z

@fritzmg Should I adjust the other template in this pull request or an follow up?

fritzmg · 2020-09-15T14:49:15Z

Just do it in this one :)

fritzmg · 2020-10-07T08:28:43Z

@contao/developers wdyt?

m-vo · 2020-10-07T10:01:14Z

I think the name $attributes might be a bit misleading as the other things like $class, $style, $onload, … are also attributes. Also - without knowing the details - I'd assume that they contain all attributes (probably as an array and not already rendered). Wdyt?

Speaking of the last: I think we shouldn't introduce more precompiled things to the templates. Associative data should imo be in an array. If it gets to cumbersome to output there can still be a template function. Similar story in the Figure: old/prerendered vs new/expanded in template.

Idk, brainstorming:

$pageRegular->Template->attributes['data-custom'] = 'customThing';

<?php echo $this->expand($this->attributes); ?>                // data-custom="customThing" foo="f" bar="b"
<?php echo $this->expand($this->attributes, 'foo', 'bar'); ?>  // foo="f" bar="b"

fritzmg · 2020-10-07T11:26:05Z

I think the name $attributes might be a bit misleading as the other things like $class, $style, $onload, … are also attributes. Also - without knowing the details - I'd assume that they contain all attributes (probably as an array and not already rendered). Wdyt?

While I agree, the fact is that it is already used this way in Contao. This PR would just expand that concept to all other templates.

Speaking of the last: I think we shouldn't introduce more precompiled things to the templates. Associative data should imo be in an array. If it gets to cumbersome to output there can still be a template function. Similar story in the Figure: old/prerendered vs new/expanded in template.

Idk, brainstorming:
$pageRegular->Template->attributes['data-custom'] = 'customThing';
<?php echo $this->expand($this->attributes); ?>                // data-custom="customThing" foo="f" bar="b"
<?php echo $this->expand($this->attributes, 'foo', 'bar'); ?>  // foo="f" bar="b"

👍 :)

koertho added 2 commits September 14, 2020 08:51

add attributes variable to fe_page template in body tag

fa288c2

fix codestyle

dad0e2b

fritzmg reviewed Sep 15, 2020

View reviewed changes

leofeyer assigned koertho Sep 15, 2020

leofeyer added the feature label Sep 15, 2020

added attributes variable to all ce and mod templates

8e95287

koertho changed the title ~~Add attributes variable to fe_page template in body tag~~ Add attributes variable to templates Sep 16, 2020

koertho requested a review from fritzmg October 7, 2020 08:04

Base automatically changed from master to 4.x January 18, 2021 15:42

leofeyer added the stale label Nov 9, 2021

stale bot closed this Nov 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add attributes variable to templates #2292

Add attributes variable to templates #2292

koertho commented Sep 14, 2020 •

edited

fritzmg left a comment

fritzmg Sep 15, 2020

koertho Sep 16, 2020

asaage commented Sep 15, 2020

fritzmg commented Sep 15, 2020

koertho commented Sep 15, 2020

fritzmg commented Sep 15, 2020

fritzmg commented Oct 7, 2020

m-vo commented Oct 7, 2020

fritzmg commented Oct 7, 2020

	<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage"<?php if ($this->attributes): ?> <?= $this->attributes ?><?php endif; ?>>
	<body id="top"<?php if ($this->class): ?> class="<?= $this->class ?>"<?php endif; ?><?php if ($this->onload): ?> onload="<?= $this->onload ?>"<?php endif; ?> itemscope itemtype="http://schema.org/WebPage"<?= $this->attributes ?>>

Add attributes variable to templates #2292

Add attributes variable to templates #2292

Conversation

koertho commented Sep 14, 2020 • edited

fritzmg left a comment

Choose a reason for hiding this comment

fritzmg Sep 15, 2020

Choose a reason for hiding this comment

koertho Sep 16, 2020

Choose a reason for hiding this comment

asaage commented Sep 15, 2020

fritzmg commented Sep 15, 2020

koertho commented Sep 15, 2020

fritzmg commented Sep 15, 2020

fritzmg commented Oct 7, 2020

m-vo commented Oct 7, 2020

fritzmg commented Oct 7, 2020

koertho commented Sep 14, 2020 •

edited