-
Notifications
You must be signed in to change notification settings - Fork 254
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(framework): Deprecate RenderScheduler in favor of Render.js (#…
- Loading branch information
1 parent
d8ea023
commit bc78857
Showing
32 changed files
with
280 additions
and
247 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| import EventProvider from "./EventProvider.js"; | ||
| import RenderQueue from "./RenderQueue.js"; | ||
| import { getAllRegisteredTags } from "./CustomElementsRegistry.js"; | ||
| import { isRtlAware } from "./locale/RTLAwareRegistry.js"; | ||
|
|
||
| const registeredElements = new Set(); | ||
| const eventProvider = new EventProvider(); | ||
|
|
||
| const invalidatedWebComponents = new RenderQueue(); // Queue for invalidated web components | ||
|
|
||
| let renderTaskPromise, | ||
| renderTaskPromiseResolve; | ||
|
|
||
| let mutationObserverTimer; | ||
|
|
||
| let queuePromise; | ||
|
|
||
|
|
||
| /** | ||
| * Schedules a render task (if not already scheduled) to render the component | ||
| * | ||
| * @param webComponent | ||
| * @returns {Promise} | ||
| */ | ||
| const renderDeferred = async webComponent => { | ||
| // Enqueue the web component | ||
| invalidatedWebComponents.add(webComponent); | ||
|
|
||
| // Schedule a rendering task | ||
| await scheduleRenderTask(); | ||
| }; | ||
|
|
||
| /** | ||
| * Renders a component synchronously and adds it to the registry of rendered components | ||
| * | ||
| * @param webComponent | ||
| */ | ||
| const renderImmediately = webComponent => { | ||
| eventProvider.fireEvent("beforeComponentRender", webComponent); | ||
| registeredElements.add(webComponent); | ||
| webComponent._render(); | ||
| }; | ||
|
|
||
| /** | ||
| * Cancels the rendering of a component, if awaiting to be rendered, and removes it from the registry of rendered components | ||
| * | ||
| * @param webComponent | ||
| */ | ||
| const cancelRender = webComponent => { | ||
| invalidatedWebComponents.remove(webComponent); | ||
| registeredElements.delete(webComponent); | ||
| }; | ||
|
|
||
| /** | ||
| * Schedules a rendering task, if not scheduled already | ||
| */ | ||
| const scheduleRenderTask = async () => { | ||
| if (!queuePromise) { | ||
| queuePromise = new Promise(resolve => { | ||
| window.requestAnimationFrame(() => { | ||
| // Render all components in the queue | ||
|
|
||
| // console.log(`--------------------RENDER TASK START------------------------------`); // eslint-disable-line | ||
| invalidatedWebComponents.process(renderImmediately); | ||
| // console.log(`--------------------RENDER TASK END------------------------------`); // eslint-disable-line | ||
|
|
||
| // Resolve the promise so that callers of renderDeferred can continue | ||
| queuePromise = null; | ||
| resolve(); | ||
|
|
||
| // Wait for Mutation observer before the render task is considered finished | ||
| if (!mutationObserverTimer) { | ||
| mutationObserverTimer = setTimeout(() => { | ||
| mutationObserverTimer = undefined; | ||
| if (invalidatedWebComponents.isEmpty()) { | ||
| _resolveTaskPromise(); | ||
| } | ||
| }, 200); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| await queuePromise; | ||
| }; | ||
|
|
||
| /** | ||
| * return a promise that will be resolved once all invalidated web components are rendered | ||
| */ | ||
| const whenDOMUpdated = () => { | ||
| if (renderTaskPromise) { | ||
| return renderTaskPromise; | ||
| } | ||
|
|
||
| renderTaskPromise = new Promise(resolve => { | ||
| renderTaskPromiseResolve = resolve; | ||
| window.requestAnimationFrame(() => { | ||
| if (invalidatedWebComponents.isEmpty()) { | ||
| renderTaskPromise = undefined; | ||
| resolve(); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| return renderTaskPromise; | ||
| }; | ||
|
|
||
| const whenAllCustomElementsAreDefined = () => { | ||
| const definedPromises = getAllRegisteredTags().map(tag => customElements.whenDefined(tag)); | ||
| return Promise.all(definedPromises); | ||
| }; | ||
|
|
||
| const renderFinished = async () => { | ||
| await whenAllCustomElementsAreDefined(); | ||
| await whenDOMUpdated(); | ||
| }; | ||
|
|
||
| const _resolveTaskPromise = () => { | ||
| if (!invalidatedWebComponents.isEmpty()) { | ||
| // More updates are pending. Resolve will be called again | ||
| return; | ||
| } | ||
|
|
||
| if (renderTaskPromiseResolve) { | ||
| renderTaskPromiseResolve(); | ||
| renderTaskPromiseResolve = undefined; | ||
| renderTaskPromise = undefined; | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Re-renders all UI5 Elements on the page, with the option to specify filters to rerender only some components. | ||
| * | ||
| * Usage: | ||
| * reRenderAllUI5Elements() -> re-renders all components | ||
| * reRenderAllUI5Elements({tag: "ui5-button"}) -> re-renders only instances of ui5-button | ||
| * reRenderAllUI5Elements({rtlAware: true}) -> re-renders only rtlAware components | ||
| * reRenderAllUI5Elements({languageAware: true}) -> re-renders only languageAware components | ||
| * reRenderAllUI5Elements({rtlAware: true, languageAware: true}) -> re-renders components that are rtlAware or languageAware | ||
| * etc... | ||
| * | ||
| * @public | ||
| * @param {Object|undefined} filters - Object with keys that can be "rtlAware" or "languageAware" | ||
| * @returns {Promise<void>} | ||
| */ | ||
| const reRenderAllUI5Elements = async filters => { | ||
| registeredElements.forEach(element => { | ||
| const tag = element.constructor.getMetadata().getTag(); | ||
| const rtlAware = isRtlAware(element.constructor); | ||
| const languageAware = element.constructor.getMetadata().isLanguageAware(); | ||
| if (!filters || (filters.tag === tag) || (filters.rtlAware && rtlAware) || (filters.languageAware && languageAware)) { | ||
| renderDeferred(element); | ||
| } | ||
| }); | ||
| await renderFinished(); | ||
| }; | ||
|
|
||
| const attachBeforeComponentRender = listener => { | ||
| eventProvider.attachEvent("beforeComponentRender", listener); | ||
| }; | ||
|
|
||
| const detachBeforeComponentRender = listener => { | ||
| eventProvider.detachEvent("beforeComponentRender", listener); | ||
| }; | ||
|
|
||
| export { | ||
| renderDeferred, | ||
| renderImmediately, | ||
| cancelRender, | ||
| renderFinished, | ||
| reRenderAllUI5Elements, | ||
| attachBeforeComponentRender, | ||
| detachBeforeComponentRender, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.