`Turbo.visit(..., { frame: "frame" })` #649

seanpdoyle · 2022-07-27T14:30:34Z

Add support for driving a <turbo-frame> element from a
Turbo.visit(...) call.

Internally, Turbo has some constraints for finding and driving a
<turbo-frame> element, namely that it has an [id] attribute and that
it is not marked with a [disabled] attribute.

Supporting Turbo.visit calls that specify a frame: option
provide an opportunity to encapsulate those details from callers while
still providing element finding utility.

dhh · 2022-07-28T21:42:44Z

Turbo.visit("/pathname.html", { frame: "x" }) strikes me as easier on the eye. I know that doesn't mesh fully with the destruct, but imo that's ok.

Add support for driving a `<turbo-frame>` element from a `Turbo.visit(...)` call. Internally, Turbo has some constraints for finding and driving a `<turbo-frame>` element, namely that it has an `[id]` attribute and that it is not marked with a `[disabled]` attribute. Supporting `Turbo.visit` calls that specify a `frame:` option provide an opportunity to encapsulate those details from callers while still providing element finding utility.

Closes hotwired/turbo#257 Closes hotwired/turbo#397 Follow-up to hotwired/turbo#257 (comment) hotwired/turbo#257 (comment) Depends on hotwired/turbo#660 Introduces the `Turbo::Stream::Redirect` concern to override the [redirect_to][] routing helper. When called with a `turbo_frame:` option, the `redirect_to` helper with check whether the request was made with the Turbo Stream `Accept:` header. When it's absent, the response will redirect with a typical HTTP status code and location. When present, the controller will respond with a `<turbo-stream>` element that invokes [Turbo.visit($URL, { frame: $TURBO_FRAME })][hotwired/turbo#649] where `$URL` is set to the redirect's path or URL, and `$TURBO_FRAME` is set to the `turbo_frame:` argument. This enables server-side actions to navigate the entire page with a `turbo_frame: "_top"` option. Incidentally, it also enables a frame request to navigate _a different_ frame. Typically, an HTTP that would result in a redirect nets two requests: the first submission, then the subsequent GET request to follow the redirect. In the case of a "break out", the same number of requests are made: the first submission, then the subsequent GET made by the `Turbo.visit` call. [redirect_to]: https://edgeapi.rubyonrails.org/classes/ActionController/Redirecting.html#method-i-redirect_to [hotwired/turbo#649]: hotwired/turbo#649

Closes hotwired/turbo#257 Closes hotwired/turbo#397 Follow-up to hotwired/turbo#257 (comment) hotwired/turbo#257 (comment) Depends on hotwired/turbo#660 Introduces the `Turbo::Stream::Redirect` concern to override the [redirect_to][] routing helper. When called with a `turbo_frame:` option, the `redirect_to` helper with check whether the request was made with the Turbo Stream `Accept:` header. When it's absent, the response will redirect with a typical HTTP status code and location. When present, the controller will respond with a `<turbo-stream>` element that invokes [Turbo.visit($URL, { frame: $TURBO_FRAME })][hotwired/turbo#649] where `$URL` is set to the redirect's path or URL, and `$TURBO_FRAME` is set to the `turbo_frame:` argument. This enables server-side actions to navigate the entire page with a `turbo_frame: "_top"` option. Incidentally, it also enables a frame request to navigate _a different_ frame. Typically, an HTTP that would result in a redirect nets two requests: the first submission, then the subsequent GET request to follow the redirect. In the case of a "break out", the same number of requests are made: the first submission, then the subsequent GET made by the `Turbo.visit` call. Once the `Turbo.visit` call is made, the script removes its ancestor `<script>` by calling [document.currentScript.remove()][]. [redirect_to]: https://edgeapi.rubyonrails.org/classes/ActionController/Redirecting.html#method-i-redirect_to [hotwired/turbo#649]: hotwired/turbo#649 [document.currentScript.remove()]: https://developer.mozilla.org/en-US/docs/Web/API/Document/currentScript

