issue/2760 Added ChildViews API for rendering control (v5.7.0)

[olivermartinfoster]

#2760

Changed

• async Adapt.navigateToElement Made async, resolves when navigation is finished
• async Adapt.scrollTo Made async, resolves when scroll/navigation is finished
• AdaptView.childViews from an indexed hash into a flat array with deprecated warnings
• Adapt.remove now resets _isReady and _isRendered
• AdaptModel.checkReadyStatus now returns true/false and checks _isRendered and _isReady
• PageView.preRender now executes new AdaptModel.checkIfResetOnRevisit on descendants before rendering them
• async AdaptView.addChildren now renders first-child-first rather than parent-first, resolves asynchronously when all possible children have been added, triggers a view:addChild(ChildEvent) event before rendering a model to see if plugins want to stop the render. It triggers a view:requestChild(ChildEvent) if model has _canRequestChild: true when it is at the end of the list of children to see if plugins wish to add any more. If addChildren is called more than once it will now continue rendering from where it was last stopped making await Adapt.parentView.addChildren(); await Adapt.parentView.whenReady(); the easiest way to continue adding children and to wait until they are rendered and ready.
• Added default animation time of 400ms to router Adapt.navigateToElement when routing to a sub contentobject id

Added

• ChildEvent object to control rendering
• AdaptModel.checkIfResetOnRevisit as this is a view only function at the moment
• AdaptModel._canRequestChild to control if AdaptView.addChildren can request more children from plugins
• AdaptModel._isRendered to indicate when a model has been rendered
• AdaptView.addChildView(AdaptView) triggers view:childAdded(parentView, childView)
• AdaptView.getChildViews()
• AdaptView.setChildViews([AdaptView])
• async AdaptView.addDescendants() runs addChildren on existing child views
• async AdaptView.whenReady() to resolve when all of the views are ready
• AdaptView._getAddChildEvent(model) to trigger view:addChild and view:requestChild events and return ChildEvent control object on behalf of AdaptView.addChildren
• await ContentObjectView.renderTo(id) to have a content object force render to the specified id, resolves when the views are ready

[cahirodoherty-learningpool]

👀

[moloko]

code 👓 one minor thing, otherwise looks good

[moloko]

this PR should probably be changed to merge into master rather than release/v5.6.0 I think? either that or the release/v5.6.0 branch just needs renaming

[moloko]

@olivermartinfoster conflict needs resolving...

[lc-alexanderbenesch]

👍