Spreadable Link Attributes

[ryanleichty]

The getLink method on Link Fields is helpful in cases where you have a lot of attributes that you don't want to remember to manually account for every time you render a link. However, in cases where the markup is more complex, you'll often need to manually render everything anyway.

It would be great if LinkData had an attributes property that you could spread:

<a {{ attr(link.attributes) }}>My text</a>

{# or #}

{{ tag('a', {
  ...link.attributes,
  text: 'My text'
}) }}

There's a Discord thread where this was discussed in more detail.

[brandonkelly]

Added for 5.9! (2935990)

[ryanleichty]

Woohoo, thank you! 🔥

[ryanleichty]

I might be misunderstanding this, but wouldn't this also need href included in the returned attributes?

[brandonkelly]

The URL is passed into Html::a() separately from the $options array, so it didn’t make sense to include it here. You can fetch it via entry.myLinkField.url.

[ryanleichty]

What if you skipped the URL since it's optional:

Html::a(Html::encode($label !== '' ? $label : $url), options: $this->getAttributes())

And then just include it in getAttributes which is passed as the options (just like what Html::a() does under the hood):

return [
    'href' => UrlHelper::url($url),
    'target' => $this->target,
    'title' => $this->title,
    'class' => $this->class,
    'id' => $this->id,
    'rel' => $this->rel,
    'aria' => [
        'label' => $this->ariaLabel,
    ],
    'download' => $this->download ? ($this->filename ?? true) : false,
];

That way getAttributes truly gets all attributes. You're otherwise getting the exact same results but with slightly less boilerplate.

Either way, it's not a huge difference in implementation, so happy with either conclusion!

<a {{ attr(link.attributes) }}>My text</a>

{# or #}

<a href="{{ link.url }}" {{ attr(link.attributes) }}>My text</a>

[brandonkelly]

Yeah good call. Just changed that (7e0eb0d).