@elastic/eui
Version:
Elastic UI Component Library
197 lines (196 loc) • 8.69 kB
JavaScript
import _defineProperty from "@babel/runtime/helpers/defineProperty";
import _extends from "@babel/runtime/helpers/extends";
import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
var _excluded = ["anchorPosition", "anchor", "children", "className", "css", "closePopover", "content", "isStepOpen", "minWidth", "maxWidth", "onFinish", "step", "stepsTotal", "style", "subtitle", "title", "decoration", "footerAction", "panelProps"];
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import React, { useEffect, useRef, useState } from 'react';
import classNames from 'classnames';
import { EuiBeacon } from '../beacon';
import { EuiButtonEmpty } from '../button';
import { EuiFlexGroup, EuiFlexItem } from '../flex';
import { EuiI18n } from '../i18n';
import { EuiPopover, EuiPopoverFooter, EuiPopoverTitle, EuiWrappingPopover } from '../popover';
import { EuiTitle } from '../title';
import { EuiTourStepIndicator } from './tour_step_indicator';
import { useGeneratedHtmlId, findElementBySelectorOrRef, useEuiTheme } from '../../services';
import { euiTourStyles, euiTourBeaconStyles, euiTourFooterStyles, euiTourHeaderStyles } from './tour.styles';
import { jsx as ___EmotionJSX } from "@emotion/react";
export var EuiTourStep = function EuiTourStep(_ref) {
var _ref$anchorPosition = _ref.anchorPosition,
anchorPosition = _ref$anchorPosition === void 0 ? 'leftUp' : _ref$anchorPosition,
anchor = _ref.anchor,
children = _ref.children,
className = _ref.className,
css = _ref.css,
_ref$closePopover = _ref.closePopover,
closePopover = _ref$closePopover === void 0 ? function () {} : _ref$closePopover,
content = _ref.content,
_ref$isStepOpen = _ref.isStepOpen,
isStepOpen = _ref$isStepOpen === void 0 ? false : _ref$isStepOpen,
_ref$minWidth = _ref.minWidth,
minWidth = _ref$minWidth === void 0 ? 300 : _ref$minWidth,
_ref$maxWidth = _ref.maxWidth,
maxWidth = _ref$maxWidth === void 0 ? 600 : _ref$maxWidth,
onFinish = _ref.onFinish,
_ref$step = _ref.step,
step = _ref$step === void 0 ? 1 : _ref$step,
stepsTotal = _ref.stepsTotal,
style = _ref.style,
subtitle = _ref.subtitle,
title = _ref.title,
_ref$decoration = _ref.decoration,
decoration = _ref$decoration === void 0 ? 'beacon' : _ref$decoration,
footerAction = _ref.footerAction,
panelProps = _ref.panelProps,
rest = _objectWithoutProperties(_ref, _excluded);
var titleId = useGeneratedHtmlId();
if (step === 0) {
console.warn('EuiTourStep `step` should 1-based indexing. Please update to eliminate 0 indexes.');
}
var _useState = useState(false),
_useState2 = _slicedToArray(_useState, 2),
hasValidAnchor = _useState2[0],
setHasValidAnchor = _useState2[1];
var animationFrameId = useRef();
var anchorNode = useRef(null);
var _useState3 = useState(),
_useState4 = _slicedToArray(_useState3, 2),
popoverPosition = _useState4[0],
setPopoverPosition = _useState4[1];
var onPositionChange = function onPositionChange(position) {
setPopoverPosition(position);
};
useEffect(function () {
if (anchor) {
animationFrameId.current = window.requestAnimationFrame(function () {
anchorNode.current = findElementBySelectorOrRef(anchor);
setHasValidAnchor(anchorNode.current ? true : false);
});
}
return function () {
animationFrameId.current && window.cancelAnimationFrame(animationFrameId.current);
};
}, [anchor]);
var classes = classNames('euiTour', className);
var euiTheme = useEuiTheme();
var tourStyles = euiTourStyles(euiTheme);
var headerStyles = euiTourHeaderStyles(euiTheme);
var footerStyles = euiTourFooterStyles(euiTheme);
var beaconStyles = euiTourBeaconStyles(euiTheme);
var beaconCss = [beaconStyles.euiTourBeacon, isStepOpen && beaconStyles.isOpen, popoverPosition && beaconStyles[popoverPosition]];
var finishButtonProps = {
color: 'text',
flush: 'right',
size: 'xs'
};
var optionalFooterAction = Array.isArray(footerAction) ? ___EmotionJSX(EuiFlexGroup, {
gutterSize: "s",
alignItems: "center",
justifyContent: "flexEnd",
responsive: false,
wrap: true
}, footerAction.map(function (action, index) {
return ___EmotionJSX(EuiFlexItem, {
key: index,
grow: false
}, action);
})) : ___EmotionJSX(EuiFlexItem, {
grow: false
}, footerAction);
var footer = ___EmotionJSX(EuiFlexGroup, {
responsive: false,
justifyContent: stepsTotal > 1 ? 'spaceBetween' : 'flexEnd',
alignItems: "center"
}, stepsTotal > 1 && ___EmotionJSX(EuiFlexItem, {
grow: false
}, ___EmotionJSX("ul", {
className: "euiTourFooter__stepList"
}, _toConsumableArray(Array(stepsTotal).keys()).map(function (_, i) {
var status = 'complete';
if (step === i + 1) {
status = 'active';
} else if (step <= i) {
status = 'incomplete';
}
return ___EmotionJSX(EuiTourStepIndicator, {
key: i,
number: i + 1,
status: status
});
}))), footerAction ? optionalFooterAction : ___EmotionJSX(EuiFlexItem, {
grow: false
}, ___EmotionJSX(EuiI18n, {
tokens: ['euiTourStep.endTour', 'euiTourStep.skipTour', 'euiTourStep.closeTour'],
defaults: ['End tour', 'Skip tour', 'Close tour']
}, function (_ref2) {
var _ref3 = _slicedToArray(_ref2, 3),
endTour = _ref3[0],
skipTour = _ref3[1],
closeTour = _ref3[2];
var content = closeTour;
if (stepsTotal > 1) {
content = stepsTotal === step ? endTour : skipTour;
}
return ___EmotionJSX(EuiButtonEmpty, _extends({
onClick: onFinish
}, finishButtonProps), content);
})));
var hasBeacon = decoration === 'beacon';
var popoverProps = _objectSpread({
anchorPosition: anchorPosition,
closePopover: closePopover,
isOpen: isStepOpen,
ownFocus: false,
panelClassName: classes,
panelStyle: style,
panelProps: _objectSpread(_objectSpread({}, panelProps), {}, {
css: [tourStyles.euiTour, css, panelProps === null || panelProps === void 0 ? void 0 : panelProps.css]
}),
offset: hasBeacon ? 10 : 0,
'aria-labelledby': titleId,
arrowChildren: hasBeacon && ___EmotionJSX(EuiBeacon, {
css: beaconCss,
className: "euiTour__beacon"
}),
onPositionChange: onPositionChange
}, rest);
var layout = ___EmotionJSX("div", {
style: {
minWidth: minWidth,
maxWidth: maxWidth
}
}, ___EmotionJSX(EuiPopoverTitle, {
css: headerStyles.euiTourHeader,
className: "euiTourHeader",
id: titleId
}, subtitle && ___EmotionJSX(EuiTitle, {
css: headerStyles.euiTourHeader__subtitle,
size: "xxxs"
}, ___EmotionJSX("h2", null, subtitle)), ___EmotionJSX(EuiTitle, {
css: headerStyles.euiTourHeader__title,
size: "xxs"
}, subtitle ? ___EmotionJSX("h3", null, title) : ___EmotionJSX("h2", null, title))), ___EmotionJSX("div", {
className: "euiTour__content"
}, content), ___EmotionJSX(EuiPopoverFooter, {
css: footerStyles.euiTourFooter,
className: "euiTourFooter"
}, footer));
if (!anchor && children) {
return ___EmotionJSX(EuiPopover, _extends({
button: children
}, popoverProps), layout);
}
return hasValidAnchor && anchorNode.current ? ___EmotionJSX(EuiWrappingPopover, _extends({
button: anchorNode.current
}, popoverProps), layout) : null;
};