Changelog History
Page 1
-
v2.1.11 Changes
October 11, 2021- ๐ #148: Polish retry count header feature - @nikolalsvk.
- ๐ #147: Add support for retry count header - @reneklacan.
-
v2.1.10 Changes
March 21, 2021- #146: Add comment when we check if container is present - @nikolalsvk.
- #145: Wrap html_options for turbolinks - @yhirano55.
- #144: Avoid TypeError if container has already disappear - @yhirano55.
-
v2.1.9 Changes
February 23, 2021- โก๏ธ #142: Update Turbolinks docs - @nikolalsvk.
- ๐ #141: Add Support for Turbo - @MBuckley0.
- ๐ง #139: Fix readme configuration-options anchor - @richardvenneman.
- ๐ #138: Add Rails 6 base app as a fixture - @nikolalsvk.
- #137: Rename config - @nikolalsvk.
-
v2.1.8 Changes
October 24, 2020๐ฑ The new version of render_async is out! ๐
๐ฑ ๐พ P.S. There is a
render_async
Discord server, please join and let's make render_async even better!The new version brings:
- Reloading partials on demand
- Start polling on page load when toggle is used
- ๐ง Configure nonce globally
- Assign start and stop events after the page loaded
๐ฑ โป๏ธ Refresh (reload) render_async partials
This feature was requested in at least 3 issues opened on the repo recently. Finally, it is here!
You can now provide a button for your users to easily refresh a partial that is render by render_async. Take a look at the example below:\<%= render\_async comments\_path, container\_id: 'refresh-me', replace\_container: false %\>\<button id="refresh-button"\>Refresh comments\</button\>\<script\>var button = document.getElementById('refresh-button')var container = document.getElementById('refresh-me');button.addEventListener('click', function() {var event = new Event('refresh');// Dispatch 'refresh' on the render\_async containercontainer.dispatchEvent(event)})\</script\>
Now, every time a "Refresh comments" button is clicked, render_async will reload the comments partial. Hope you like the new feature.
The issues closed with this feature: #121, #126, #129. More info in the docs here.๐ฑ ๐ Start polling on page load when toggle is used
We closed #118 with this feature. You can now specify
start: true
inside thetoggle
hash like this:\<a href='#' id='comments-button'\>Toggle comments loading\</a\>\<%= render\_async comments\_path,toggle: { selector: '#comments-button',event: :click,start: true },interval: 2000 %\>
๐ This will make render_async to start polling on page load. Later, you can toggle polling with the "Toggle comments loading" button. There is more info in the docs here.
๐ง ๐ง Configure nonce globally
You can specify
nonces: true
globally and never deal with it in specific render_async calls. Just add the following to your render_async configuration:RenderAsync.configure do |config| config.nonces = trueend
๐ท After that, all
javascript_tag
elements will havenonce: true
set. More info in the docs here.โฏ๏ธ Assign start and stop events after the page loaded
๐ This is a bug fix mentioned in #128. We moved the event set up after the page loaded.
If you hadcontent_for
inside thehead
tag, usingasync-start
andasync-stop
will start working for you again.That's all folks, catch you in the next one!
๐ฑ ๐พ P.S. There is a
render_async
Discord server, please join and let's make render_async even better! -
v2.1.7 Changes
August 01, 2020๐ฑ ๐ New version of render_async is out! In the new version, there are a couple of new features:
- Retry render_async after some time
- Control polling by dispatching events
- Customize content_for name
๐ฑ ๐พ P.S. There is a
render_async
Discord server, please join and let's make render_async even better!๐ฑ โป๏ธ Retry render_async after some time
If you want to retry requests but with some delay in between the calls, you can pass a retry_delay option together with retry_count like so:
\<%= render\_async users\_path, retry\_count: 5, retry\_delay: 2000 %\>
0๏ธโฃ This will make render_async wait for 2 seconds before retrying after each failure. In the end, if the request is still failing after the 5th time, it will dispatch a default error event.
You can read more about this feature in the README here
โฏ๏ธ Control polling by dispatching events
You can now control polling with by dispatching these 2 events:
- 'async-stop' - this will stop polling
- 'async-start' - this will start polling.
๐ฑ > ๐ก Please note that events need to be dispatched to a render_async container.
An example of how you can do this looks like this:
\<%= render\_async wave\_render\_async\_path, container\_id: 'controllable-interval', # set container\_id so we can get it later easily interval: 3000 %\>\<button id='stop-polling'\>Stop polling\</button\>\<button id='start-polling'\>Start polling\</button\>\<script\>var container = document.getElementById('controllable-interval')var stopPolling = document.getElementById('stop-polling')var startPolling = document.getElementById('start-polling')var triggerEventOnContainer = function(eventName) {var event = new Event(eventName);container.dispatchEvent(event)}stopPolling.addEventListener('click', function() {container.innerHTML = '\<p\>Polling stopped\</p\>'triggerEventOnContainer('async-stop')})startPolling.addEventListener('click', function() {triggerEventOnContainer('async-start')})\</script\>
You can read more about it in the Controlled polling section of the README.
Customize content_for name
The content_for name may be customized by passing the
content_for_name
option torender_async
.
๐ This option is especially useful when doing nested async renders to better control the location of the injected JavaScript.For example:
\<%= render\_async comment\_stats\_path, content\_for\_name: :render\_async\_comment\_stats %\>\<%= content\_for :render\_async\_comment\_stats %\>
This explanation is also available in the README
That's all folks, catch you in the next one!
๐ฑ ๐พ P.S. There is a
render_async
Discord server, please join and let's make render_async even better! -
v2.1.6 Changes
May 09, 2020๐ Release 2.1.6 solves a couple of minor bugs:
- Cannot stop polling after navigation changes (issue: #100, PR: #113)
- Default headers don't get removed now (issue: #72, PR: #112) (this was an old one, glad we got it out of the way, finally)
- Removed
event.preventDefault()
in toggle logic (issue: #109, PR: #110) - Fixed loading of nested partials with Turbolinks based on this comment #70 (comment), PR: #114
๐ฑ Please test them out and post some findings if something is broken โค๏ธ
-
v2.1.5 Changes
March 22, 2020๐ฑ ๐ฅ Firing events on success and fail by default
0๏ธโฃ In this version, render_async will emit emits by default. If your request is finished successfully, a
render_async_load
event will fire. If it goes badly, therender_async_error
will fire.You can then catch these events in your code with something like this:
document.addEventListener('render\_async\_load', function(event) {console.log('Async partial loaded in this container:', event.container);});document.addEventListener('render\_async\_error', function(event) {console.log('Async partial could not load in this container:', event.container);});
๐ฑ ๐ Making DOM element available in events
๐ As you've seen in the previous example, you can now access
event.container
which will give you the associated DOM element. DOM element will be the one it just got replaced after the request has finished.๐ฑ ๐จ Fix of #90
Toggle event listeners are not added after the page has loaded.
Note
If you're using jQuery to trigger an event like so
$(document).ready(function(){$("#render-async-trigger").trigger('click');});
๐ง Make sure you're using render_async with jQuery configuration set to true!
OR
If you're using it with Vanilla JS (as is, as installed), make sure to register these events after the
DOMContentLoaded
is fired! -
v2.1.4 Changes
November 11, 2019๐ This release solves #94 and allows you to unbind an event when using toggle functionality of the gem.
You can unbind an event by passing
once: true
argument to render_async toggle option:\<%= render\_async comments\_path, toggle: { selector: '#detail-button', event: :click, once: true } do %\>\<a href='#' id='detail-button'\>Detail\</a\>\<% end %\>
-
v2.1.3 Changes
October 24, 2019- #95: Use double quotes for displaying error message - @nikolalsvk.
- #93: Fix: "Uncaught ReferenceError: _interval" #92 - @fffx.
-
v2.1.2 Changes
August 30, 2019- #89: Bump version to 2.1.2 - @nikolalsvk.
- #82: When toggle true, do not fire
_renderAsyncFunc
onturbolinks:load
- @ThanhKhoaIT.