bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/common/tooltip/component.jsx

212 lines
5.6 KiB
React
Raw Normal View History

import React, { Component } from 'react';
import PropTypes from 'prop-types';
import cx from 'classnames';
import { ESCAPE } from '/imports/utils/keyCodes';
import { getSettingsSingletonInstance } from '/imports/ui/services/settings';
import Tippy, { roundArrow } from 'tippy.js';
import 'tippy.js/dist/svg-arrow.css';
import 'tippy.js/animations/shift-away.css';
import './bbbtip.css';
2022-02-15 04:20:50 +08:00
import BaseButton from '/imports/ui/components/common/button/base/component';
import ButtonEmoji from '/imports/ui/components/common/button/button-emoji/ButtonEmoji';
2023-02-23 22:23:51 +08:00
import { uniqueId } from '/imports/utils/string-utils';
2019-02-05 01:36:59 +08:00
const ANIMATION_DURATION = 350;
const ANIMATION_DELAY = [150, 50];
const DEFAULT_ANIMATION = 'shift-away';
const ANIMATION_NONE = 'none';
const TIP_OFFSET = [0, 10];
const propTypes = {
title: PropTypes.string,
2021-04-30 01:25:25 +08:00
position: PropTypes.oneOf(['bottom','top']),
children: PropTypes.element.isRequired,
2017-12-12 02:47:34 +08:00
className: PropTypes.string,
};
const defaultProps = {
position: 'bottom',
2017-12-12 02:47:34 +08:00
className: null,
title: '',
};
class Tooltip extends Component {
static buttonComponentHasButtonEmoji(_component) {
return (
_component
&& (_component.type === BaseButton)
&& (_component.props)
&& (_component.props.children)
&& (typeof _component.props.children.find === 'function')
&& (!!_component.props.children.find((_child) => (
_child && _child.type === ButtonEmoji
)))
);
}
constructor(props) {
super(props);
2023-02-23 22:23:51 +08:00
this.tippySelectorId = uniqueId('tippy-');
this.onShow = this.onShow.bind(this);
this.onHide = this.onHide.bind(this);
this.handleEscapeHide = this.handleEscapeHide.bind(this);
}
componentDidMount() {
const {
position,
2018-12-10 09:08:16 +08:00
title,
2023-04-03 16:13:54 +08:00
delay,
placement,
} = this.props;
const Settings = getSettingsSingletonInstance();
const { animations } = Settings.application;
2023-04-03 16:13:54 +08:00
const overridePlacement = placement ? placement : position;
let overrideDelay;
if (animations) {
overrideDelay = delay ? [delay, ANIMATION_DELAY[1]] : ANIMATION_DELAY;
} else {
overrideDelay = delay ? [delay, 0] : [ANIMATION_DELAY[0], 0];
}
const options = {
aria: null,
allowHTML: false,
animation: animations ? DEFAULT_ANIMATION : ANIMATION_NONE,
2022-11-11 01:42:19 +08:00
appendTo: document.body,
arrow: roundArrow,
popperOptions: {
modifiers: [
{
name: 'preventOverflow',
options: {
altAxis: true,
boundary: document.documentElement,
},
},
],
},
2018-12-10 09:08:16 +08:00
content: title,
2023-04-03 16:13:54 +08:00
delay: overrideDelay,
duration: animations ? ANIMATION_DURATION : 0,
2022-11-11 01:42:19 +08:00
interactive: true,
interactiveBorder: 10,
onShow: this.onShow,
onHide: this.onHide,
offset: TIP_OFFSET,
2023-04-03 16:13:54 +08:00
placement: overridePlacement,
touch: ['hold', 1000],
theme: 'bbbtip',
};
this.tooltip = Tippy(`#${this.tippySelectorId}`, options);
}
componentDidUpdate() {
const Settings = getSettingsSingletonInstance();
const { animations } = Settings.application;
2022-11-10 22:28:23 +08:00
const { title } = this.props;
const elements = document.querySelectorAll('[id^="tippy-"]');
2019-01-31 01:43:11 +08:00
Array.from(elements).filter((e) => {
const instance = e._tippy;
2019-02-01 01:29:59 +08:00
if (!instance) return false;
2019-02-01 01:29:59 +08:00
const animation = animations ? DEFAULT_ANIMATION : ANIMATION_NONE;
2019-02-01 01:29:59 +08:00
if (animation === instance.props.animation) return false;
2019-02-01 01:29:59 +08:00
return true;
}).forEach((e) => {
const instance = e._tippy;
const newProps = {
animation: animations
? DEFAULT_ANIMATION : ANIMATION_NONE,
duration: animations ? ANIMATION_DURATION : 0,
};
if (!e.getAttribute("delay")) {
newProps["delay"] = animations ? ANIMATION_DELAY : [ANIMATION_DELAY[0], 0];
}
instance.setProps(newProps);
});
const elem = document.getElementById(this.tippySelectorId);
2022-11-10 22:28:23 +08:00
const opts = { content: title, appendTo: document.body };
if (elem && elem._tippy) elem._tippy.setProps(opts);
}
2021-08-31 20:25:11 +08:00
componentWillUnmount() {
setTimeout(() => {
const tooltip = this.tooltip[0];
if (tooltip) tooltip.hide();
}, 150);
2021-08-31 20:25:11 +08:00
}
onShow() {
document.addEventListener('keyup', this.handleEscapeHide);
}
onHide() {
document.removeEventListener('keyup', this.handleEscapeHide);
}
handleEscapeHide(e) {
if (this.tooltip
&& e.keyCode === ESCAPE
&& this.tooltip.tooltips
&& this.tooltip.tooltips[0]) {
this.tooltip.tooltips[0].hide();
}
}
render() {
const {
children,
className,
2019-04-19 03:00:26 +08:00
title,
...restProps
} = this.props;
let WrappedComponent;
let WrappedComponentBound;
if (Tooltip.buttonComponentHasButtonEmoji(children)) {
const { children: grandChildren } = children.props;
let otherChildren;
[WrappedComponent, ...otherChildren] = grandChildren;
WrappedComponentBound = React.cloneElement(WrappedComponent, {
id: this.tippySelectorId,
className: cx(WrappedComponent.props.className, className),
key: this.tippySelectorId,
});
const ParentComponent = React.Children.only(children);
const updatedChildren = [WrappedComponentBound, ...otherChildren];
return React.cloneElement(ParentComponent, null,
updatedChildren);
}
WrappedComponent = React.Children.only(children);
WrappedComponentBound = React.cloneElement(WrappedComponent, {
...restProps,
id: this.tippySelectorId,
className: cx(children.props.className, className),
});
return WrappedComponentBound;
}
}
export default Tooltip;
Tooltip.defaultProps = defaultProps;
Tooltip.propTypes = propTypes;