Closes hotwired/turbo#257 Closes hotwired/turbo#397 Follow-up to: * hotwired/turbo#257 (comment) * hotwired/turbo#257 (comment) Depends on hotwired/turbo#660 Introduces the `Turbo::Stream::Redirect` concern to override the [redirect_to][] routing helper. When called with a `turbo_frame:` option, the `redirect_to` helper with check whether the request was made with the Turbo Stream `Accept:` header. When it's absent, the response will redirect with a typical HTTP status code and location. When present, the controller will respond with a `<turbo-stream>` element that invokes [Turbo.visit($URL, { frame: $TURBO_FRAME })][hotwired/turbo#649] where `$URL` is set to the redirect's path or URL, and `$TURBO_FRAME` is set to the `turbo_frame:` argument. This enables server-side actions to navigate the entire page with a `turbo_frame: "_top"` option. Incidentally, it also enables a frame request to navigate _a different_ frame. Typically, an HTTP that would result in a redirect nets two requests: the first submission, then the subsequent GET request to follow the redirect. In the case of a "break out", the same number of requests are made: the first submission, then the subsequent GET made by the `Turbo.visit` call. Once the `Turbo.visit` call is made, the script removes its ancestor `<script>` by calling [document.currentScript.remove()][]. [redirect_to]: https://edgeapi.rubyonrails.org/classes/ActionController/Redirecting.html#method-i-redirect_to [hotwired/turbo#649]: hotwired/turbo#649 [document.currentScript.remove()]: https://developer.mozilla.org/en-US/docs/Web/API/Document/currentScript

Closes hotwired/turbo#257 Closes hotwired/turbo#397 Follow-up to: * hotwired/turbo#257 (comment) * hotwired/turbo#257 (comment) Depends on hotwired/turbo#660 Introduces the `Turbo::Stream::Redirect` concern to override the [redirect_to][] routing helper. When called with a `turbo_frame:` option, the `redirect_to` helper with check whether the request was made with the Turbo Stream `Accept:` header. When it's absent, the response will redirect with a typical HTTP status code and location. When present, the controller will respond with a `<turbo-stream>` element that invokes [Turbo.visit($URL, { frame: $TURBO_FRAME })][hotwired/turbo#649] where `$URL` is set to the redirect's path or URL, and `$TURBO_FRAME` is set to the `turbo_frame:` argument. This enables server-side actions to navigate the entire page with a `turbo_frame: "_top"` option. Incidentally, it also enables a frame request to navigate _a different_ frame. Typically, an HTTP that would result in a redirect nets two requests: the first submission, then the subsequent GET request to follow the redirect. In the case of a "break out", the same number of requests are made: the first submission, then the subsequent GET made by the `Turbo.visit` call. Once the `Turbo.visit` call is made, the script removes its ancestor `<script>` by calling [document.currentScript.remove()][], and marking it with [data-turbo-cache="false"][] [redirect_to]: https://edgeapi.rubyonrails.org/classes/ActionController/Redirecting.html#method-i-redirect_to [hotwired/turbo#649]: hotwired/turbo#649 [document.currentScript.remove()]: https://developer.mozilla.org/en-US/docs/Web/API/Document/currentScript [data-turbo-cache="false"]: https://turbo.hotwired.dev/reference/attributes#data-attributes

seanpdoyle force-pushed the turbo-visit-frame branch 4 times, most recently from 66b6496 to 5bcd373 Compare July 27, 2022 22:51

seanpdoyle force-pushed the turbo-visit-frame branch from 5bcd373 to c84e0b7 Compare July 28, 2022 22:01

seanpdoyle changed the title ~~Turbo.visit(..., { turboFrame: "frame" })~~ Turbo.visit(..., { frame: "frame" }) Jul 28, 2022

seanpdoyle force-pushed the turbo-visit-frame branch from c84e0b7 to 7e12fa5 Compare July 28, 2022 22:51

seanpdoyle force-pushed the turbo-visit-frame branch from 7e12fa5 to 921716a Compare July 28, 2022 22:56

dhh merged commit 52c4974 into hotwired:main Jul 29, 2022

seanpdoyle deleted the turbo-visit-frame branch July 29, 2022 21:00

seanpdoyle mentioned this pull request Jul 31, 2022

"Break out" of a frame from the server hotwired/turbo-rails#367

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Turbo.visit(..., { frame: "frame" })` #649

`Turbo.visit(..., { frame: "frame" })` #649

seanpdoyle commented Jul 27, 2022 •

edited

Loading

dhh commented Jul 28, 2022

Turbo.visit(..., { frame: "frame" }) #649

Turbo.visit(..., { frame: "frame" }) #649

Conversation

seanpdoyle commented Jul 27, 2022 • edited Loading

dhh commented Jul 28, 2022

`Turbo.visit(..., { frame: "frame" })` #649

`Turbo.visit(..., { frame: "frame" })` #649

seanpdoyle commented Jul 27, 2022 •

edited

Loading