primereact 8.7.3 → 9.0.0-rc.1

package/tooltip/tooltipoptions.d.ts

@@ -1,39 +1,358 @@
+/**
+ *
+ * This module contains the common options and events of Tooltip.
+ *
+ * @module tooltipoptions
+ *
+ */
 import * as React from 'react';
 
-type TooltipPositionType = 'top' | 'bottom' | 'left' | 'right' | 'mouse';
+/**
+ * Custom tooltip event
+ * @event
+ */
+interface TooltipEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: React.SyntheticEvent;
+    /**
+     * Target element.
+     * @defaultValue current target
+     */
+    target: HTMLElement;
+}
 
-type TooltipEventType = 'hover' | 'focus' | 'both';
+/**
+ * Defines valid properties of TooltipOptions.
+ * @group Misc
+ */
+export interface TooltipOptions {
+    /**
+     * DOM element instance where the overlay panel should be mounted. Valid values are any DOM Element and 'self'. The self value is used to render a component where it is located.
+     * @defaultValue document.body
+     */
+    appendTo?: 'self' | HTMLElement | null | undefined;
+    /**
+     * Defines which position on the target element to align the positioned tooltip.
+     */
+    at?: string | undefined;
+    /**
+     * Whether to hide tooltip when hovering over tooltip content.
+     * @defaultValue true
+     */
+    autoHide?: boolean | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @defaultValue true
+     */
+    autoZIndex?: boolean | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * @defaultValue 0
+     */
+    baseZIndex?: number | undefined;
+    /**
+     * Style class of the tooltip.
+     */
+    className?: string | undefined;
+    /**
+     * When present, it specifies that the tooltip should be hidden.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+    /**
+     * Event to show the tooltip.
+     * @defaultValue hover
+     */
+    event?: 'hover' | 'focus' | 'both' | undefined;
+    /**
+     * Delay to hide the tooltip in milliseconds.
+     * @defaultValue 0
+     */
+    hideDelay?: number | undefined;
+    /**
+     * Event to hide the tooltip if the event property is empty.
+     * @defaultValue mouseleave
+     */
+    hideEvent?: string | undefined;
+    /**
+     * Whether the tooltip will follow the mouse.
+     * @defaultValue false
+     */
+    mouseTrack?: boolean | undefined;
+    /**
+     * Defines left position of the tooltip in relation to the mouse when the mouseTrack is enabled.
+     * @defaultValue 5
+     */
+    mouseTrackLeft?: number | undefined;
+    /**
+     * Defines top position of the tooltip in relation to the mouse when the mouseTrack is enabled.
+     * @defaultValue 5
+     */
+    mouseTrackTop?: number | undefined;
+    /**
+     * Defines which position on the tooltip being positioned to align with the target element.
+     */
+    my?: string | undefined;
+    /**
+     * Position of the tooltip.
+     * @defaultValue right
+     */
+    position?: 'top' | 'bottom' | 'left' | 'right' | 'mouse' | undefined;
+    /**
+     * Delay to show the tooltip in milliseconds.
+     * @defaultValue 0
+     */
+    showDelay?: number | undefined;
+    /**
+     * Event to show the tooltip if the event property is empty.
+     * @defaultValue mouseenter
+     */
+    showEvent?: string | undefined;
+    /**
+     * Whether to show tooltip for disabled elements.
+     * @defaultValue false
+     */
+    showOnDisabled?: boolean | undefined;
+    /**
+     * Style of the tooltip.
+     */
+    style?: React.CSSProperties | undefined;
+    /**
+     * Delay to update the tooltip in milliseconds.
+     * @defaultValue 0
+     */
+    updateDelay?: number | undefined;
+    /**
+     * Callback to invoke before the tooltip is shown.
+     * @param {TooltipEvent} event - Browser event
+     */
+    onBeforeShow?(event: TooltipEvent): void;
+    /**
+     * Callback to invoke before the tooltip is hidden.
+     * @param {TooltipEvent} event - Browser event
+     */
+    onBeforeHide?(event: TooltipEvent): void;
+    /**
+     * Callback to invoke when the tooltip is shown.
+     * @param {TooltipEvent} event - Browser event
+     */
+    onShow?(event: TooltipEvent): void;
+    /**
+     * Callback to invoke when the tooltip is hidden.
+     * @param {TooltipEvent} event - Browser event
+     */
+    onHide?(event: TooltipEvent): void;
+}
 
-type TooltipAppendToType = 'self' | HTMLElement | undefined | null;
+/**
+ * In addition to React.HTMLAttributes, the following attributes can be used on any HTMLElement if the page has a PrimeReact {@link tooltip} component.
+ * @group Misc
+ */
 
