primereact 8.7.2 → 9.0.0-beta.1

package/timeline/timeline.d.ts

@@ -1,22 +1,71 @@
+/**
+ *
+ * Timeline visualizes a series of chained events.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/timeline/)
+ *
+ * @module timeline
+ *
+ */
 import * as React from 'react';
 
-type TimelineAlignType = 'left' | 'right' | 'top' | 'bottom' | 'alternate';
-
-type TimelineLayoutType = 'vertical' | 'horizontal';
-
-type TimelineTemplateType = React.ReactNode | ((item: any, index: number) => React.ReactNode);
-
+/**
+ * Defines valid properties in Timeline component. In addition to these, all properties of HTMLDivElement can be used in this component.
+ * @group Properties
+ */
 export interface TimelineProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'ref'> {
-    value?: any[];
-    align?: TimelineAlignType;
-    layout?: TimelineLayoutType;
-    dataKey?: string;
-    opposite?: TimelineTemplateType;
-    marker?: TimelineTemplateType;
-    content?: TimelineTemplateType;
+    /**
+     * Position of the timeline bar relative to the content. Valid values are "left", "right for vertical layout and "top", "bottom" for horizontal layout.
+     * @defaultValue left
+     */
+    align?: 'left' | 'right' | 'top' | 'bottom' | 'alternate' | undefined;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
     children?: React.ReactNode;
+    /**
+     * Template of the content.
+     */
+    content?: React.ReactNode | ((item: any, index: number) => React.ReactNode);
+    /**
+     * Name of the field that uniquely identifies a record in the data. Should be a unique business key to prevent re-rendering.
+     */
+    dataKey?: string | undefined;
+    /**
+     * Orientation of the timeline, valid values are "vertical" and "horizontal".
+     * @defaultValue vertical
+     */
+    layout?: 'vertical' | 'horizontal' | undefined;
+    /**
+     * Template content allows placing a custom event marker instead of the default one.
+     */
+    marker?: React.ReactNode | ((item: any, index: number) => React.ReactNode);
+    /**
+     * Template content to be placed at the other side of the bar.
+     */
+    opposite?: React.ReactNode | ((item: any, index: number) => React.ReactNode);
+    /**
+     * An array of events to display.
+     */
+    value?: any[] | undefined;
 }
 
+/**
+ * **PrimeReact - Timeline**
+ *
+ * _Timeline visualizes a series of chained events._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/timeline/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class Timeline extends React.Component<TimelineProps, any> {
+    /**
+     * Used to get container element.
+     * @return {HTMLDivElement} Container element
+     */
     public getElement(): HTMLDivElement;
 }

package/timeline/timeline.esm.js

@@ -5,20 +5,45 @@ 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(obj) {
+  "@babel/helpers - typeof";
+
+  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
+    return typeof obj;
+  } : function (obj) {
+    return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
+  }, _typeof(obj);
+}
+
+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,
@@ -29,19 +54,15 @@ function _defineProperty(obj, key, value) {
   } else {
     obj[key] = value;
   }
