primereact 8.7.2 → 9.0.0-beta.1

package/sidebar/sidebar.cjs.js

@@ -37,14 +37,12 @@ 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);
@@ -55,42 +53,40 @@ function _arrayWithHoles(arr) {
 }
 
 function _iterableToArrayLimit(arr, i) {
-  var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
-
-  if (_i == null) return;
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-
-  var _s, _e;
-
-  try {
-    for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
-    }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
+  var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"];
+  if (null != _i) {
+    var _s,
+      _e,
+      _x,
+      _r,
+      _arr = [],
+      _n = !0,
+      _d = !1;
     try {
-      if (!_n && _i["return"] != null) _i["return"]();
+      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) {
+        ;
+      }
+    } catch (err) {
+      _d = !0, _e = err;
     } finally {
-      if (_d) throw _e;
+      try {
+        if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return;
+      } finally {
+        if (_d) throw _e;
+      }
     }
+    return _arr;
   }
-
-  return _arr;
 }
 
 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;
 }
 
@@ -113,54 +109,47 @@ function _slicedToArray(arr, i) {
 
 var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
   var _React$useState = React__namespace.useState(false),
-      _React$useState2 = _slicedToArray(_React$useState, 2),
-      maskVisibleState = _React$useState2[0],
-      setMaskVisibleState = _React$useState2[1];
-
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    maskVisibleState = _React$useState2[0],
+    setMaskVisibleState = _React$useState2[1];
   var _React$useState3 = React__namespace.useState(false),
-      _React$useState4 = _slicedToArray(_React$useState3, 2),
-      visibleState = _React$useState4[0],
-      setVisibleState = _React$useState4[1];
-
+    _React$useState4 = _slicedToArray(_React$useState3, 2),
+    visibleState = _React$useState4[0],
+    setVisibleState = _React$useState4[1];
   var sidebarRef = React__namespace.useRef(null);
   var maskRef = React__namespace.useRef(null);
   var closeIconRef = React__namespace.useRef(null);
-
   var _useEventListener = hooks.useEventListener({
-    type: 'keydown',
-    listener: function listener(event) {
-      if (event.which === 27) {
-        if (utils.ZIndexUtils.get(maskRef.current) === utils.ZIndexUtils.getCurrent('modal', PrimeReact__default["default"].autoZIndex)) {
-          onClose(event);
+      type: 'keydown',
+      listener: function listener(event) {
+        if (event.which === 27) {
+          if (utils.ZIndexUtils.get(maskRef.current) === utils.ZIndexUtils.getCurrent('modal', PrimeReact__default["default"].autoZIndex)) {
+            onClose(event);
+          }
         }
       }
-    }
-  }),
-      _useEventListener2 = _slicedToArray(_useEventListener, 2),
-      bindDocumentEscapeListener = _useEventListener2[0],
-      unbindDocumentEscapeListener = _useEventListener2[1];
-
+    }),
+    _useEventListener2 = _slicedToArray(_useEventListener, 2),
+    bindDocumentEscapeListener = _useEventListener2[0],
+    unbindDocumentEscapeListener = _useEventListener2[1];
   var _useEventListener3 = hooks.useEventListener({
-    type: 'click',
-    listener: function listener(event) {
-      if (event.which === 2) {
-        // left click
-        return;
-      }
-
-      if (isOutsideClicked(event)) {
-        onClose(event);
+      type: 'click',
+      listener: function listener(event) {
+        if (event.which === 2) {
+          // left click
+          return;
+        }
+        if (isOutsideClicked(event)) {
+          onClose(event);
+        }
       }
-    }
-  }),
-      _useEventListener4 = _slicedToArray(_useEventListener3, 2),
-      bindDocumentClickListener = _useEventListener4[0],
-      unbindDocumentClickListener = _useEventListener4[1];
-
+    }),
+    _useEventListener4 = _slicedToArray(_useEventListener3, 2),
+    bindDocumentClickListener = _useEventListener4[0],
+    unbindDocumentClickListener = _useEventListener4[1];
   var isOutsideClicked = function isOutsideClicked(event) {
     return sidebarRef && sidebarRef.current && !sidebarRef.current.contains(event.target);
   };
