primereact 8.7.2 → 9.0.0-beta.1

package/tabview/tabview.cjs.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/api"),n=require("primereact/hooks"),r=require("primereact/ripple"),a=require("primereact/utils");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 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=l(e);function o(){return o=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},o.apply(this,arguments)}function c(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(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 u(e){if(Array.isArray(e))return s(e)}function f(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}function p(e,t){if(e){if("string"==typeof e)return s(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)?s(e,t):void 0}}function b(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function d(e){if(Array.isArray(e))return e}function m(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,a,l=[],i=!0,o=!1;try{for(n=n.call(e);!(i=(r=n.next()).done)&&(l.push(r.value),!t||l.length!==t);i=!0);}catch(e){o=!0,a=e}finally{try{i||null==n.return||n.return()}finally{if(o)throw a}}return l}}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 d(e)||m(e,t)||p(e,t)||v()}function h(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function g(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?h(Object(n),!0).forEach((function(t){c(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):h(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}var E=function(){},w=i.forwardRef((function(e,l){var c=y(i.useState(e.id),2),s=c[0],d=c[1],m=y(i.useState(!0),2),v=m[0],h=m[1],O=y(i.useState(!1),2),C=O[0],N=O[1],j=y(i.useState([]),2),T=j[0],x=j[1],P=y(i.useState(e.activeIndex),2),S=P[0],I=P[1],_=i.useRef(null),D=i.useRef(null),k=i.useRef(null),A=i.useRef(null),R=i.useRef(null),L=i.useRef(null),H=i.useRef({}),U=e.onTabChange?e.activeIndex:S,W=function(e){return e===U},q=function(e,t){return e&&"TabPanel"===e.props.__TYPE&&T.every((function(e){return e!==t}))},B=function(t,n){var r;(t.preventDefault(),e.onBeforeTabClose&&!1===e.onBeforeTabClose({originalEvent:t,index:n}))||(x([].concat(u(r=T)||f(r)||p(r)||b(),[n])),e.onTabClose&&e.onTabClose({originalEvent:t,index:n}))},V=function(t,n,r){if(t&&t.preventDefault(),!n.props.disabled){if(e.onBeforeTabChange&&!1===e.onBeforeTabChange({originalEvent:t,index:r}))return;e.onTabChange?e.onTabChange({originalEvent:t,index:r}):I(r)}M(r)},K=function(e,t,n){"Enter"===e.code&&V(e,t,n)},M=function(e){var t=H.current["tab_".concat(e)];t&&t.scrollIntoView&&t.scrollIntoView({block:"nearest"})},Y=function(t){var n,r,l,i;e.scrollable&&(r=(n=D.current).scrollLeft,l=n.scrollWidth,i=a.DomHandler.getWidth(D.current),h(0===r),N(r===l-i)),t.preventDefault()},z=function(){return[R.current,L.current].reduce((function(e,t){return t?e+a.DomHandler.getWidth(t):e}),0)},J=function(){var e=a.DomHandler.getWidth(D.current)-z(),t=D.current.scrollLeft-e;D.current.scrollLeft=t<=0?0:t},X=function(){var e=a.DomHandler.getWidth(D.current)-z(),t=D.current.scrollLeft+e,n=D.current.scrollWidth-e;D.current.scrollLeft=t>=n?n:t},$=function(){h(!0),N(!1),x([]),e.onTabChange?e.onTabChange({index:U}):I(e.activeIndex)};i.useEffect((function(){var e;e=H.current["tab_".concat(U)],A.current.style.width=a.DomHandler.getWidth(e)+"px",A.current.style.left=a.DomHandler.getOffset(e).left-a.DomHandler.getOffset(k.current).left+"px"})),n.useMountEffect((function(){s||d(a.UniqueComponentId())})),n.useUpdateEffect((function(){if(a.ObjectUtils.isNotEmpty(T)){var t=(n=T[T.length-1],(r=i.Children.map(e.children,(function(e,t){if(q(e,t))return{tab:e,index:t}}))).find((function(e){return!e.tab.props.disabled&&e.index>=n}))||r.reverse().find((function(e){return!e.tab.props.disabled&&n>e.index})));t&&V(null,t.tab,t.index)}var n,r}),[T]),n.useUpdateEffect((function(){M(e.activeIndex)}),[e.activeIndex]),i.useImperativeHandle(l,(function(){return{props:e,reset:$,getElement:function(){return _.current}}}));var F,G=function(t,n){var l=W(n),o=t.props,c=o.headerClassName,u=o.style,f=o.className,p=o.disabled,b=o.leftIcon,d=o.rightIcon,m=o.header,v=o.headerTemplate,y=o.closable,h=g(g({},o.headerStyle||{}),u||{}),E=a.classNames("p-unselectable-text",{"p-tabview-selected p-highlight":l,"p-disabled":p},c,f),w=s+"_header_"+n,O=s+"_content_"+n,C=p?null:0,N=b&&i.createElement("i",{className:b}),j=i.createElement("span",{className:"p-tabview-title"},m),T=d&&i.createElement("i",{className:d}),x=i.createElement("a",{role:"tab",className:"p-tabview-nav-link",onClick:function(e){return V(e,t,n)},id:w,onKeyDown:function(e){return K(e,t,n)},"aria-controls":O,"aria-selected":l,tabIndex:C},N,j,T,y&&i.createElement("i",{className:"p-tabview-close pi pi-times",onClick:function(e){return B(e,n)}}),i.createElement(r.Ripple,null));v&&(x=a.ObjectUtils.getJSXElement(v,{className:"p-tabview-nav-link",titleClassName:"p-tabview-title",onClick:function(e){return V(e,t,n)},onKeyDown:function(e){return K(e,t,n)},leftIconElement:N,titleElement:j,rightIconElement:T,element:x,props:e,index:n,selected:l,ariaControls:O}));return i.createElement("li",{ref:function(e){return H.current["tab_".concat(n)]=e},className:E,style:h,role:"presentation"},x)},Q=a.ObjectUtils.findDiffKeys(e,w.defaultProps),Z=a.classNames("p-tabview p-component",{"p-tabview-scrollable":e.scrollable},e.className),ee=(F=i.Children.map(e.children,(function(e,t){if(q(e,t))return G(e,t)})),i.createElement("div",{ref:D,id:s,className:"p-tabview-nav-content",style:e.style,onScroll:Y},i.createElement("ul",{ref:k,className:"p-tabview-nav",role:"tablist"},F,i.createElement("li",{ref:A,className:"p-tabview-ink-bar"})))),te=function(){var t=a.classNames("p-tabview-panels",e.panelContainerClassName),n=i.Children.map(e.children,(function(t,n){if(q(t,n)&&(!e.renderActiveOnly||W(n))){var r=W(n),l=g(g({},t.props.contentStyle||{}),t.props.style||{}),c=a.classNames(t.props.contentClassName,t.props.className,"p-tabview-panel",{"p-hidden":!r}),u=s+"_content_"+n,f=s+"_header_"+n,p=a.ObjectUtils.findDiffKeys(t.props,E.defaultProps);return i.createElement("div",o({},p,{id:u,"aria-labelledby":f,"aria-hidden":!r,className:c,style:l,role:"tabpanel"}),e.renderActiveOnly?r&&t.props.children:t.props.children)}}));return i.createElement("div",{className:t,style:e.panelContainerStyle},n)}(),ne=e.scrollable&&!v?i.createElement("button",{ref:R,className:"p-tabview-nav-prev p-tabview-nav-btn p-link",onClick:J,type:"button","aria-label":t.ariaLabel("previousPageLabel")},i.createElement("span",{className:"pi pi-chevron-left"}),i.createElement(r.Ripple,null)):null,re=function(){if(e.scrollable&&!C)return i.createElement("button",{ref:L,className:"p-tabview-nav-next p-tabview-nav-btn p-link",onClick:X,type:"button","aria-label":t.ariaLabel("nextPageLabel")},i.createElement("span",{className:"pi pi-chevron-right","aria-hidden":"true"}),i.createElement(r.Ripple,null))}();return i.createElement("div",o({ref:_,className:Z},Q),i.createElement("div",{className:"p-tabview-nav-container"},ne,ee,re),te)}));E.displayName="TabPanel",E.defaultProps={__TYPE:"TabPanel",className:null,closable:!1,contentClassName:null,contentStyle:null,disabled:!1,header:null,headerClassName:null,headerStyle:null,headerTemplate:null,leftIcon:null,rightIcon:null,style:null},w.displayName="TabView",w.defaultProps={__TYPE:"TabView",id:null,activeIndex:0,className:null,onBeforeTabChange:null,onBeforeTabClose:null,onTabChange:null,onTabClose:null,panelContainerClassName:null,panelContainerStyle:null,renderActiveOnly:!0,scrollable:!1,style:null},exports.TabPanel=E,exports.TabView=w;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react"),t=require("primereact/api"),n=require("primereact/hooks"),r=require("primereact/ripple"),a=require("primereact/utils");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 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=l(e);function o(){return o=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},o.apply(this,arguments)}function c(e){return c="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},c(e)}function u(e,t){if("object"!==c(e)||null===e)return e;var n=e[Symbol.toPrimitive];if(void 0!==n){var r=n.call(e,t||"default");if("object"!==c(r))return r;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}function s(e){var t=u(e,"string");return"symbol"===c(t)?t:String(t)}function f(e,t,n){return(t=s(t))in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(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){if(Array.isArray(e))return p(e)}function d(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}function m(e,t){if(e){if("string"==typeof e)return p(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)?p(e,t):void 0}}function v(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function y(e){if(Array.isArray(e))return e}function h(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,a,l,i,o=[],c=!0,u=!1;try{if(l=(n=n.call(e)).next,0===t){if(Object(n)!==n)return;c=!1}else for(;!(c=(r=l.call(n)).done)&&(o.push(r.value),o.length!==t);c=!0);}catch(e){u=!0,a=e}finally{try{if(!c&&null!=n.return&&(i=n.return(),Object(i)!==i))return}finally{if(u)throw a}}return o}}function g(){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 w(e,t){return y(e)||h(e,t)||m(e,t)||g()}function E(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function O(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?E(Object(n),!0).forEach((function(t){f(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):E(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}var N=function(){},C=i.forwardRef((function(e,l){var c=w(i.useState(e.id),2),u=c[0],s=c[1],f=w(i.useState(!0),2),p=f[0],y=f[1],h=w(i.useState(!1),2),g=h[0],E=h[1],j=w(i.useState([]),2),S=j[0],T=j[1],P=w(i.useState(e.activeIndex),2),x=P[0],I=P[1],_=i.useRef(null),D=i.useRef(null),k=i.useRef(null),A=i.useRef(null),R=i.useRef(null),L=i.useRef(null),H=i.useRef({}),U=e.onTabChange?e.activeIndex:x,W=function(e){return e===U},q=function(e,t){return e&&"TabPanel"===e.props.__TYPE&&S.every((function(e){return e!==t}))},B=function(t,n){var r;(t.preventDefault(),e.onBeforeTabClose&&!1===e.onBeforeTabClose({originalEvent:t,index:n}))||(T([].concat(b(r=S)||d(r)||m(r)||v(),[n])),e.onTabClose&&e.onTabClose({originalEvent:t,index:n}))},V=function(t,n,r){if(t&&t.preventDefault(),!n.props.disabled){if(e.onBeforeTabChange&&!1===e.onBeforeTabChange({originalEvent:t,index:r}))return;e.onTabChange?e.onTabChange({originalEvent:t,index:r}):I(r)}M(r)},K=function(e,t,n){"Enter"===e.key&&V(e,t,n)},M=function(e){var t=H.current["tab_".concat(e)];t&&t.scrollIntoView&&t.scrollIntoView({block:"nearest"})},Y=function(t){var n,r,l,i;e.scrollable&&(r=(n=D.current).scrollLeft,l=n.scrollWidth,i=a.DomHandler.getWidth(D.current),y(0===r),E(r===l-i)),t.preventDefault()},z=function(){return[R.current,L.current].reduce((function(e,t){return t?e+a.DomHandler.getWidth(t):e}),0)},J=function(){var e=a.DomHandler.getWidth(D.current)-z(),t=D.current.scrollLeft-e;D.current.scrollLeft=t<=0?0:t},X=function(){var e=a.DomHandler.getWidth(D.current)-z(),t=D.current.scrollLeft+e,n=D.current.scrollWidth-e;D.current.scrollLeft=t>=n?n:t},$=function(){y(!0),E(!1),T([]),e.onTabChange?e.onTabChange({index:U}):I(e.activeIndex)};i.useEffect((function(){var e;e=H.current["tab_".concat(U)],A.current.style.width=a.DomHandler.getWidth(e)+"px",A.current.style.left=a.DomHandler.getOffset(e).left-a.DomHandler.getOffset(k.current).left+"px"})),n.useMountEffect((function(){u||s(a.UniqueComponentId())})),n.useUpdateEffect((function(){if(a.ObjectUtils.isNotEmpty(S)){var t=(n=S[S.length-1],(r=i.Children.map(e.children,(function(e,t){if(q(e,t))return{tab:e,index:t}}))).find((function(e){return!e.tab.props.disabled&&e.index>=n}))||r.reverse().find((function(e){return!e.tab.props.disabled&&n>e.index})));t&&V(null,t.tab,t.index)}var n,r}),[S]),n.useUpdateEffect((function(){M(e.activeIndex)}),[e.activeIndex]),i.useImperativeHandle(l,(function(){return{props:e,reset:$,getElement:function(){return _.current}}}));var F,G=function(t,n){var l=W(n),o=t.props,c=o.headerClassName,s=o.style,f=o.className,p=o.disabled,b=o.leftIcon,d=o.rightIcon,m=o.header,v=o.headerTemplate,y=o.closable,h=O(O({},o.headerStyle||{}),s||{}),g=a.classNames("p-unselectable-text",{"p-tabview-selected p-highlight":l,"p-disabled":p},c,f),w=u+"_header_"+n,E=u+"_content_"+n,N=p?null:0,C=b&&i.createElement("i",{className:b}),j=i.createElement("span",{className:"p-tabview-title"},m),S=d&&i.createElement("i",{className:d}),T=i.createElement("a",{role:"tab",className:"p-tabview-nav-link",onClick:function(e){return V(e,t,n)},id:w,onKeyDown:function(e){return K(e,t,n)},"aria-controls":E,"aria-selected":l,tabIndex:N},C,j,S,y&&i.createElement("i",{className:"p-tabview-close pi pi-times",onClick:function(e){return B(e,n)}}),i.createElement(r.Ripple,null));v&&(T=a.ObjectUtils.getJSXElement(v,{className:"p-tabview-nav-link",titleClassName:"p-tabview-title",onClick:function(e){return V(e,t,n)},onKeyDown:function(e){return K(e,t,n)},leftIconElement:C,titleElement:j,rightIconElement:S,element:T,props:e,index:n,selected:l,ariaControls:E}));return i.createElement("li",{ref:function(e){return H.current["tab_".concat(n)]=e},className:g,style:h,role:"presentation"},T)},Q=a.ObjectUtils.findDiffKeys(e,C.defaultProps),Z=a.classNames("p-tabview p-component",{"p-tabview-scrollable":e.scrollable},e.className),ee=(F=i.Children.map(e.children,(function(e,t){if(q(e,t))return G(e,t)})),i.createElement("div",{ref:D,id:u,className:"p-tabview-nav-content",style:e.style,onScroll:Y},i.createElement("ul",{ref:k,className:"p-tabview-nav",role:"tablist"},F,i.createElement("li",{ref:A,className:"p-tabview-ink-bar"})))),te=function(){var t=a.classNames("p-tabview-panels",e.panelContainerClassName),n=i.Children.map(e.children,(function(t,n){if(q(t,n)&&(!e.renderActiveOnly||W(n))){var r=W(n),l=O(O({},t.props.contentStyle||{}),t.props.style||{}),c=a.classNames(t.props.contentClassName,t.props.className,"p-tabview-panel",{"p-hidden":!r}),s=u+"_content_"+n,f=u+"_header_"+n,p=a.ObjectUtils.findDiffKeys(t.props,N.defaultProps);return i.createElement("div",o({},p,{id:s,"aria-labelledby":f,"aria-hidden":!r,className:c,style:l,role:"tabpanel"}),e.renderActiveOnly?r&&t.props.children:t.props.children)}}));return i.createElement("div",{className:t,style:e.panelContainerStyle},n)}(),ne=e.scrollable&&!p?i.createElement("button",{ref:R,className:"p-tabview-nav-prev p-tabview-nav-btn p-link",onClick:J,type:"button","aria-label":t.ariaLabel("previousPageLabel")},i.createElement("span",{className:"pi pi-chevron-left"}),i.createElement(r.Ripple,null)):null,re=function(){if(e.scrollable&&!g)return i.createElement("button",{ref:L,className:"p-tabview-nav-next p-tabview-nav-btn p-link",onClick:X,type:"button","aria-label":t.ariaLabel("nextPageLabel")},i.createElement("span",{className:"pi pi-chevron-right","aria-hidden":"true"}),i.createElement(r.Ripple,null))}();return i.createElement("div",o({ref:_,className:Z},Q),i.createElement("div",{className:"p-tabview-nav-container"},ne,ee,re),te)}));N.displayName="TabPanel",N.defaultProps={__TYPE:"TabPanel",className:null,closable:!1,contentClassName:null,contentStyle:null,disabled:!1,header:null,headerClassName:null,headerStyle:null,headerTemplate:null,leftIcon:null,rightIcon:null,style:null},C.displayName="TabView",C.defaultProps={__TYPE:"TabView",id:null,activeIndex:0,className:null,onBeforeTabChange:null,onBeforeTabClose:null,onTabChange:null,onTabClose:null,panelContainerClassName:null,panelContainerStyle:null,renderActiveOnly:!0,scrollable:!1,style:null},exports.TabPanel=N,exports.TabView=C;

package/tabview/tabview.d.ts

@@ -1,65 +1,251 @@
+/**
+ *
+ * TabView is a container component to group content with tabs.
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/tabview/)
+ *
+ * Helper Components:
+ *
+ * - {@link TabPanel}
+ *
+ * @module tabview
+ *
+ */
 import * as React from 'react';
 
-type TabPanelHeaderTemplateType = React.ReactNode | ((options: TabPanelHeaderTemplateOptions) => React.ReactNode);
-
+/**
+ * Custom Tabpanel header template options
+ * @group Misc
+ */
 interface TabPanelHeaderTemplateOptions {
+    /**
+     * Style class of the header element.
+     */
     className: string;
+    /**
+     * Style class of the header title element.
+     */
     titleClassName: string;
+    /**
+     * Callback to invoke on click.
+     * @param {React.MouseEvent<HTMLElement>} event - Browser event.
+     */
     onClick(event: React.MouseEvent<HTMLElement>): void;
+    /**
+     * Callback to invoke when the key pressed.
+     * @param {React.KeyboardEvent<HTMLElement>} event - Browser event.
+     */
     onKeyDown(event: React.KeyboardEvent<HTMLElement>): void;
+    /**
+     * Left icon of the tab header.
+     */
     leftIconElement: JSX.Element;
+    /**
+     * The title element of the tab header.
+     */
     titleElement: JSX.Element;
+    /**
+     * Right icon of the tab header.
+     */
     rightIconElement: JSX.Element;
+    /**
+     * The JSX element of the tab header.
+     */
     element: JSX.Element;
+    /**
+     * The props of the tab panel component.
+     */
     props: TabPanelProps;
+    /**
+     * The index of the tab header.
+     */
     index: number;
+    /**
+     * Whether the tab header is selected or not.
+     */
     selected: boolean;
+    /**
+     * The aria-controls attribute of the tab header.
+     */
     ariaControls: string;
 }
 
+/**
+ * Defines valid properties in TabPanel component.
+ * @group Properties
+ */
 export interface TabPanelProps {
-    header?: React.ReactNode;
-    headerTemplate?: TabPanelHeaderTemplateType;
-    leftIcon?: string;
-    rightIcon?: string;
-    disabled?: boolean;
-    closable?: boolean;
-    style?: React.CSSProperties;
-    className?: string;
-    headerStyle?: React.CSSProperties;
-    headerClassName?: string;
-    contentStyle?: React.CSSProperties;
-    contentClassName?: string;
-    children?: React.ReactNode;
+    /**
+     * Orientation of tab headers.
+     */
+    header?: React.ReactNode | undefined;
+    /**
+     * Header template of the tab to customize more.
+     */
+    headerTemplate?: React.ReactNode | ((options: TabPanelHeaderTemplateOptions) => React.ReactNode);
+    /**
+     * Icons can be placed at left of a header.
+     */
+    leftIcon?: string | undefined;
+    /**
+     * Icons can be placed at right of a header.
+     */
+    rightIcon?: string | undefined;
+    /**
+     * Whether the tab is disabled.
+     * @defaultValue false
+     */
+    disabled?: boolean | undefined;
+    /**
+     * Defines if tab can be removed.
+     * @defaultValue false
+     */
+    closable?: boolean | undefined;
+    /**
+     * Inline style of the tab header and content.
+     */
+    style?: React.CSSProperties | undefined;
+    /**
+     * Style class of the tab header and content.
+     */
+    className?: string | undefined;
+    /**
+     * Inline style of the tab header.
+     */
+    headerStyle?: React.CSSProperties | undefined;
+    /**
+     * Style class of the tab header.
+     */
+    headerClassName?: string | undefined;
+    /**
+     * Inline style of the tab content.
+     */
+    contentStyle?: React.CSSProperties | undefined;
+    /**
+     * Style class of the tab content.
+     */
+    contentClassName?: string | undefined;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
 }
 
+/**
+ * TabPanel is a helper component for TabView.
+ * @group Component
+ */
 export declare class TabPanel extends React.Component<TabPanelProps, any> {}
 
-interface TabViewTabChangeParams {
+/**
+ * Custom change event.
+ * @see {@link TabViewProps.onTabChange}
+ * @event
+ */
+interface TabViewTabChangeEvent {
+    /**
+     * Browser event
+     */
     originalEvent: React.SyntheticEvent;
+    /**
+     * Index of the selected tab
+     */
     index: number;
 }
 
-interface TabViewTabCloseParams {
+/**
+ * Custom close event.
+ * @see {@link TabViewProps.onTabClose}
+ * @event
+ */
+interface TabViewTabCloseEvent {
+    /**
+     * Browser event
+     */
     originalEvent: React.SyntheticEvent;
+    /**
+     * Index of the selected tab
+     */
     index: number;
 }
 
+/**
+ * Defines valid properties in TabView component. In addition to these, all properties of HTMLDivElement can be used in this component.
+ * @group Properties
+ */
 export interface TabViewProps extends Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, 'ref'> {
-    activeIndex?: number;
-    children?: React.ReactNode;
-    panelContainerClassName?: string;
-    panelContainerStyle?: React.CSSProperties;
-    renderActiveOnly?: boolean;
-    scrollable?: boolean;
-    onBeforeTabChange?(e: TabViewTabChangeParams): void;
-    onBeforeTabClose?(e: TabViewTabCloseParams): void;
-    onTabChange?(e: TabViewTabChangeParams): void;
-    onTabClose?(e: TabViewTabCloseParams): void;
+    /**
+     * Active index of the TabView.
+     * @defaultValue 0
+     */
+    activeIndex?: number | undefined;
+    /**
+     * Used to get the child elements of the component.
+     * @readonly
+     */
+    children?: React.ReactNode | undefined;
+    /**
+     * Style class of the panels container of the tabview.
+     */
+    panelContainerClassName?: string | undefined;
+    /**
+     * Inline style of the panels container of the tabview.
+     */
+    panelContainerStyle?: React.CSSProperties | undefined;
+    /**
+     * Whether to render the contents of the selected tab or all tabs.
+     * @defaultValue true
+     */
+    renderActiveOnly?: boolean | undefined;
+    /**
+     * When enabled displays buttons at each side of the tab headers to scroll the tab list.
+     * @defaultValue false
+     */
+    scrollable?: boolean | undefined;
+    /**
+     * Callback to invoke before an active tab is changed. Return false to prevent tab from changing.
+     * @param {TabViewTabChangeEvent} event - Custom tab change event.
+     */
+    onBeforeTabChange?(event: TabViewTabChangeEvent): void;
+    /**
+     * Callback to invoke before an active tab is close. Return false to prevent tab from closing.
+     * @param {TabViewTabCloseEvent} event - Custom tab close event.
+     */
+    onBeforeTabClose?(event: TabViewTabCloseEvent): void;
+    /**
+     * Callback to invoke when an active tab is changed.
+     * @param {TabViewTabChangeEvent} event -  Custom tab change event.
+     */
+    onTabChange?(event: TabViewTabChangeEvent): void;
+    /**
+     * Callback to invoke when an active tab is closed.
+     * @param {TabViewTabCloseEvent} event - Custom tab close event.
+     */
+    onTabClose?(event: TabViewTabCloseEvent): void;
 }
 
+/**
+ * **PrimeReact - TabPanel**
+ *
+ * _TabView is a container component to group content with tabs._
+ *
+ * [Live Demo](https://www.primefaces.org/primereact/tabview/)
+ * --- ---
+ * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 // tslint:disable-next-line:max-classes-per-file
 export declare class TabView extends React.Component<TabViewProps, any> {
+    /**
+     * Resets all states.
+     */
     public reset(): void;
+    /**
+     * Used to get container element.
+     * @return {HTMLDivElement} Container element
+     */
     public getElement(): HTMLDivElement;
 }