-interface TooltipEventParams {
-    originalEvent: React.SyntheticEvent;
-    target: HTMLElement;
+interface TooltipHTMLAttributes {
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Content of the tooltip.*
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-tooltip'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * When present, it specifies that the tooltip should be hidden.*
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-disabled'?: boolean | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Style class of the tooltip.*
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-classname'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Position of the tooltip.*
+     * @defaultValue right
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-position'?: 'top' | 'bottom' | 'left' | 'right' | 'mouse' | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Defines which position on the tooltip being positioned to align with the target element.*
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-my'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Defines which position on the target element to align the positioned tooltip.*
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-at'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Event to show the tooltip.*
+     * @defaultValue hover
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-event'?: 'hover' | 'focus' | 'both' | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Event to show the tooltip if the event property is empty.*
+     * @defaultValue mouseenter
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-showevent'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Event to hide the tooltip if the event property is empty.*
+     * @defaultValue mouseleave
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-hideevent'?: string | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Whether the tooltip will follow the mouse.*
+     * @defaultValue false
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-mousetrack'?: boolean | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Defines top position of the tooltip in relation to the mouse when the mouseTrack is enabled.*
+     * @defaultValue 5
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-mousetracktop'?: number | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Defines left position of the tooltip in relation to the mouse when the mouseTrack is enabled.*
+     * @defaultValue 5
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-mousetrackleft'?: number | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Delay to show the tooltip in milliseconds.*
+     * @defaultValue 0
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-showdelay'?: number | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Delay to update the tooltip in milliseconds.*
+     * @defaultValue 0
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-updatedelay'?: number | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Delay to hide the tooltip in milliseconds.*
+     * @defaultValue 0
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-hidedelay'?: number | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Whether to hide tooltip when hovering over tooltip content.*
+     * @defaultValue true
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-autohide'?: boolean | undefined;
+    /**
+     * **PrimeReact - TooltipHTMLAttributes**
+     *
+     * Whether to show tooltip for disabled elements.*
+     * @defaultValue false
+     *
+     * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
+     * ___
+     *
+     * _*This feature will be active when there is a PrimeReact {@link tooltip} component on the page._
+     */
+    'data-pr-showondisabled'?: boolean | undefined;
 }
 
-export default interface TooltipOptions {
-    appendTo?: TooltipAppendToType;
-    at?: string;
-    autoHide?: boolean;
-    autoZIndex?: boolean;
-    baseZIndex?: number;
-    className?: string;
-    disabled?: boolean;
-    event?: TooltipEventType;
-    hideDelay?: number;
-    hideEvent?: string;
-    mouseTrack?: boolean;
-    mouseTrackLeft?: number;
-    mouseTrackTop?: number;
-    my?: string;
-    position?: TooltipPositionType;
-    showDelay?: number;
-    showEvent?: string;
-    showOnDisabled?: boolean;
-    style?: React.CSSProperties;
-    updateDelay?: number;
-    onBeforeShow?(e: TooltipEventParams): void;
-    onBeforeHide?(e: TooltipEventParams): void;
-    onShow?(e: TooltipEventParams): void;
-    onHide?(e: TooltipEventParams): void;
+declare module 'react' {
+    export interface HTMLAttributes<T> extends AriaAttributes, DOMAttributes<T>, TooltipHTMLAttributes {}
 }

package/tree/package.json

@@ -2,5 +2,6 @@
     "main": "./tree.cjs.js",
     "module": "./tree.esm.js",
     "unpkg": "./tree.min.js",
-    "types": "./tree.d.ts"
+    "types": "./tree.d.ts",
+    "sideEffects": false
 }

package/tree/tree.cjs.js

@@ -44,9 +44,7 @@ function _extends() {
 
 function _arrayLikeToArray$2(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];
-  }
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
   return arr2;
 }
 