-
   var getPositionClass = function getPositionClass() {
     var positions = ['left', 'right', 'top', 'bottom'];
     var pos = positions.find(function (item) {
@@ -168,68 +157,55 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
     });
     return pos ? "p-sidebar-".concat(pos) : '';
   };
-
   var focus = function focus() {
     var activeElement = document.activeElement;
     var isActiveElementInDialog = activeElement && sidebarRef && sidebarRef.current.contains(activeElement);
-
     if (!isActiveElementInDialog && props.showCloseIcon) {
       closeIconRef.current.focus();
     }
   };
-
   var onMaskClick = function onMaskClick(event) {
     if (props.dismissable && props.modal && maskRef.current === event.target) {
       onClose(event);
     }
   };
-
   var onClose = function onClose(event) {
     props.onHide();
     event.preventDefault();
   };
-
   var onEntered = function onEntered() {
     props.onShow && props.onShow();
     focus();
     enableDocumentSettings();
   };
-
   var onExiting = function onExiting() {
     if (props.modal) {
       utils.DomHandler.addClass(maskRef.current, 'p-component-overlay-leave');
     }
   };
-
   var onExited = function onExited() {
     utils.ZIndexUtils.clear(maskRef.current);
     setMaskVisibleState(false);
     disableDocumentSettings();
   };
-
   var enableDocumentSettings = function enableDocumentSettings() {
     if (props.closeOnEscape) {
       bindDocumentEscapeListener();
     }
-
     if (props.dismissable && !props.modal) {
       bindDocumentClickListener();
     }
-
     if (props.blockScroll) {
       utils.DomHandler.addClass(document.body, 'p-overflow-hidden');
     }
   };
-
   var disableDocumentSettings = function disableDocumentSettings() {
     unbindDocumentEscapeListener();
     unbindDocumentClickListener();
-
     if (props.blockScroll) {
       utils.DomHandler.removeClass(document.body, 'p-overflow-hidden');
     }
   };
-
   React__namespace.useImperativeHandle(ref, function () {
     return {
       props: props,
@@ -253,7 +229,6 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
     if (props.visible && !maskVisibleState) {
       setMaskVisibleState(true);
     }
-
     if (props.visible !== visibleState && maskVisibleState) {
       setVisibleState(props.visible);
     }
@@ -264,11 +239,19 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
       setVisibleState(true);
     }
   }, [maskVisibleState]);
+  hooks.useUpdateEffect(function () {
+    // #3811 if dismissible state is toggled while open we must unregister and re-regisetr
+    if (visibleState) {
+      unbindDocumentClickListener();
+      if (props.dismissable && !props.modal) {
+        bindDocumentClickListener();
+      }
+    }
+  }, [props.dismissable, props.modal, visibleState]);
   hooks.useUnmountEffect(function () {
     disableDocumentSettings();
     maskRef.current && utils.ZIndexUtils.clear(maskRef.current);
   });
-
   var createCloseIcon = function createCloseIcon() {
     if (props.showCloseIcon) {
       var ariaLabel = props.ariaCloseLabel || PrimeReact.localeOption('close');
@@ -283,17 +266,17 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
         "aria-hidden": "true"
       }), /*#__PURE__*/React__namespace.createElement(ripple.Ripple, null));
     }
-
     return null;
   };
-
   var createIcons = function createIcons() {
     return props.icons ? utils.ObjectUtils.getJSXElement(props.icons, props) : null;
   };
-
   var createElement = function createElement() {
     var otherProps = utils.ObjectUtils.findDiffKeys(props, Sidebar.defaultProps);
-    var className = utils.classNames('p-sidebar p-component', props.className);
+    var className = utils.classNames('p-sidebar p-component', props.className, {
+      'p-input-filled': PrimeReact__default["default"].inputStyle === 'filled',
+      'p-ripple-disabled': PrimeReact__default["default"].ripple === false
+    });
     var maskClassName = utils.classNames('p-sidebar-mask', {
       'p-component-overlay p-component-overlay-enter': props.modal,
       'p-sidebar-mask-scrollblocker': props.blockScroll,
@@ -334,7 +317,6 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
       className: "p-sidebar-content"
     }, props.children))));
   };
