debian-mirror-gitlab/app/assets/javascripts/flash.js

179 lines
5.4 KiB
JavaScript
Raw Normal View History

2021-04-17 20:07:23 +05:30
import * as Sentry from '@sentry/browser';
2020-05-24 23:13:21 +05:30
import { escape } from 'lodash';
2019-12-04 20:38:33 +05:30
import { spriteIcon } from './lib/utils/common_utils';
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
const FLASH_TYPES = {
ALERT: 'alert',
NOTICE: 'notice',
SUCCESS: 'success',
WARNING: 'warning',
};
2018-03-17 18:26:18 +05:30
const hideFlash = (flashEl, fadeTransition = true) => {
if (fadeTransition) {
Object.assign(flashEl.style, {
2020-03-13 15:44:24 +05:30
transition: 'opacity 0.15s',
2018-03-17 18:26:18 +05:30
opacity: '0',
2017-08-17 22:00:37 +05:30
});
2018-03-17 18:26:18 +05:30
}
2017-09-10 17:25:29 +05:30
2018-12-13 13:39:08 +05:30
flashEl.addEventListener(
'transitionend',
() => {
flashEl.remove();
window.dispatchEvent(new Event('resize'));
if (document.body.classList.contains('flash-shown'))
document.body.classList.remove('flash-shown');
},
{
once: true,
passive: true,
},
);
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
if (!fadeTransition) flashEl.dispatchEvent(new Event('transitionend'));
};
2017-09-10 17:25:29 +05:30
2021-03-08 18:12:59 +05:30
const createAction = (config) => `
2018-03-17 18:26:18 +05:30
<a
href="${config.href || '#'}"
class="flash-action"
${config.href ? '' : 'role="button"'}
>
2020-05-24 23:13:21 +05:30
${escape(config.title)}
2018-03-17 18:26:18 +05:30
</a>
`;
2017-09-10 17:25:29 +05:30
2019-12-04 20:38:33 +05:30
const createFlashEl = (message, type) => `
2019-12-26 22:10:19 +05:30
<div class="flash-${type}">
2019-12-04 20:38:33 +05:30
<div class="flash-text">
2020-05-24 23:13:21 +05:30
${escape(message)}
2019-12-21 20:55:43 +05:30
<div class="close-icon-wrapper js-close-icon">
${spriteIcon('close', 'close-icon')}
</div>
2018-03-17 18:26:18 +05:30
</div>
</div>
`;
const removeFlashClickListener = (flashEl, fadeTransition) => {
2019-12-21 20:55:43 +05:30
flashEl
.querySelector('.js-close-icon')
.addEventListener('click', () => hideFlash(flashEl, fadeTransition));
2018-03-17 18:26:18 +05:30
};
/*
* Flash banner supports different types of Flash configurations
* along with ability to provide actionConfig which can be used to show
* additional action or link on banner next to message
*
* @param {String} message Flash message text
2020-03-13 15:44:24 +05:30
* @param {String} type Type of Flash, it can be `notice`, `success`, `warning` or `alert` (default)
2018-03-17 18:26:18 +05:30
* @param {Object} parent Reference to parent element under which Flash needs to appear
2021-03-08 18:12:59 +05:30
* @param {Object} actionConfig Map of config to show action on banner
2018-03-17 18:26:18 +05:30
* @param {String} href URL to which action config should point to (default: '#')
* @param {String} title Title of action
* @param {Function} clickHandler Method to call when action is clicked on
* @param {Boolean} fadeTransition Boolean to determine whether to fade the alert out
*/
2020-10-24 23:57:45 +05:30
const deprecatedCreateFlash = function deprecatedCreateFlash(
2018-03-17 18:26:18 +05:30
message,
2020-03-13 15:44:24 +05:30
type = FLASH_TYPES.ALERT,
2018-03-17 18:26:18 +05:30
parent = document,
actionConfig = null,
fadeTransition = true,
addBodyClass = false,
) {
const flashContainer = parent.querySelector('.flash-container');
if (!flashContainer) return null;
2019-12-04 20:38:33 +05:30
flashContainer.innerHTML = createFlashEl(message, type);
2018-03-17 18:26:18 +05:30
const flashEl = flashContainer.querySelector(`.flash-${type}`);
if (actionConfig) {
flashEl.innerHTML += createAction(actionConfig);
if (actionConfig.clickHandler) {
2018-12-13 13:39:08 +05:30
flashEl
.querySelector('.flash-action')
2021-03-08 18:12:59 +05:30
.addEventListener('click', (e) => actionConfig.clickHandler(e));
2017-08-17 22:00:37 +05:30
}
}
2016-09-13 17:45:13 +05:30
2019-12-21 20:55:43 +05:30
removeFlashClickListener(flashEl, fadeTransition);
2018-03-17 18:26:18 +05:30
flashContainer.style.display = 'block';
if (addBodyClass) document.body.classList.add('flash-shown');
return flashContainer;
};
2020-10-24 23:57:45 +05:30
/*
* Flash banner supports different types of Flash configurations
* along with ability to provide actionConfig which can be used to show
* additional action or link on banner next to message
*
* @param {Object} options Options to control the flash message
* @param {String} options.message Flash message text
* @param {String} options.type Type of Flash, it can be `notice`, `success`, `warning` or `alert` (default)
* @param {Object} options.parent Reference to parent element under which Flash needs to appear
2021-03-08 18:12:59 +05:30
* @param {Object} options.actionConfig Map of config to show action on banner
2020-10-24 23:57:45 +05:30
* @param {String} href URL to which action config should point to (default: '#')
* @param {String} title Title of action
* @param {Function} clickHandler Method to call when action is clicked on
* @param {Boolean} options.fadeTransition Boolean to determine whether to fade the alert out
* @param {Boolean} options.captureError Boolean to determine whether to send error to sentry
* @param {Object} options.error Error to be captured in sentry
*/
const createFlash = function createFlash({
message,
type = FLASH_TYPES.ALERT,
parent = document,
actionConfig = null,
fadeTransition = true,
addBodyClass = false,
captureError = false,
error = null,
}) {
const flashContainer = parent.querySelector('.flash-container');
if (!flashContainer) return null;
flashContainer.innerHTML = createFlashEl(message, type);
const flashEl = flashContainer.querySelector(`.flash-${type}`);
if (actionConfig) {
flashEl.insertAdjacentHTML('beforeend', createAction(actionConfig));
if (actionConfig.clickHandler) {
flashEl
.querySelector('.flash-action')
2021-03-08 18:12:59 +05:30
.addEventListener('click', (e) => actionConfig.clickHandler(e));
2020-10-24 23:57:45 +05:30
}
}
removeFlashClickListener(flashEl, fadeTransition);
flashContainer.classList.add('gl-display-block');
if (addBodyClass) document.body.classList.add('flash-shown');
if (captureError && error) Sentry.captureException(error);
return flashContainer;
};
2020-03-13 15:44:24 +05:30
export {
createFlash as default,
2020-10-24 23:57:45 +05:30
deprecatedCreateFlash,
2020-03-13 15:44:24 +05:30
createFlashEl,
createAction,
hideFlash,
removeFlashClickListener,
FLASH_TYPES,
};
2020-11-24 15:15:51 +05:30
window.Flash = createFlash;