wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2025-01-08 12:14:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/resources/ext.popups/renderChangeListener.js

26 lines
637 B
JavaScript
Raw Normal View History

Render previews Extract core rendering functionality from the mw.popups.renderer and mw.popups.renderer.article objects. For now, render and show the preview when the user dwells on and abandons a link respectively. Supporting changes: * Add mw.popups.wait, which is sugar around window.setTimeout. * action.response -> action.result in the FETCH_END case of the preview reducer. Change-Id: I14b437e7c2f55b988837fcb2800dd61a23c29a01
2016-11-21 12:07:23 +00:00
( function ( mw ) {
/**
* Creates an instance of the render change listener.
*
Don't hide preview if it's interacted with Action creator changes: * Make the linkAbandon action creator asynchronous by splitting it into two distinct actions, LINK_ABANDON_START and _END, the latter of which is dispatched after a 300 ms delay. * Introduce the previewDwell and previewAbandon action creators. The latter is an asynchronous action that mirrors the linkAbandon action. Reducer changes: * Make the LINK_DWELL, LINK_ABANDON_END, and PREVIEW_ABANDON_END action hide a preview, if one has been shown. * Make the LINK_ABANDON_END action NOOP if: * The user has interacted with another link, or * The user is interacting with the preview. Supporting changes: * Update the mw.popups.reducers#preview and #renderer unit tests to use an empty previous state so that the tests are more resilient to modifications of the state tree. Change-Id: I2ecf575bbb59bb64772f75da9b5a29c071b46a8d
2016-11-28 12:00:07 +00:00
* @param {Object} boundActions
Render previews Extract core rendering functionality from the mw.popups.renderer and mw.popups.renderer.article objects. For now, render and show the preview when the user dwells on and abandons a link respectively. Supporting changes: * Add mw.popups.wait, which is sugar around window.setTimeout. * action.response -> action.result in the FETCH_END case of the preview reducer. Change-Id: I14b437e7c2f55b988837fcb2800dd61a23c29a01
2016-11-21 12:07:23 +00:00
* @return {ext.popups.ChangeListener}
*/
Don't hide preview if it's interacted with Action creator changes: * Make the linkAbandon action creator asynchronous by splitting it into two distinct actions, LINK_ABANDON_START and _END, the latter of which is dispatched after a 300 ms delay. * Introduce the previewDwell and previewAbandon action creators. The latter is an asynchronous action that mirrors the linkAbandon action. Reducer changes: * Make the LINK_DWELL, LINK_ABANDON_END, and PREVIEW_ABANDON_END action hide a preview, if one has been shown. * Make the LINK_ABANDON_END action NOOP if: * The user has interacted with another link, or * The user is interacting with the preview. Supporting changes: * Update the mw.popups.reducers#preview and #renderer unit tests to use an empty previous state so that the tests are more resilient to modifications of the state tree. Change-Id: I2ecf575bbb59bb64772f75da9b5a29c071b46a8d
2016-11-28 12:00:07 +00:00
mw.popups.changeListeners.render = function ( boundActions ) {
Render previews Extract core rendering functionality from the mw.popups.renderer and mw.popups.renderer.article objects. For now, render and show the preview when the user dwells on and abandons a link respectively. Supporting changes: * Add mw.popups.wait, which is sugar around window.setTimeout. * action.response -> action.result in the FETCH_END case of the preview reducer. Change-Id: I14b437e7c2f55b988837fcb2800dd61a23c29a01
2016-11-21 12:07:23 +00:00
var preview;
return function ( prevState, state ) {
Don't always render after the API request resolves If the user abandons the link after the API request delay (500 ms) but before the it resolves (~10e3 ms), then the preview shouldn't be rendered. Changes: * actions: Include the link in the FETCH_START, FETCH_FAILED, and FETCH_END actions. * reducers: If the active link has changed, then FETCH_END is a NOOP. Supporting changes: * reducers: Signal that a preview should be rendered and shown with preview.shouldShow. Change-Id: I3dd1c0c566ec63de515174c14845d7927583ce93
2016-11-25 12:42:02 +00:00
if ( state.preview.shouldShow && !preview ) {
Render previews Extract core rendering functionality from the mw.popups.renderer and mw.popups.renderer.article objects. For now, render and show the preview when the user dwells on and abandons a link respectively. Supporting changes: * Add mw.popups.wait, which is sugar around window.setTimeout. * action.response -> action.result in the FETCH_END case of the preview reducer. Change-Id: I14b437e7c2f55b988837fcb2800dd61a23c29a01
2016-11-21 12:07:23 +00:00
preview = mw.popups.renderer.render( state.preview.fetchResponse );
Don't hide preview if it's interacted with Action creator changes: * Make the linkAbandon action creator asynchronous by splitting it into two distinct actions, LINK_ABANDON_START and _END, the latter of which is dispatched after a 300 ms delay. * Introduce the previewDwell and previewAbandon action creators. The latter is an asynchronous action that mirrors the linkAbandon action. Reducer changes: * Make the LINK_DWELL, LINK_ABANDON_END, and PREVIEW_ABANDON_END action hide a preview, if one has been shown. * Make the LINK_ABANDON_END action NOOP if: * The user has interacted with another link, or * The user is interacting with the preview. Supporting changes: * Update the mw.popups.reducers#preview and #renderer unit tests to use an empty previous state so that the tests are more resilient to modifications of the state tree. Change-Id: I2ecf575bbb59bb64772f75da9b5a29c071b46a8d
2016-11-28 12:00:07 +00:00
preview.show( state.preview.activeEvent, boundActions );
Don't always render after the API request resolves If the user abandons the link after the API request delay (500 ms) but before the it resolves (~10e3 ms), then the preview shouldn't be rendered. Changes: * actions: Include the link in the FETCH_START, FETCH_FAILED, and FETCH_END actions. * reducers: If the active link has changed, then FETCH_END is a NOOP. Supporting changes: * reducers: Signal that a preview should be rendered and shown with preview.shouldShow. Change-Id: I3dd1c0c566ec63de515174c14845d7927583ce93
2016-11-25 12:42:02 +00:00
} else if ( !state.preview.shouldShow && preview ) {
Render previews Extract core rendering functionality from the mw.popups.renderer and mw.popups.renderer.article objects. For now, render and show the preview when the user dwells on and abandons a link respectively. Supporting changes: * Add mw.popups.wait, which is sugar around window.setTimeout. * action.response -> action.result in the FETCH_END case of the preview reducer. Change-Id: I14b437e7c2f55b988837fcb2800dd61a23c29a01
2016-11-21 12:07:23 +00:00
preview.hide()
.done( function () {
preview = undefined;
} );
}
};
};
}( mediaWiki ) );
Reference in a new issue Copy permalink