-
   var createSidebar = function createSidebar() {
     var element = createElement();
     return /*#__PURE__*/React__namespace.createElement(portal.Portal, {
@@ -343,7 +325,6 @@ var Sidebar = /*#__PURE__*/React__namespace.forwardRef(function (props, ref) {
       visible: true
     });
   };
-
   return maskVisibleState && createSidebar();
 });
 Sidebar.displayName = 'Sidebar';

package/sidebar/sidebar.cjs.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/api"),n=require("primereact/csstransition"),r=require("primereact/hooks"),l=require("primereact/portal"),o=require("primereact/ripple"),a=require("primereact/utils");function i(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}function s(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 c=s(e),u=i(t);function d(){return d=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},d.apply(this,arguments)}function f(e){if(Array.isArray(e))return e}function p(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,l,o=[],a=!0,i=!1;try{for(n=n.call(e);!(a=(r=n.next()).done)&&(o.push(r.value),!t||o.length!==t);a=!0);}catch(e){i=!0,l=e}finally{try{a||null==n.return||n.return()}finally{if(i)throw l}}return o}}function m(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r}function b(e,t){if(e){if("string"==typeof e)return m(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?m(e,t):void 0}}function v(){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 y(e,t){return f(e)||p(e,t)||b(e,t)||v()}var h=c.forwardRef((function(e,i){var s=y(c.useState(!1),2),f=s[0],p=s[1],m=y(c.useState(!1),2),b=m[0],v=m[1],E=c.useRef(null),S=c.useRef(null),g=c.useRef(null),O=y(r.useEventListener({type:"keydown",listener:function(e){27===e.which&&a.ZIndexUtils.get(S.current)===a.ZIndexUtils.getCurrent("modal",u.default.autoZIndex)&&U(e)}}),2),w=O[0],k=O[1],I=y(r.useEventListener({type:"click",listener:function(e){2!==e.which&&C(e)&&U(e)}}),2),x=I[0],j=I[1],C=function(e){return E&&E.current&&!E.current.contains(e.target)},N=function(t){e.dismissable&&e.modal&&S.current===t.target&&U(t)},U=function(t){e.onHide(),t.preventDefault()},Z=function(){var t;e.onShow&&e.onShow(),!((t=document.activeElement)&&E&&E.current.contains(t))&&e.showCloseIcon&&g.current.focus(),D()},P=function(){e.modal&&a.DomHandler.addClass(S.current,"p-component-overlay-leave")},q=function(){a.ZIndexUtils.clear(S.current),p(!1),A()},D=function(){e.closeOnEscape&&w(),e.dismissable&&!e.modal&&x(),e.blockScroll&&a.DomHandler.addClass(document.body,"p-overflow-hidden")},A=function(){k(),j(),e.blockScroll&&a.DomHandler.removeClass(document.body,"p-overflow-hidden")};c.useImperativeHandle(i,(function(){return{props:e,getElement:function(){return E.current},gteMask:function(){return S.current},getCloseIcon:function(){return g.current}}})),r.useMountEffect((function(){e.visible&&p(!0)})),r.useUpdateEffect((function(){e.visible&&!f&&p(!0),e.visible!==b&&f&&v(e.visible)})),r.useUpdateEffect((function(){f&&(a.ZIndexUtils.set("modal",S.current,u.default.autoZIndex,e.baseZIndex||u.default.zIndex.modal),v(!0))}),[f]),r.useUnmountEffect((function(){A(),S.current&&a.ZIndexUtils.clear(S.current)}));var H,M,R,T,_,L,z,J=function(){if(e.showCloseIcon){var n=e.ariaCloseLabel||t.localeOption("close");return c.createElement("button",{type:"button",ref:g,className:"p-sidebar-close p-sidebar-icon p-link",onClick:U,"aria-label":n},c.createElement("span",{className:"p-sidebar-close-icon pi pi-times","aria-hidden":"true"}),c.createElement(o.Ripple,null))}return null};return f&&(M=a.ObjectUtils.findDiffKeys(e,h.defaultProps),R=a.classNames("p-sidebar p-component",e.className),T=a.classNames("p-sidebar-mask",{"p-component-overlay p-component-overlay-enter":e.modal,"p-sidebar-mask-scrollblocker":e.blockScroll,"p-sidebar-visible":f,"p-sidebar-full":e.fullScreen},(H=["left","right","top","bottom"].find((function(t){return t===e.position})))?"p-sidebar-".concat(H):"",e.maskClassName),_=J(),L=e.icons?a.ObjectUtils.getJSXElement(e.icons,e):null,z=c.createElement("div",{ref:S,style:e.maskStyle,className:T,onMouseDown:N},c.createElement(n.CSSTransition,{nodeRef:E,classNames:"p-sidebar",in:b,timeout:{enter:e.fullScreen?150:300,exit:e.fullScreen?150:300},options:e.transitionOptions,unmountOnExit:!0,onEntered:Z,onExiting:P,onExited:q},c.createElement("div",d({ref:E,id:e.id,className:R,style:e.style},M,{role:"complementary"}),c.createElement("div",{className:"p-sidebar-header"},L,_),c.createElement("div",{className:"p-sidebar-content"},e.children)))),c.createElement(l.Portal,{element:z,appendTo:e.appendTo,visible:!0}))}));h.displayName="Sidebar",h.defaultProps={__TYPE:"Sidebar",id:null,style:null,className:null,maskStyle:null,maskClassName:null,visible:!1,position:"left",fullScreen:!1,blockScroll:!1,baseZIndex:0,dismissable:!0,showCloseIcon:!0,ariaCloseLabel:null,closeOnEscape:!0,icons:null,modal:!0,appendTo:null,transitionOptions:null,onShow:null,onHide:null},exports.Sidebar=h;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/api"),n=require("primereact/csstransition"),r=require("primereact/hooks"),l=require("primereact/portal"),i=require("primereact/ripple"),o=require("primereact/utils");function a(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}function s(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 c=s(e),u=a(t);function d(){return d=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},d.apply(this,arguments)}function f(e){if(Array.isArray(e))return e}function p(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,l,i,o,a=[],s=!0,c=!1;try{if(i=(n=n.call(e)).next,0===t){if(Object(n)!==n)return;s=!1}else for(;!(s=(r=i.call(n)).done)&&(a.push(r.value),a.length!==t);s=!0);}catch(e){c=!0,l=e}finally{try{if(!s&&null!=n.return&&(o=n.return(),Object(o)!==o))return}finally{if(c)throw l}}return a}}function m(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r}function b(e,t){if(e){if("string"==typeof e)return m(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?m(e,t):void 0}}function v(){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 y(e,t){return f(e)||p(e,t)||b(e,t)||v()}var h=c.forwardRef((function(e,a){var s=y(c.useState(!1),2),f=s[0],p=s[1],m=y(c.useState(!1),2),b=m[0],v=m[1],E=c.useRef(null),S=c.useRef(null),O=c.useRef(null),g=y(r.useEventListener({type:"keydown",listener:function(e){27===e.which&&o.ZIndexUtils.get(S.current)===o.ZIndexUtils.getCurrent("modal",u.default.autoZIndex)&&U(e)}}),2),w=g[0],k=g[1],I=y(r.useEventListener({type:"click",listener:function(e){2!==e.which&&C(e)&&U(e)}}),2),j=I[0],x=I[1],C=function(e){return E&&E.current&&!E.current.contains(e.target)},N=function(t){e.dismissable&&e.modal&&S.current===t.target&&U(t)},U=function(t){e.onHide(),t.preventDefault()},Z=function(){var t;e.onShow&&e.onShow(),!((t=document.activeElement)&&E&&E.current.contains(t))&&e.showCloseIcon&&O.current.focus(),D()},P=function(){e.modal&&o.DomHandler.addClass(S.current,"p-component-overlay-leave")},q=function(){o.ZIndexUtils.clear(S.current),p(!1),A()},D=function(){e.closeOnEscape&&w(),e.dismissable&&!e.modal&&j(),e.blockScroll&&o.DomHandler.addClass(document.body,"p-overflow-hidden")},A=function(){k(),x(),e.blockScroll&&o.DomHandler.removeClass(document.body,"p-overflow-hidden")};c.useImperativeHandle(a,(function(){return{props:e,getElement:function(){return E.current},gteMask:function(){return S.current},getCloseIcon:function(){return O.current}}})),r.useMountEffect((function(){e.visible&&p(!0)})),r.useUpdateEffect((function(){e.visible&&!f&&p(!0),e.visible!==b&&f&&v(e.visible)})),r.useUpdateEffect((function(){f&&(o.ZIndexUtils.set("modal",S.current,u.default.autoZIndex,e.baseZIndex||u.default.zIndex.modal),v(!0))}),[f]),r.useUpdateEffect((function(){b&&(x(),e.dismissable&&!e.modal&&j())}),[e.dismissable,e.modal,b]),r.useUnmountEffect((function(){A(),S.current&&o.ZIndexUtils.clear(S.current)}));var H,M,R,T,_,L,z,J=function(){if(e.showCloseIcon){var n=e.ariaCloseLabel||t.localeOption("close");return c.createElement("button",{type:"button",ref:O,className:"p-sidebar-close p-sidebar-icon p-link",onClick:U,"aria-label":n},c.createElement("span",{className:"p-sidebar-close-icon pi pi-times","aria-hidden":"true"}),c.createElement(i.Ripple,null))}return null};return f&&(M=o.ObjectUtils.findDiffKeys(e,h.defaultProps),R=o.classNames("p-sidebar p-component",e.className,{"p-input-filled":"filled"===u.default.inputStyle,"p-ripple-disabled":!1===u.default.ripple}),T=o.classNames("p-sidebar-mask",{"p-component-overlay p-component-overlay-enter":e.modal,"p-sidebar-mask-scrollblocker":e.blockScroll,"p-sidebar-visible":f,"p-sidebar-full":e.fullScreen},(H=["left","right","top","bottom"].find((function(t){return t===e.position})))?"p-sidebar-".concat(H):"",e.maskClassName),_=J(),L=e.icons?o.ObjectUtils.getJSXElement(e.icons,e):null,z=c.createElement("div",{ref:S,style:e.maskStyle,className:T,onMouseDown:N},c.createElement(n.CSSTransition,{nodeRef:E,classNames:"p-sidebar",in:b,timeout:{enter:e.fullScreen?150:300,exit:e.fullScreen?150:300},options:e.transitionOptions,unmountOnExit:!0,onEntered:Z,onExiting:P,onExited:q},c.createElement("div",d({ref:E,id:e.id,className:R,style:e.style},M,{role:"complementary"}),c.createElement("div",{className:"p-sidebar-header"},L,_),c.createElement("div",{className:"p-sidebar-content"},e.children)))),c.createElement(l.Portal,{element:z,appendTo:e.appendTo,visible:!0}))}));h.displayName="Sidebar",h.defaultProps={__TYPE:"Sidebar",id:null,style:null,className:null,maskStyle:null,maskClassName:null,visible:!1,position:"left",fullScreen:!1,blockScroll:!1,baseZIndex:0,dismissable:!0,showCloseIcon:!0,ariaCloseLabel:null,closeOnEscape:!0,icons:null,modal:!0,appendTo:null,transitionOptions:null,onShow:null,onHide:null},exports.Sidebar=h;

package/sidebar/sidebar.d.ts

@@ -1,35 +1,133 @@
+/**
+ *
+ * Sidebar is a panel component displayed as an overlay.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/sidebar/)
+ *
+ * @module sidebar
+ *
+ */
 import * as React from 'react';
 import { CSSTransitionProps } from '../csstransition';
 
-type SidebarPositionType = 'top' | 'bottom' | 'left' | 'right';
-
-type SidebarTemplateType = React.ReactNode | ((props: SidebarProps) => React.ReactNode);
-
-type SidebarAppendToType = 'self' | HTMLElement | undefined | null;
-
+/**
+ * Defines valid properties in Sidebar component. In addition to these, all properties of HTMLDivElement can be used in this component.
+ * @group Properties
+ */
 export interface SidebarProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'ref'> {
-    maskStyle?: React.CSSProperties;
-    maskClassName?: string;
-    visible?: boolean;
-    position?: SidebarPositionType;
-    fullScreen?: boolean;
-    blockScroll?: boolean;
-    baseZIndex?: number;
-    dismissable?: boolean;
-    showCloseIcon?: boolean;
-    ariaCloseLabel?: string;
-    closeOnEscape?: boolean;
-    icons?: SidebarTemplateType;
-    modal?: boolean;
-    appendTo?: SidebarAppendToType;
-    transitionOptions?: CSSTransitionProps;
+    /**
+     * Inline style of the mask.
+     */
+    maskStyle?: React.CSSProperties | undefined;
+    /**
+     * Style class of the mask.
+     */
+    maskClassName?: string | undefined;
+    /**
+     * Specifies the visibility of the dialog.
+     * @defaultValue false
+     */
+    visible?: boolean | undefined;
+    /**
+     * Specifies the position of the sidebar, valid values are "left" and "right".
+     * @defaultValue left
+     */
+    position?: 'top' | 'bottom' | 'left' | 'right' | undefined;
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     * @defaultValue false
+     */
+    fullScreen?: boolean | undefined;
+    /**
+     * Whether to block scrolling of the document when sidebar is active.
+     * @defaultValue false
+     */
+    blockScroll?: boolean | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * @defaultValue 0
+     */
+    baseZIndex?: number | undefined;
+    /**
+     * Whether to dismiss sidebar on click of the mask.
+     * @defaultValue true
+     */
+    dismissable?: boolean | undefined;
+    /**
+     * Whether to display a close icon inside the panel.
+     * @defaultValue true
+     */
+    showCloseIcon?: boolean | undefined;
+    /**
+     * Aria label of the close icon.
+     * @defaultValue close
+     */
+    ariaCloseLabel?: string | undefined;
+    /**
+     * Specifies if pressing escape key should hide the sidebar.
+     * @defaultValue true
+     */
+    closeOnEscape?: boolean | undefined;
+    /**
+     * Custom icons template for the header.
+     * @defaultValue true
+     */
+    icons?: React.ReactNode | ((props: SidebarProps) => React.ReactNode);
+    /**
+     * Whether to a modal layer behind the sidebar.
+     * @defaultValue true
+     */
+    modal?: boolean | undefined;
+    /**
+     * 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;
+    /**
+     * The properties of CSSTransition can be customized, except for "nodeRef" and "in" properties.
+     * @type {CSSTransitionProps}
+     */
+    transitionOptions?: CSSTransitionProps | undefined;
+    /**
+     * Callback to invoke when sidebar gets shown.
+     */
     onShow?(): void;
+    /**
+     * Callback to invoke when the actions used to close the sidebar are triggered. Exp; close icon, mask and esc key.
+     */
     onHide(): void;
-    children?: React.ReactNode;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * **PrimeReact - Sidebar**
+ *
+ * _Sidebar is a panel component displayed as an overlay._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/sidebar/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ */
 export declare class Sidebar extends React.Component<SidebarProps, any> {
+    /**
+     * Used to get container element.
+     * @return {HTMLDivElement} Container element
+     */
     public getElement(): HTMLDivElement;
+    /**
+     * Used to get mask element.
+     * @return {HTMLElement} Mask element
+     */
     public getMask(): HTMLElement;
+    /**
+     * Used to get close icon element.
+     * @return {HTMLButtonElement} Close icon element
+     */
     public getCloseIcon(): HTMLButtonElement;
 }