primereact
Version:
PrimeReact is an open source UI library for React featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with Prime
276 lines (259 loc) • 10.2 kB
JavaScript
'use client';
import * as React from 'react';
import PrimeReact, { PrimeReactContext, localeOption } from 'primereact/api';
import { ComponentBase, useHandleStyle } from 'primereact/componentbase';
import { CSSTransition } from 'primereact/csstransition';
import { useMergeProps, useEventListener, useUnmountEffect } from 'primereact/hooks';
import { ChevronUpIcon } from 'primereact/icons/chevronup';
import { Ripple } from 'primereact/ripple';
import { classNames, DomHandler, ZIndexUtils, IconUtils } from 'primereact/utils';
function _extends() {
_extends = Object.assign ? Object.assign.bind() : function (target) {
for (var i = 1; i < arguments.length; i++) {
var source = arguments[i];
for (var key in source) {
if (Object.prototype.hasOwnProperty.call(source, key)) {
target[key] = source[key];
}
}
}
return target;
};
return _extends.apply(this, arguments);
}
function _typeof(o) {
"@babel/helpers - typeof";
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) {
return typeof o;
} : function (o) {
return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
}, _typeof(o);
}
function _toPrimitive(input, hint) {
if (_typeof(input) !== "object" || input === null) return input;
var prim = input[Symbol.toPrimitive];
if (prim !== undefined) {
var res = prim.call(input, hint || "default");
if (_typeof(res) !== "object") return res;
throw new TypeError("@@toPrimitive must return a primitive value.");
}
return (hint === "string" ? String : Number)(input);
}
function _toPropertyKey(arg) {
var key = _toPrimitive(arg, "string");
return _typeof(key) === "symbol" ? key : String(key);
}
function _defineProperty(obj, key, value) {
key = _toPropertyKey(key);
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
function _arrayWithHoles(arr) {
if (Array.isArray(arr)) return arr;
}
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 _arrayLikeToArray(arr, len) {
if (len == null || len > arr.length) len = arr.length;
for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
return arr2;
}
function _unsupportedIterableToArray(o, minLen) {
if (!o) return;
if (typeof o === "string") return _arrayLikeToArray(o, minLen);
var n = Object.prototype.toString.call(o).slice(8, -1);
if (n === "Object" && o.constructor) n = o.constructor.name;
if (n === "Map" || n === "Set") return Array.from(o);
if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
}
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 _slicedToArray(arr, i) {
return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
}
var classes = {
root: function root(_ref) {
var props = _ref.props;
return classNames('p-scrolltop p-link p-component', {
'p-scrolltop-sticky': props.target !== 'window'
});
},
icon: 'p-scrolltop-icon',
transition: 'p-scrolltop'
};
var styles = "\n@layer primereact {\n .p-scrolltop {\n position: fixed;\n bottom: 20px;\n right: 20px;\n display: flex;\n align-items: center;\n justify-content: center;\n }\n \n .p-scrolltop-sticky {\n position: sticky;\n }\n \n .p-scrolltop-sticky.p-link {\n margin-left: auto;\n }\n \n .p-scrolltop-helper {\n display: none;\n }\n \n .p-scrolltop-enter {\n opacity: 0;\n }\n \n .p-scrolltop-enter-active {\n opacity: 1;\n transition: opacity .15s;\n }\n \n .p-scrolltop-exit {\n opacity: 1;\n }\n \n .p-scrolltop-exit-active {\n opacity: 0;\n transition: opacity .15s;\n }\n}\n";
var ScrollTopBase = ComponentBase.extend({
defaultProps: {
__TYPE: 'ScrollTop',
target: 'window',
threshold: 400,
icon: null,
behavior: 'smooth',
className: null,
style: null,
transitionOptions: null,
onShow: null,
onHide: null,
children: undefined
},
css: {
classes: classes,
styles: styles
}
});
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; }
var ScrollTop = /*#__PURE__*/React.memo(/*#__PURE__*/React.forwardRef(function (inProps, ref) {
var _React$useState = React.useState(false),
_React$useState2 = _slicedToArray(_React$useState, 2),
visibleState = _React$useState2[0],
setVisibleState = _React$useState2[1];
var mergeProps = useMergeProps();
var context = React.useContext(PrimeReactContext);
var props = ScrollTopBase.getProps(inProps, context);
var _ScrollTopBase$setMet = ScrollTopBase.setMetaData({
props: props,
state: {
visible: visibleState
}
}),
ptm = _ScrollTopBase$setMet.ptm,
cx = _ScrollTopBase$setMet.cx,
isUnstyled = _ScrollTopBase$setMet.isUnstyled;
useHandleStyle(ScrollTopBase.css.styles, isUnstyled, {
name: 'scrolltop'
});
var scrollElementRef = React.useRef(null);
var helperRef = React.useRef(null);
var isTargetParent = props.target === 'parent';
var _useEventListener = useEventListener({
target: function target() {
return helperRef.current && helperRef.current.parentElement;
},
type: 'scroll',
listener: function listener(event) {
checkVisibility(event.currentTarget.scrollTop);
}
}),
_useEventListener2 = _slicedToArray(_useEventListener, 1),
bindParentScrollListener = _useEventListener2[0];
var _useEventListener3 = useEventListener({
target: 'window',
type: 'scroll',
listener: function listener(event) {
event && checkVisibility(DomHandler.getWindowScrollTop());
}
}),
_useEventListener4 = _slicedToArray(_useEventListener3, 1),
bindDocumentScrollListener = _useEventListener4[0];
var onClick = function onClick() {
var scrollElement = props.target === 'window' ? window : helperRef.current.parentElement;
scrollElement.scroll({
top: 0,
behavior: props.behavior
});
};
var checkVisibility = function checkVisibility(scrollY) {
setVisibleState(scrollY > props.threshold);
};
var onEnter = function onEnter() {
ZIndexUtils.set('overlay', scrollElementRef.current, context && context.autoZIndex || PrimeReact.autoZIndex, context && context.zIndex.overlay || PrimeReact.zIndex.overlay);
};
var onEntered = function onEntered() {
props.onShow && props.onShow();
};
var onExited = function onExited() {
ZIndexUtils.clear(scrollElementRef.current);
props.onHide && props.onHide();
};
React.useImperativeHandle(ref, function () {
return {
props: props,
getElement: function getElement() {
return elementRef.current;
}
};
});
React.useEffect(function () {
if (props.target === 'window') {
bindDocumentScrollListener();
} else if (props.target === 'parent') {
bindParentScrollListener();
}
}, []); // eslint-disable-line react-hooks/exhaustive-deps
useUnmountEffect(function () {
ZIndexUtils.clear(scrollElementRef.current);
});
var iconProps = mergeProps({
className: cx('icon')
}, ptm('icon'));
var icon = props.icon || /*#__PURE__*/React.createElement(ChevronUpIcon, iconProps);
var scrollIcon = IconUtils.getJSXIcon(icon, _objectSpread({}, iconProps), {
props: props
});
var scrollTopAriaLabel = localeOption('aria') ? localeOption('aria').scrollTop : undefined;
var rootProps = mergeProps({
ref: scrollElementRef,
type: 'button',
className: classNames(props.className, cx('root')),
style: props.style,
onClick: onClick,
'aria-label': scrollTopAriaLabel
}, ScrollTopBase.getOtherProps(props), ptm('root'));
var transitionProps = mergeProps({
classNames: cx('transition'),
"in": visibleState,
timeout: {
enter: 150,
exit: 150
},
options: props.transitionOptions,
unmountOnExit: true,
onEnter: onEnter,
onEntered: onEntered,
onExited: onExited
}, ptm('transition'));
return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(CSSTransition, _extends({
nodeRef: scrollElementRef
}, transitionProps), /*#__PURE__*/React.createElement("button", rootProps, scrollIcon, /*#__PURE__*/React.createElement(Ripple, null))), isTargetParent && /*#__PURE__*/React.createElement("span", {
ref: helperRef,
className: "p-scrolltop-helper"
}));
}));
ScrollTop.displayName = 'ScrollTop';
export { ScrollTop };