dash-core-components
Version:
Core component suite for Dash
254 lines (253 loc) • 12.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _react = _interopRequireWildcard(require("react"));
var _ramda = require("ramda");
var _propTypes = _interopRequireDefault(require("prop-types"));
var _GraphSpinner = _interopRequireDefault(require("../fragments/Loading/spinners/GraphSpinner.jsx"));
var _DefaultSpinner = _interopRequireDefault(require("../fragments/Loading/spinners/DefaultSpinner.jsx"));
var _CubeSpinner = _interopRequireDefault(require("../fragments/Loading/spinners/CubeSpinner.jsx"));
var _CircleSpinner = _interopRequireDefault(require("../fragments/Loading/spinners/CircleSpinner.jsx"));
var _DotSpinner = _interopRequireDefault(require("../fragments/Loading/spinners/DotSpinner.jsx"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
var spinnerComponentOptions = {
graph: _GraphSpinner.default,
cube: _CubeSpinner.default,
circle: _CircleSpinner.default,
dot: _DotSpinner.default
};
var getSpinner = spinnerType => spinnerComponentOptions[spinnerType] || _DefaultSpinner.default;
var coveringSpinner = {
visibility: 'visible',
position: 'absolute',
top: '0',
height: '100%',
width: '100%',
display: 'flex',
justifyContent: 'center',
alignItems: 'center'
};
var loadingSelector = (componentPath, targetComponents) => state => {
var stringPath = JSON.stringify(componentPath);
// Remove the last ] for easy match and add `,` to make sure only children
// trigger the loading. See issue: https://github.com/plotly/dash/issues/3276
stringPath = stringPath.substring(0, stringPath.length - 1) + ',';
var loadingChildren = (0, _ramda.toPairs)(state.loading).reduce((acc, _ref) => {
var _ref2 = _slicedToArray(_ref, 2),
path = _ref2[0],
load = _ref2[1];
if (path.startsWith(stringPath) && load.length) {
if (targetComponents && !(0, _ramda.any)(l => {
var target = targetComponents[l.id];
if (!target) {
return false;
}
if (target === '*') {
return true;
}
if (Array.isArray(target)) {
return (0, _ramda.includes)(l.property, target);
}
return l.property === target;
}, load)) {
return acc;
}
return (0, _ramda.concat)(acc, load);
}
return acc;
}, []);
if (loadingChildren.length) {
return loadingChildren;
}
return null;
};
function Loading(_ref3) {
var children = _ref3.children,
_ref3$display = _ref3.display,
display = _ref3$display === void 0 ? 'auto' : _ref3$display,
_ref3$color = _ref3.color,
color = _ref3$color === void 0 ? '#119DFF' : _ref3$color,
id = _ref3.id,
className = _ref3.className,
style = _ref3.style,
parent_className = _ref3.parent_className,
parent_style = _ref3.parent_style,
overlay_style = _ref3.overlay_style,
fullscreen = _ref3.fullscreen,
debug = _ref3.debug,
_ref3$show_initially = _ref3.show_initially,
show_initially = _ref3$show_initially === void 0 ? true : _ref3$show_initially,
spinnerType = _ref3.type,
_ref3$delay_hide = _ref3.delay_hide,
delay_hide = _ref3$delay_hide === void 0 ? 0 : _ref3$delay_hide,
_ref3$delay_show = _ref3.delay_show,
delay_show = _ref3$delay_show === void 0 ? 0 : _ref3$delay_show,
target_components = _ref3.target_components,
custom_spinner = _ref3.custom_spinner;
var ctx = window.dash_component_api.useDashContext();
var loading = ctx.useSelector(loadingSelector(ctx.componentPath, target_components), _ramda.equals);
var _useState = (0, _react.useState)(show_initially),
_useState2 = _slicedToArray(_useState, 2),
showSpinner = _useState2[0],
setShowSpinner = _useState2[1];
var dismissTimer = (0, _react.useRef)();
var showTimer = (0, _react.useRef)();
var containerStyle = (0, _react.useMemo)(() => {
if (showSpinner) {
return _objectSpread(_objectSpread({
visibility: 'hidden'
}, overlay_style), parent_style);
}
return parent_style;
}, [showSpinner, parent_style]);
(0, _react.useEffect)(() => {
if (display === 'show' || display === 'hide') {
setShowSpinner(display === 'show');
return;
}
if (loading) {
// if component is currently loading and there's a dismiss timer active
// we need to clear it.
if (dismissTimer.current) {
dismissTimer.current = clearTimeout(dismissTimer.current);
}
// if component is currently loading but the spinner is not showing and
// there is no timer set to show, then set a timeout to show
if (!showSpinner && !showTimer.current) {
showTimer.current = setTimeout(() => {
setShowSpinner(true);
showTimer.current = null;
}, delay_show);
}
} else {
// if component is not currently loading and there's a show timer
// active we need to clear it
if (showTimer.current) {
showTimer.current = clearTimeout(showTimer.current);
}
// if component is not currently loading and the spinner is showing and
// there's no timer set to dismiss it, then set a timeout to hide it
if (showSpinner && !dismissTimer.current) {
dismissTimer.current = setTimeout(() => {
setShowSpinner(false);
dismissTimer.current = null;
}, delay_hide);
}
}
}, [delay_hide, delay_show, loading, display, showSpinner]);
var Spinner = showSpinner && getSpinner(spinnerType);
return /*#__PURE__*/_react.default.createElement("div", {
style: _objectSpread({
position: 'relative'
}, parent_style),
className: parent_className
}, /*#__PURE__*/_react.default.createElement("div", {
className: parent_className,
style: containerStyle
}, children), /*#__PURE__*/_react.default.createElement("div", {
id: id,
style: showSpinner ? coveringSpinner : {}
}, showSpinner && (custom_spinner || /*#__PURE__*/_react.default.createElement(Spinner, {
className: className,
style: style,
status: loading,
color: color,
debug: debug,
fullscreen: fullscreen
}))));
}
Loading.propTypes = {
/**
* The ID of this component, used to identify dash components
* in callbacks. The ID needs to be unique across all of the
* components in an app.
*/
id: _propTypes.default.string,
/**
* Array that holds components to render
*/
children: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.node), _propTypes.default.node]),
/**
* Property that determines which built-in spinner to show
* one of 'graph', 'cube', 'circle', 'dot', or 'default'.
*/
type: _propTypes.default.oneOf(['graph', 'cube', 'circle', 'dot', 'default']),
/**
* Boolean that makes the built-in spinner display full-screen
*/
fullscreen: _propTypes.default.bool,
/**
* If true, the built-in spinner will display the component_name and prop_name
* while loading
*/
debug: _propTypes.default.bool,
/**
* Additional CSS class for the built-in spinner root DOM node
*/
className: _propTypes.default.string,
/**
* Additional CSS class for the outermost dcc.Loading parent div DOM node
*/
parent_className: _propTypes.default.string,
/**
* Additional CSS styling for the built-in spinner root DOM node
*/
style: _propTypes.default.object,
/**
* Additional CSS styling for the outermost dcc.Loading parent div DOM node
*/
parent_style: _propTypes.default.object,
/**
* Additional CSS styling for the spinner overlay. This is applied to the
* dcc.Loading children while the spinner is active. The default is `{'visibility': 'hidden'}`
*/
overlay_style: _propTypes.default.object,
/**
* Primary color used for the built-in loading spinners
*/
color: _propTypes.default.string,
/**
* Setting display to "show" or "hide" will override the loading state coming from dash-renderer
*/
display: _propTypes.default.oneOf(['auto', 'show', 'hide']),
/**
* Add a time delay (in ms) to the spinner being removed to prevent flickering.
*/
delay_hide: _propTypes.default.number,
/**
* Add a time delay (in ms) to the spinner being shown after the loading_state
* is set to True.
*/
delay_show: _propTypes.default.number,
/**
* Whether the Spinner should show on app start-up before the loading state
* has been determined. Default True. Use when also setting `delay_show`.
*/
show_initially: _propTypes.default.bool,
/**
* Specify component and prop to trigger showing the loading spinner
* example: `{"output-container": "children", "grid": ["rowData", "columnDefs]}`
*
*/
target_components: _propTypes.default.objectOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)])),
/**
* Component to use rather than the built-in spinner specified in the `type` prop.
*
*/
custom_spinner: _propTypes.default.node
};
var _default = exports.default = Loading;