@@ -134,9 +132,7 @@ function _iterableToArrayLimit(arr, i) {
       if (_x = (_i = _i.call(arr)).next, 0 === i) {
         if (Object(_i) !== _i) return;
         _n = !1;
-      } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0) {
-        ;
-      }
+      } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0);
     } catch (err) {
       _d = !0, _e = err;
     } finally {
@@ -158,9 +154,63 @@ function _slicedToArray(arr, i) {
   return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray$2(arr, i) || _nonIterableRest();
 }
 
+var TreeBase = {
+  defaultProps: {
+    __TYPE: 'Tree',
+    id: null,
+    value: null,
+    disabled: false,
+    selectionMode: null,
+    selectionKeys: null,
+    onSelectionChange: null,
+    contextMenuSelectionKey: null,
+    onContextMenuSelectionChange: null,
+    expandedKeys: null,
+    style: null,
+    className: null,
+    contentStyle: null,
+    contentClassName: null,
+    metaKeySelection: true,
+    propagateSelectionUp: true,
+    propagateSelectionDown: true,
+    loading: false,
+    loadingIcon: 'pi pi-spinner',
+    dragdropScope: null,
+    header: null,
+    footer: null,
+    showHeader: true,
+    filter: false,
+    filterValue: null,
+    filterBy: 'label',
+    filterMode: 'lenient',
+    filterPlaceholder: null,
+    filterLocale: undefined,
+    filterTemplate: null,
+    nodeTemplate: null,
+    togglerTemplate: null,
+    onSelect: null,
+    onUnselect: null,
+    onExpand: null,
+    onCollapse: null,
+    onToggle: null,
+    onDragDrop: null,
+    onContextMenu: null,
+    onFilterValueChange: null,
+    onNodeClick: null,
+    onNodeDoubleClick: null,
+    children: undefined
+  },
+  getProps: function getProps(props) {
+    return utils.ObjectUtils.getMergedProps(props, TreeBase.defaultProps);
+  },
+  getOtherProps: function getOtherProps(props) {
+    return utils.ObjectUtils.getDiffProps(props, TreeBase.defaultProps);
+  }
+};
+
 function _createForOfIteratorHelper$1(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray$1(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray$1(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray$1(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$1(o, minLen); }
-function _arrayLikeToArray$1(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 _arrayLikeToArray$1(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 ownKeys$1(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$1(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$1(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$1(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var UITreeNode = /*#__PURE__*/React__namespace.memo(function (props) {
@@ -806,8 +856,9 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 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; }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
 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 _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; }
-var Tree = /*#__PURE__*/React__namespace.memo( /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
+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; }
+var Tree = /*#__PURE__*/React__namespace.memo( /*#__PURE__*/React__namespace.forwardRef(function (inProps, ref) {
+  var props = TreeBase.getProps(inProps);
   var _React$useState = React__namespace.useState(''),
     _React$useState2 = _slicedToArray(_React$useState, 2),
     filterValueState = _React$useState2[0],
@@ -1217,7 +1268,7 @@ var Tree = /*#__PURE__*/React__namespace.memo( /*#__PURE__*/React__namespace.for
       className: "p-tree-footer"
     }, content);
   };
-  var otherProps = utils.ObjectUtils.findDiffKeys(props, Tree.defaultProps);
+  var otherProps = TreeBase.getOtherProps(props);
   var ariaProps = utils.ObjectUtils.reduceKeys(otherProps, utils.DomHandler.ARIA_PROPS);
   var className = utils.classNames('p-tree p-component', props.className, {
     'p-tree-selectable': props.selectionMode,
@@ -1236,49 +1287,5 @@ var Tree = /*#__PURE__*/React__namespace.memo( /*#__PURE__*/React__namespace.for
   }, otherProps), loader, header, content, footer);
 }));
 Tree.displayName = 'Tree';
-Tree.defaultProps = {
-  __TYPE: 'Tree',
-  id: null,
-  value: null,
-  disabled: false,
-  selectionMode: null,
-  selectionKeys: null,
-  onSelectionChange: null,
-  contextMenuSelectionKey: null,
-  onContextMenuSelectionChange: null,
-  expandedKeys: null,
-  style: null,
-  className: null,
-  contentStyle: null,
-  contentClassName: null,
-  metaKeySelection: true,
-  propagateSelectionUp: true,
-  propagateSelectionDown: true,
-  loading: false,
-  loadingIcon: 'pi pi-spinner',
-  dragdropScope: null,
-  header: null,
-  footer: null,
-  showHeader: true,
-  filter: false,
-  filterValue: null,
-  filterBy: 'label',
-  filterMode: 'lenient',
-  filterPlaceholder: null,
-  filterLocale: undefined,
-  filterTemplate: null,
-  nodeTemplate: null,
-  togglerTemplate: null,
-  onSelect: null,
-  onUnselect: null,
-  onExpand: null,
-  onCollapse: null,
-  onToggle: null,
-  onDragDrop: null,
-  onContextMenu: null,
-  onFilterValueChange: null,
-  onNodeClick: null,
-  onNodeDoubleClick: null
-};
 
 exports.Tree = Tree;