[Turbo] Add Twig Extensions

[seb-jean]

Q	A
Bug fix?	no
New feature?	yes
Issues	Fix #...
License	MIT

Hi,

I added Twig extension:

turbo_refresh_method

Configure method to perform page refreshes
For more information: https://turbo.hotwired.dev/handbook/page_refreshes#morphing

Usage

To use this Twig extension you must write:

{# templates/base.html.twig #}
{{ turbo_refresh_method() }}

{# renders as: #}
<meta name="turbo-refresh-method" content="replace">

The possible values are morph or replace (the default).

turbo_refresh_scroll

Configure scroll strategy for page refreshes.
For more information: https://turbo.hotwired.dev/handbook/page_refreshes#scroll-preservation

Usage

To use this Twig extension you must write:

{# templates/base.html.twig #}
{{ turbo_refresh_scroll() }}

{# renders as: #}
<meta name="turbo-refresh-scroll" content="reset">

The possible values are preserve or reset (the default).

turbo_refreshes_with

A combination of the 2 previous Twig extensions.

Usage

To use this Twig extension you must write:

{# templates/base.html.twig #}
{{ turbo_refreshes_with() }}

{# renders as: #}
<meta name="turbo-refresh-method" content="replace"><meta name="turbo-refresh-scroll" content="reset">

[Kocal]

Hi, can you also add some tests and update the CHANGELOG (for 2.24)?

Thanks!

PS: please for the next time, keep the PR template 🙏🏻

[Kocal]

Please add some PHPDoc and a link to the documentation

[Kocal]

Please add some PHPDoc and a link to the documentation

[smnandre]

I don't think we need to have 3 methods here. What about keeping just the first two ?

Also i would not set the default values in the methods and force users to be explicit (they do not need this function to set default value... and the day Turbo changes its default value it would be a real mess).

[seb-jean]

Hi to you both :),

Thank you for your feedback.

I added the PHPDocs. and updated CHANGELOG.
I will add the documentation later :).

I don't think we need to have 3 methods here. What about keeping just the first two ?

These tags are generally used together. Turbo Rails and Turbo Laravel also use this third function.

# https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/drive_helper.rb

#   turbo_refreshes_with(method: :morph, scroll: :preserve)
def turbo_refreshes_with(method: :replace, scroll: :reset)
  provide :head, turbo_refresh_method_tag(method)
  provide :head, turbo_refresh_scroll_tag(scroll)
end

Also i would not set the default values in the methods and force users to be explicit (they do not need this function to set default value... and the day Turbo changes its default value it would be a real mess).

For Morphing, Turbo says the default is replace. Similarly, for Scroll preservation, Turbo indicates that the default value is reset.

These default values ​​are also found in Turbo Rails:

• Method : https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/drive_helper.rb#L76
• Scroll : https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/drive_helper.rb#L82

# https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/drive_helper.rb

# Configure method to perform page refreshes. See +turbo_refreshes_with+.
def turbo_refresh_method_tag(method = :replace)
  raise ArgumentError, "Invalid refresh option '#{method}'" unless method.in?(%i[ replace morph ])
  tag.meta(name: "turbo-refresh-method", content: method)
end

# Configure scroll strategy for page refreshes. See +turbo_refreshes_with+.
def turbo_refresh_scroll_tag(scroll = :reset)
  raise ArgumentError, "Invalid scroll option '#{scroll}'" unless scroll.in?(%i[ reset preserve ])
  tag.meta(name: "turbo-refresh-scroll", content: scroll)
end

[Kocal]

Works for me then, thanks!
Maybe it could be a good idea to document (in the PHPDoc) that these new methods are "copied" from Turbo Rails?

[seb-jean]

I put a few words (Inspired by Turbo Rails ...) per function. Is it better if I put those few words at the class level instead?

[Kocal]

That's perfect, thanks!