{{description}}
This module adds some renderPromises to the Y.Widget class that are useful when it comes down to timing.
renderPromise() and readyPromise() return Promises which you can use to be sure the widget
is rendered.
renderOnAvailable(), renderWhenAvailable(), renderOnAvailablePromise() and
renderWhenAvailablePromise() make it posible to automaticly render the widget even if the containerNode
is not part of the dom yet.
renderPromise() is a Promise that is fulfilled once the widget is rendered: you don't need to listen for the 'render'-event,
neither look for the value of the attribute 'rendered'.
This is handy because without this method you might find yourself inspecting those two situations.
readyPromise() is a Promise that waits even longer. You can create a widget-extention that does some things after it is rendered,
for example load serverdata and process it. readyPromise will be resolved once all that has finished. To make that happen, it makes use of promiseBeforeReady. Typical usages are be when you create a widget where syncUI is asynchronious. Or, a composite widget that rendenderes multiple widgets with asynchronious syncUI().
promiseBeforeReady() is a Promise which will run directly after the widget is rendered. It is up to the developer of the
widget-extention how to define promiseBeforeReady, which is a fulfilled promise by default. Once promiseBeforeReady() is fulfilled, readyPromise() is fulfilled as well.
renderOnAvailablePromise() is very handy if you need to setup the rendercode while not knowing when the containerNode will be in the DOM.
renderOnAvailable() Does the same as renderOnAvailablePromise(), but doesn't return a Promise; it returns the instance. Therefore it can be called in the same way as render().
renderWhenAvailablePromise() works the same as renderOnAvailablePromise(), but will re-render everytime the containerNode is redefined in the dom. Situations to make use of this might be when pages are dynamicly reloaded.
renderWhenAvailable() Does the same as renderWhenAvailablePromise(), but doesn't return a Promise; it returns the instance. Therefore it can be called in the same way as render().
Note: The widget might not work as espected when it is re-rendered. It only does work right if the widget is designed well, in a way that all nodes and events are declared inside renderUI() and syncUI(): The way widgets were ment to work.