@gitlab/ui
Version:
GitLab UI Components
203 lines (185 loc) • 6.64 kB
JavaScript
import { NAME_TOAST_POP, NAME_TOASTER, NAME_TOAST } from '../../../constants/components';
import { HOOK_EVENT_NAME_DESTROYED, EVENT_NAME_HIDDEN, EVENT_NAME_DESTROYED, EVENT_NAME_SHOW, EVENT_NAME_HIDE } from '../../../constants/events';
import { useParentMixin } from '../../../mixins/use-parent';
import { concat } from '../../../utils/array';
import { getComponentConfig } from '../../../utils/config';
import { requestAF } from '../../../utils/dom';
import { getRootEventName, getRootActionEventName } from '../../../utils/events';
import { isUndefined } from '../../../utils/inspect';
import { keys, omit, hasOwnProperty, defineProperty, assign, defineProperties, readonlyDescriptor } from '../../../utils/object';
import { pluginFactory } from '../../../utils/plugins';
import { warn, warnNotClient } from '../../../utils/warn';
import { createNewChildComponent } from '../../../utils/create-new-child-component';
import { getEventRoot } from '../../../utils/get-event-root';
import { props, BToast } from '../toast';
/**
* Plugin for adding `$bvToast` property to all Vue instances
*/
// --- Constants ---
const PROP_NAME = '$bvToast';
const PROP_NAME_PRIV = '_bv__toast';
// Base toast props that are allowed
// Some may be ignored or overridden on some message boxes
// Prop ID is allowed, but really only should be used for testing
// We need to add it in explicitly as it comes from the `idMixin`
const BASE_PROPS = ['id', ...keys(omit(props, ['static', 'visible']))];
// Map prop names to toast slot names
const propsToSlots = {
toastContent: 'default',
title: 'toast-title'
};
// --- Helper methods ---
// Method to filter only recognized props that are not undefined
const filterOptions = options => {
return BASE_PROPS.reduce((memo, key) => {
if (!isUndefined(options[key])) {
memo[key] = options[key];
}
return memo;
}, {});
};
// Method to install `$bvToast` VM injection
const plugin = Vue => {
// Create a private sub-component constructor that
// extends BToast and self-destructs after hidden
// @vue/component
const BVToastPop = Vue.extend({
name: NAME_TOAST_POP,
extends: BToast,
mixins: [useParentMixin],
destroyed() {
// Make sure we not in document any more
const {
$el
} = this;
if ($el && $el.parentNode) {
$el.parentNode.removeChild($el);
}
},
mounted() {
// Self destruct handler
const handleDestroy = () => {
// Ensure the toast has been force hidden
this.localShow = false;
this.doRender = false;
this.$nextTick(() => {
this.$nextTick(() => {
// In a `requestAF()` to release control back to application
// and to allow the portal-target time to remove the content
requestAF(() => {
this.$destroy();
});
});
});
};
// Self destruct if parent destroyed
this.bvParent.$once(HOOK_EVENT_NAME_DESTROYED, handleDestroy);
// Self destruct after hidden
this.$once(EVENT_NAME_HIDDEN, handleDestroy);
// Self destruct when toaster is destroyed
this.listenOnRoot(getRootEventName(NAME_TOASTER, EVENT_NAME_DESTROYED), toaster => {
/* istanbul ignore next: hard to test */
if (toaster === this.toaster) {
handleDestroy();
}
});
}
});
// Private method to generate the on-demand toast
const makeToast = (props, parent) => {
if (warnNotClient(PROP_NAME)) {
/* istanbul ignore next */
return;
}
// Create an instance of `BVToastPop` component
const toast = createNewChildComponent(parent, BVToastPop, {
// We set parent as the local VM so these toasts can emit events on the
// app `$root`, and it ensures `BToast` is destroyed when parent is destroyed
propsData: {
...filterOptions(getComponentConfig(NAME_TOAST)),
// Add in (filtered) user supplied props
...omit(props, keys(propsToSlots)),
// Props that can't be overridden
static: false,
visible: true
}
});
// Convert certain props to slots
keys(propsToSlots).forEach(prop => {
const value = props[prop];
if (!isUndefined(value)) {
toast.$slots[propsToSlots[prop]] = concat(value);
}
});
// Create a mount point (a DIV) and mount it (which triggers the show)
const div = document.createElement('div');
document.body.appendChild(div);
toast.$mount(div);
};
// Declare BvToast instance property class
class BvToast {
constructor(vm) {
// Assign the new properties to this instance
assign(this, {
_vm: vm,
_root: getEventRoot(vm)
});
// Set these properties as read-only and non-enumerable
defineProperties(this, {
_vm: readonlyDescriptor(),
_root: readonlyDescriptor()
});
}
// --- Public Instance methods ---
// Opens a user defined toast and returns immediately
toast(content) {
let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
if (!content || warnNotClient(PROP_NAME)) {
/* istanbul ignore next */
return;
}
makeToast({
...filterOptions(options),
toastContent: content
}, this._vm);
}
// shows a `<b-toast>` component with the specified ID
show(id) {
if (id) {
this._root.$emit(getRootActionEventName(NAME_TOAST, EVENT_NAME_SHOW), id);
}
}
// Hide a toast with specified ID, or if not ID all toasts
hide() {
let id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
this._root.$emit(getRootActionEventName(NAME_TOAST, EVENT_NAME_HIDE), id);
}
}
// Add our instance mixin
Vue.mixin({
beforeCreate() {
// Because we need access to `$root` for `$emits`, and VM for parenting,
// we have to create a fresh instance of `BvToast` for each VM
this[PROP_NAME_PRIV] = new BvToast(this);
}
});
// Define our read-only `$bvToast` instance property
// Placed in an if just in case in HMR mode
if (!hasOwnProperty(Vue.prototype, PROP_NAME)) {
defineProperty(Vue.prototype, PROP_NAME, {
get() {
/* istanbul ignore next */
if (!this || !this[PROP_NAME_PRIV]) {
warn(`"${PROP_NAME}" must be accessed from a Vue instance "this" context.`, NAME_TOAST);
}
return this[PROP_NAME_PRIV];
}
});
}
};
const BVToastPlugin = /*#__PURE__*/pluginFactory({
plugins: {
plugin
}
});
export { BVToastPlugin };