-
   return obj;
 }
 
 var Timeline = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef(function (props, ref) {
   var _classNames;
-
   var elementRef = React.useRef(null);
-
   var getKey = function getKey(item, index) {
     return props.dataKey ? ObjectUtils.resolveFieldData(item, props.dataKey) : "pr_id__".concat(index);
   };
-
   var createEvents = function createEvents() {
     return props.value && props.value.map(function (item, index) {
       var opposite = ObjectUtils.getJSXElement(props.opposite, item, index);
@@ -64,7 +85,6 @@ var Timeline = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef(function (
       }, content));
     });
   };
-
   React.useImperativeHandle(ref, function () {
     return {
       props: props,
@@ -77,25 +97,21 @@ var Timeline = /*#__PURE__*/React.memo( /*#__PURE__*/React.forwardRef(function (
   var className = classNames('p-timeline p-component', (_classNames = {}, _defineProperty(_classNames, "p-timeline-".concat(props.align), true), _defineProperty(_classNames, "p-timeline-".concat(props.layout), true), _classNames), props.className);
   var events = createEvents();
   return /*#__PURE__*/React.createElement("div", _extends({
-    id: props.id,
     ref: elementRef,
-    className: className,
-    style: props.style
+    className: className
   }, otherProps), events);
 }));
 Timeline.displayName = 'Timeline';
 Timeline.defaultProps = {
   __TYPE: 'Timeline',
-  id: null,
-  value: null,
   align: 'left',
-  layout: 'vertical',
-  dataKey: null,
   className: null,
-  style: null,
-  opposite: null,
+  content: null,
+  dataKey: null,
+  layout: 'vertical',
   marker: null,
-  content: null
+  opposite: null,
+  value: null
 };
 
 export { Timeline };

package/timeline/timeline.esm.min.js

@@ -1 +1 @@
-import*as e from"react";import{ObjectUtils as t,classNames as n}from"primereact/utils";function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var l in n)Object.prototype.hasOwnProperty.call(n,l)&&(e[l]=n[l])}return e},l.apply(this,arguments)}function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var r=e.memo(e.forwardRef((function(i,c){var m,o=e.useRef(null),s=function(e,n){return i.dataKey?t.resolveFieldData(e,i.dataKey):"pr_id__".concat(n)};e.useImperativeHandle(c,(function(){return{props:i,getElement:function(){return o.current}}}));var u=t.findDiffKeys(i,r.defaultProps),p=n("p-timeline p-component",(a(m={},"p-timeline-".concat(i.align),!0),a(m,"p-timeline-".concat(i.layout),!0),m),i.className),v=i.value&&i.value.map((function(n,l){var a=t.getJSXElement(i.opposite,n,l),r=t.getJSXElement(i.marker,n,l)||e.createElement("div",{className:"p-timeline-event-marker"}),c=l!==i.value.length-1&&e.createElement("div",{className:"p-timeline-event-connector"}),m=t.getJSXElement(i.content,n,l);return e.createElement("div",{key:s(n,l),className:"p-timeline-event"},e.createElement("div",{className:"p-timeline-event-opposite"},a),e.createElement("div",{className:"p-timeline-event-separator"},r,c),e.createElement("div",{className:"p-timeline-event-content"},m))}));return e.createElement("div",l({id:i.id,ref:o,className:p,style:i.style},u),v)})));r.displayName="Timeline",r.defaultProps={__TYPE:"Timeline",id:null,value:null,align:"left",layout:"vertical",dataKey:null,className:null,style:null,opposite:null,marker:null,content:null};export{r as Timeline};
+import*as e from"react";import{ObjectUtils as t,classNames as n}from"primereact/utils";function r(){return r=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},r.apply(this,arguments)}function i(e){return i="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},i(e)}function l(e,t){if("object"!==i(e)||null===e)return e;var n=e[Symbol.toPrimitive];if(void 0!==n){var r=n.call(e,t||"default");if("object"!==i(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}function a(e){var t=l(e,"string");return"symbol"===i(t)?t:String(t)}function o(e,t,n){return(t=a(t))in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var m=e.memo(e.forwardRef((function(i,l){var a,u=e.useRef(null),c=function(e,n){return i.dataKey?t.resolveFieldData(e,i.dataKey):"pr_id__".concat(n)};e.useImperativeHandle(l,(function(){return{props:i,getElement:function(){return u.current}}}));var p=t.findDiffKeys(i,m.defaultProps),s=n("p-timeline p-component",(o(a={},"p-timeline-".concat(i.align),!0),o(a,"p-timeline-".concat(i.layout),!0),a),i.className),f=i.value&&i.value.map((function(n,r){var l=t.getJSXElement(i.opposite,n,r),a=t.getJSXElement(i.marker,n,r)||e.createElement("div",{className:"p-timeline-event-marker"}),o=r!==i.value.length-1&&e.createElement("div",{className:"p-timeline-event-connector"}),m=t.getJSXElement(i.content,n,r);return e.createElement("div",{key:c(n,r),className:"p-timeline-event"},e.createElement("div",{className:"p-timeline-event-opposite"},l),e.createElement("div",{className:"p-timeline-event-separator"},a,o),e.createElement("div",{className:"p-timeline-event-content"},m))}));return e.createElement("div",r({ref:u,className:s},p),f)})));m.displayName="Timeline",m.defaultProps={__TYPE:"Timeline",align:"left",className:null,content:null,dataKey:null,layout:"vertical",marker:null,opposite:null,value:null};export{m as Timeline};

package/timeline/timeline.js

@@ -26,20 +26,45 @@ this.primereact.timeline = (function (exports, React, utils) {
     _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(obj) {
+    "@babel/helpers - typeof";
+
+    return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
+      return typeof obj;
+    } : function (obj) {
+      return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
+    }, _typeof(obj);
+  }
+
+  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,
@@ -50,19 +75,15 @@ this.primereact.timeline = (function (exports, React, utils) {
     } else {
       obj[key] = value;
     }
-
     return obj;
   }
 
   var Timeline = /*#__PURE__*/React__namespace.memo( /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
     var _classNames;
-
     var elementRef = React__namespace.useRef(null);
-
     var getKey = function getKey(item, index) {
       return props.dataKey ? utils.ObjectUtils.resolveFieldData(item, props.dataKey) : "pr_id__".concat(index);
     };
-
     var createEvents = function createEvents() {
       return props.value && props.value.map(function (item, index) {
         var opposite = utils.ObjectUtils.getJSXElement(props.opposite, item, index);
@@ -85,7 +106,6 @@ this.primereact.timeline = (function (exports, React, utils) {
         }, content));
       });
     };
-
     React__namespace.useImperativeHandle(ref, function () {
       return {
         props: props,
@@ -98,25 +118,21 @@ this.primereact.timeline = (function (exports, React, utils) {
     var className = utils.classNames('p-timeline p-component', (_classNames = {}, _defineProperty(_classNames, "p-timeline-".concat(props.align), true), _defineProperty(_classNames, "p-timeline-".concat(props.layout), true), _classNames), props.className);
     var events = createEvents();
     return /*#__PURE__*/React__namespace.createElement("div", _extends({
-      id: props.id,
       ref: elementRef,
-      className: className,
-      style: props.style
+      className: className
     }, otherProps), events);
   }));
   Timeline.displayName = 'Timeline';
   Timeline.defaultProps = {
     __TYPE: 'Timeline',
-    id: null,
-    value: null,
     align: 'left',
-    layout: 'vertical',
-    dataKey: null,
     className: null,
-    style: null,
-    opposite: null,
+    content: null,
+    dataKey: null,
+    layout: 'vertical',
     marker: null,
-    content: null
+    opposite: null,
+    value: null
   };
 
   exports.Timeline = Timeline;

package/timeline/timeline.min.js

@@ -1 +1 @@
-this.primereact=this.primereact||{},this.primereact.timeline=function(e,t,n){"use strict";function l(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(n){if("default"!==n){var l=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(t,n,l.get?l:{enumerable:!0,get:function(){return e[n]}})}})),t.default=e,Object.freeze(t)}var r=l(t);function a(){return a=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var l in n)Object.prototype.hasOwnProperty.call(n,l)&&(e[l]=n[l])}return e},a.apply(this,arguments)}function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var c=r.memo(r.forwardRef((function(e,t){var l,s=r.useRef(null),u=function(t,l){return e.dataKey?n.ObjectUtils.resolveFieldData(t,e.dataKey):"pr_id__".concat(l)};r.useImperativeHandle(t,(function(){return{props:e,getElement:function(){return s.current}}}));var o=n.ObjectUtils.findDiffKeys(e,c.defaultProps),m=n.classNames("p-timeline p-component",(i(l={},"p-timeline-".concat(e.align),!0),i(l,"p-timeline-".concat(e.layout),!0),l),e.className),p=e.value&&e.value.map((function(t,l){var a=n.ObjectUtils.getJSXElement(e.opposite,t,l),i=n.ObjectUtils.getJSXElement(e.marker,t,l)||r.createElement("div",{className:"p-timeline-event-marker"}),c=l!==e.value.length-1&&r.createElement("div",{className:"p-timeline-event-connector"}),s=n.ObjectUtils.getJSXElement(e.content,t,l);return r.createElement("div",{key:u(t,l),className:"p-timeline-event"},r.createElement("div",{className:"p-timeline-event-opposite"},a),r.createElement("div",{className:"p-timeline-event-separator"},i,c),r.createElement("div",{className:"p-timeline-event-content"},s))}));return r.createElement("div",a({id:e.id,ref:s,className:m,style:e.style},o),p)})));return c.displayName="Timeline",c.defaultProps={__TYPE:"Timeline",id:null,value:null,align:"left",layout:"vertical",dataKey:null,className:null,style:null,opposite:null,marker:null,content:null},e.Timeline=c,Object.defineProperty(e,"__esModule",{value:!0}),e}({},React,primereact.utils);
+this.primereact=this.primereact||{},this.primereact.timeline=function(e,t,n){"use strict";function r(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(n){if("default"!==n){var r=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(t,n,r.get?r:{enumerable:!0,get:function(){return e[n]}})}})),t.default=e,Object.freeze(t)}var i=r(t);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},l.apply(this,arguments)}function a(e){return a="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},a(e)}function o(e,t){if("object"!==a(e)||null===e)return e;var n=e[Symbol.toPrimitive];if(void 0!==n){var r=n.call(e,t||"default");if("object"!==a(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}function c(e){var t=o(e,"string");return"symbol"===a(t)?t:String(t)}function u(e,t,n){return(t=c(t))in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var m=i.memo(i.forwardRef((function(e,t){var r,a=i.useRef(null),o=function(t,r){return e.dataKey?n.ObjectUtils.resolveFieldData(t,e.dataKey):"pr_id__".concat(r)};i.useImperativeHandle(t,(function(){return{props:e,getElement:function(){return a.current}}}));var c=n.ObjectUtils.findDiffKeys(e,m.defaultProps),s=n.classNames("p-timeline p-component",(u(r={},"p-timeline-".concat(e.align),!0),u(r,"p-timeline-".concat(e.layout),!0),r),e.className),f=e.value&&e.value.map((function(t,r){var l=n.ObjectUtils.getJSXElement(e.opposite,t,r),a=n.ObjectUtils.getJSXElement(e.marker,t,r)||i.createElement("div",{className:"p-timeline-event-marker"}),c=r!==e.value.length-1&&i.createElement("div",{className:"p-timeline-event-connector"}),u=n.ObjectUtils.getJSXElement(e.content,t,r);return i.createElement("div",{key:o(t,r),className:"p-timeline-event"},i.createElement("div",{className:"p-timeline-event-opposite"},l),i.createElement("div",{className:"p-timeline-event-separator"},a,c),i.createElement("div",{className:"p-timeline-event-content"},u))}));return i.createElement("div",l({ref:a,className:s},c),f)})));return m.displayName="Timeline",m.defaultProps={__TYPE:"Timeline",align:"left",className:null,content:null,dataKey:null,layout:"vertical",marker:null,opposite:null,value:null},e.Timeline=m,Object.defineProperty(e,"__esModule",{value:!0}),e}({},React,primereact.utils);