Skip to content

Commit c75e93e

Browse files
authored
Update index.rst
1 parent 57c1912 commit c75e93e

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

src/Turbo/doc/index.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,20 +1056,26 @@ turbo_exempts_page_from_cache()
10561056
10571057
{{ turbo_exempts_page_from_cache() }}
10581058
1059+
Generates a <meta> tag to disable caching of a page.
1060+
10591061
turbo_exempts_page_from_preview()
10601062
.................................
10611063

10621064
.. code-block:: twig
10631065
10641066
{{ turbo_exempts_page_from_preview() }}
10651067
1068+
Generates a <meta> tag to specify cached version of the page should not be shown as a preview on regular navigation visits.
1069+
10661070
turbo_page_requires_reload()
10671071
............................
10681072

10691073
.. code-block:: twig
10701074
10711075
{{ turbo_page_requires_reload() }}
10721076
1077+
Generates a <meta> tag to force a full page reload.
1078+
10731079
turbo_refreshes_with()
10741080
............................
10751081

@@ -1078,12 +1084,11 @@ turbo_refreshes_with()
10781084
{{ turbo_refreshes_with(method: 'replace', scroll: 'reset') }}
10791085
10801086
``method`` *(optional)*
1081-
**type**: ``string`` **default**: ``replace``
1087+
**type**: ``string`` **default**: ``replace`` **allowed values**: ``replace`` or ``morph``
10821088
``scroll`` *(optional)*
1083-
**type**: ``string`` **default**: ``reset``
1089+
**type**: ``string`` **default**: ``reset`` **allowed values**: ``reset`` or ``preserve``
10841090

1085-
Creates a ``Translatable`` object that can be passed to the
1086-
:ref:`trans filter <reference-twig-filter-trans>`.
1091+
Generates <meta> tags to configure both the refresh method and scroll behavior for page refreshes.
10871092

10881093
turbo_refresh_method()
10891094
......................
@@ -1093,10 +1098,9 @@ turbo_refresh_method()
10931098
{{ turbo_refresh_method(method: 'replace') }}
10941099
10951100
``method`` *(optional)*
1096-
**type**: ``string`` **default**: ``replace``
1101+
**type**: ``string`` **default**: ``replace`` **allowed values**: ``replace`` or ``morph``
10971102

1098-
Creates a ``Translatable`` object that can be passed to the
1099-
:ref:`trans filter <reference-twig-filter-trans>`.
1103+
Generates a <meta> tag to configure the refresh method for page refreshes.
11001104

11011105
turbo_refresh_scroll()
11021106
......................
@@ -1106,10 +1110,9 @@ turbo_refresh_scroll()
11061110
{{ turbo_refresh_scroll(scroll: 'reset') }}
11071111
11081112
``scroll`` *(optional)*
1109-
**type**: ``string`` **default**: ``reset``
1113+
**type**: ``string`` **default**: ``reset`` **allowed values**: ``reset`` or ``preserve``
11101114

1111-
Creates a ``Translatable`` object that can be passed to the
1112-
:ref:`trans filter <reference-twig-filter-trans>`.
1115+
Generates a <meta> tag to configure the scroll behavior for page refreshes.
11131116

11141117
Backward Compatibility promise
11151118
------------------------------

0 commit comments

Comments
 (0)