@progress/kendo-react-progressbars 12.0.2-develop.1 → 12.0.2-develop.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,4 +12,4 @@
12
12
  * Licensed under commercial license. See LICENSE.md in the package root for more information
13
13
  *-------------------------------------------------------------------------------------------
14
14
  */
15
- !function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports,require("react"),require("prop-types"),require("@progress/kendo-react-common"),require("@progress/kendo-react-animation")):"function"==typeof define&&define.amd?define(["exports","react","prop-types","@progress/kendo-react-common","@progress/kendo-react-animation"],r):r((e="undefined"!=typeof globalThis?globalThis:e||self).KendoReactProgressbars={},e.React,e.PropTypes,e.KendoReactCommon,e.KendoReactAnimation)}(this,(function(e,r,a,s,t){"use strict";function n(e){var r=Object.create(null);return e&&Object.keys(e).forEach((function(a){if("default"!==a){var s=Object.getOwnPropertyDescriptor(e,a);Object.defineProperty(r,a,s.get?s:{enumerable:!0,get:function(){return e[a]}})}})),r.default=e,Object.freeze(r)}var l=n(r);const o=(e,r,a)=>{const s=Math.abs((r-e)/100);return Math.abs((a-e)/s)},i=(e,r,a,s)=>{const t=Math.max(a,.01),n=100/t*100;e.current&&r.current&&(e.current.style.width=s?"100%":`${t}%`,r.current.style.width=s?"100%":`${n}%`,e.current.style.height=s?`${t}%`:"100%",r.current.style.height=s?`${n}%`:"100%")},c=(e,r,a)=>Math.max((a-e)/(r-e),1e-5),u=Object.freeze({name:"@progress/kendo-react-progressbars",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate:0,version:"12.0.2-develop.1",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"}),m=l.forwardRef(((e,r)=>{const a=!s.validatePackage(u,{component:"ChunkProgressBar"}),t=s.getLicenseMessage(u),{chunkCount:n=d.chunkCount,className:o,disabled:i=d.disabled,orientation:m,min:b=d.min,max:p=d.max,reverse:g=d.reverse,style:k,tabIndex:v,emptyStyle:f,emptyClassName:y,progressStyle:h,progressClassName:N}=e,C=l.useRef(null),E=l.useCallback((()=>{C.current&&C.current.focus()}),[]);l.useImperativeHandle(r,(()=>({element:C.current,focus:E})));const x=e.value||d.value,R=null===e.value,I=s.useRtl(C,e.dir),S="vertical"===m,w={className:s.classNames("k-progressbar k-chunk-progressbar",{"k-progressbar-horizontal":!S,"k-progressbar-vertical":S,"k-progressbar-reverse":g,"k-progressbar-indeterminate":R,"k-disabled":i},o),ref:C,dir:I,tabIndex:s.getTabIndex(v,i),role:"progressbar","aria-label":e.ariaLabel,"aria-valuemin":b,"aria-valuemax":p,"aria-valuenow":R?void 0:x,"aria-disabled":i,style:k},O=({count:e})=>{const r=[],a=100/e+"%",t=c(b,p,x),n=Math.floor(t*e),o=Array(e).fill(!1);for(let e=0;e<n;e++)o[e]=!0;for(let t=0;t<e;++t){const n=o[t],i=n?N:y,c={width:S?void 0:a,height:S?a:void 0,...n?h:f};r.push(l.createElement("li",{key:t,className:s.classNames("k-progressbar-chunk",{"k-first":0===t,"k-last":t===e-1,"k-selected":n},i),style:c}))}return l.createElement(l.Fragment,null,r)};return l.createElement(l.Fragment,null,l.createElement("div",{...w},l.createElement("ul",{className:"k-progressbar-chunks k-reset"},l.createElement(O,{count:n}))),a&&l.createElement(s.WatermarkOverlay,{message:t}))}));m.propTypes={chunkCount:a.number,ariaLabel:a.string,disabled:a.bool,reverse:a.bool,max:a.number,min:a.number,value:a.number,tabIndex:a.number,emptyStyle:a.object,emptyClassName:a.string,progressStyle:a.object,progressClassName:a.string};const d={chunkCount:5,min:0,max:100,value:0,disabled:!1,reverse:!1};m.displayName="KendoChunkProgressBar";const b=l.forwardRef(((e,r)=>{const{animation:a=p.animation,disabled:n=p.disabled,reverse:c=p.reverse,orientation:u,labelVisible:m=p.labelVisible,labelPlacement:d,max:b=p.max,min:g=p.min,tabIndex:k,className:v,style:f,emptyStyle:y,emptyClassName:h,progressStyle:N,progressClassName:C}=e,E=l.useRef(null),x=l.useRef(null),R=l.useRef(null),I=l.useCallback((()=>{E.current&&E.current.focus()}),[]);l.useImperativeHandle(r,(()=>({element:E.current,progressStatusElement:x.current,progressStatusWrapElement:R.current,focus:I})));const S=e.value||p.value,w=(e=>{const r=l.useRef(void 0);return l.useEffect((()=>{r.current=e})),r.current})(S),O=null===e.value,P=s.useRtl(E,e.dir),j="vertical"===u,T=(e=>{const r=e.toString().split(".");return 1===r.length?`${r[0]}`:`${r[0]}.${r[1].substr(0,3)}`})(S),K={value:S},$=m?e.label?l.createElement("span",{className:"k-progress-status"},l.createElement(e.label,{...K})):l.createElement("span",{className:"k-progress-status"},T):void 0,M={className:s.classNames("k-progressbar",{"k-progressbar-horizontal":!j,"k-progressbar-vertical":j,"k-progressbar-reverse":c,"k-progressbar-indeterminate":O,"k-disabled":n},v),ref:E,dir:P,tabIndex:s.getTabIndex(k,n),role:"progressbar","aria-label":e.ariaLabel,"aria-valuemin":g,"aria-valuemax":b,"aria-valuenow":O?void 0:S,"aria-disabled":n,style:f},A=s.classNames("k-progress-status-wrap",{"k-progress-start":"start"===d,"k-progress-center":"center"===d,"k-progress-end":"end"===d||void 0===d}),B="boolean"!=typeof a&&void 0!==a?a.duration:a?400:0,D=l.useCallback((()=>{const e=o(g,b,w);i(x,R,e,j)}),[j,b,g,w]),L=l.useCallback((e=>{const r=o(g,b,w+(S-w)*e);i(x,R,r,j)}),[g,b,w,S,j]),V=l.useCallback((()=>{const e=o(g,b,S);i(x,R,e,j)}),[j,b,g,S]);return t.useAnimation({duration:B,onStart:D,onUpdate:L,onEnd:V},[S,B]),l.createElement("div",{...M},l.createElement("span",{className:A+(h?" "+h:""),style:y},$),l.createElement("div",{className:"k-progressbar-value k-selected",style:N,ref:x},l.createElement("span",{className:A+(C?" "+C:""),ref:R},$)))}));b.propTypes={animation:a.any,ariaLabel:a.string,disabled:a.bool,reverse:a.bool,label:a.any,labelVisible:a.bool,labelPlacement:a.oneOf(["start","center","end"]),max:a.number,min:a.number,value:a.number,tabIndex:a.number,emptyStyle:a.object,emptyClassName:a.string,progressStyle:a.object,progressClassName:a.string};const p={animation:!1,min:0,max:100,value:0,disabled:!1,reverse:!1,labelVisible:!0};b.displayName="KendoProgressBar",e.ChunkProgressBar=m,e.ProgressBar=b}));
15
+ !function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports,require("react"),require("prop-types"),require("@progress/kendo-react-common"),require("@progress/kendo-react-animation")):"function"==typeof define&&define.amd?define(["exports","react","prop-types","@progress/kendo-react-common","@progress/kendo-react-animation"],r):r((e="undefined"!=typeof globalThis?globalThis:e||self).KendoReactProgressbars={},e.React,e.PropTypes,e.KendoReactCommon,e.KendoReactAnimation)}(this,(function(e,r,a,s,t){"use strict";function n(e){var r=Object.create(null);return e&&Object.keys(e).forEach((function(a){if("default"!==a){var s=Object.getOwnPropertyDescriptor(e,a);Object.defineProperty(r,a,s.get?s:{enumerable:!0,get:function(){return e[a]}})}})),r.default=e,Object.freeze(r)}var l=n(r);const o=(e,r,a)=>{const s=Math.abs((r-e)/100);return Math.abs((a-e)/s)},i=(e,r,a,s)=>{const t=Math.max(a,.01),n=100/t*100;e.current&&r.current&&(e.current.style.width=s?"100%":`${t}%`,r.current.style.width=s?"100%":`${n}%`,e.current.style.height=s?`${t}%`:"100%",r.current.style.height=s?`${n}%`:"100%")},c=(e,r,a)=>Math.max((a-e)/(r-e),1e-5),u=Object.freeze({name:"@progress/kendo-react-progressbars",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate:0,version:"12.0.2-develop.3",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"}),m=l.forwardRef(((e,r)=>{const a=!s.validatePackage(u,{component:"ChunkProgressBar"}),t=s.getLicenseMessage(u),{chunkCount:n=d.chunkCount,className:o,disabled:i=d.disabled,orientation:m,min:b=d.min,max:p=d.max,reverse:g=d.reverse,style:k,tabIndex:v,emptyStyle:f,emptyClassName:y,progressStyle:h,progressClassName:N}=e,C=l.useRef(null),E=l.useCallback((()=>{C.current&&C.current.focus()}),[]);l.useImperativeHandle(r,(()=>({element:C.current,focus:E})));const x=e.value||d.value,R=null===e.value,I=s.useRtl(C,e.dir),S="vertical"===m,w={className:s.classNames("k-progressbar k-chunk-progressbar",{"k-progressbar-horizontal":!S,"k-progressbar-vertical":S,"k-progressbar-reverse":g,"k-progressbar-indeterminate":R,"k-disabled":i},o),ref:C,dir:I,tabIndex:s.getTabIndex(v,i),role:"progressbar","aria-label":e.ariaLabel,"aria-valuemin":b,"aria-valuemax":p,"aria-valuenow":R?void 0:x,"aria-disabled":i,style:k},O=({count:e})=>{const r=[],a=100/e+"%",t=c(b,p,x),n=Math.floor(t*e),o=Array(e).fill(!1);for(let e=0;e<n;e++)o[e]=!0;for(let t=0;t<e;++t){const n=o[t],i=n?N:y,c={width:S?void 0:a,height:S?a:void 0,...n?h:f};r.push(l.createElement("li",{key:t,className:s.classNames("k-progressbar-chunk",{"k-first":0===t,"k-last":t===e-1,"k-selected":n},i),style:c}))}return l.createElement(l.Fragment,null,r)};return l.createElement(l.Fragment,null,l.createElement("div",{...w},l.createElement("ul",{className:"k-progressbar-chunks k-reset"},l.createElement(O,{count:n}))),a&&l.createElement(s.WatermarkOverlay,{message:t}))}));m.propTypes={chunkCount:a.number,ariaLabel:a.string,disabled:a.bool,reverse:a.bool,max:a.number,min:a.number,value:a.number,tabIndex:a.number,emptyStyle:a.object,emptyClassName:a.string,progressStyle:a.object,progressClassName:a.string};const d={chunkCount:5,min:0,max:100,value:0,disabled:!1,reverse:!1};m.displayName="KendoChunkProgressBar";const b=l.forwardRef(((e,r)=>{const{animation:a=p.animation,disabled:n=p.disabled,reverse:c=p.reverse,orientation:u,labelVisible:m=p.labelVisible,labelPlacement:d,max:b=p.max,min:g=p.min,tabIndex:k,className:v,style:f,emptyStyle:y,emptyClassName:h,progressStyle:N,progressClassName:C}=e,E=l.useRef(null),x=l.useRef(null),R=l.useRef(null),I=l.useCallback((()=>{E.current&&E.current.focus()}),[]);l.useImperativeHandle(r,(()=>({element:E.current,progressStatusElement:x.current,progressStatusWrapElement:R.current,focus:I})));const S=e.value||p.value,w=(e=>{const r=l.useRef(void 0);return l.useEffect((()=>{r.current=e})),r.current})(S),O=null===e.value,P=s.useRtl(E,e.dir),j="vertical"===u,T=(e=>{const r=e.toString().split(".");return 1===r.length?`${r[0]}`:`${r[0]}.${r[1].substr(0,3)}`})(S),K={value:S},$=m?e.label?l.createElement("span",{className:"k-progress-status"},l.createElement(e.label,{...K})):l.createElement("span",{className:"k-progress-status"},T):void 0,M={className:s.classNames("k-progressbar",{"k-progressbar-horizontal":!j,"k-progressbar-vertical":j,"k-progressbar-reverse":c,"k-progressbar-indeterminate":O,"k-disabled":n},v),ref:E,dir:P,tabIndex:s.getTabIndex(k,n),role:"progressbar","aria-label":e.ariaLabel,"aria-valuemin":g,"aria-valuemax":b,"aria-valuenow":O?void 0:S,"aria-disabled":n,style:f},A=s.classNames("k-progress-status-wrap",{"k-progress-start":"start"===d,"k-progress-center":"center"===d,"k-progress-end":"end"===d||void 0===d}),B="boolean"!=typeof a&&void 0!==a?a.duration:a?400:0,D=l.useCallback((()=>{const e=o(g,b,w);i(x,R,e,j)}),[j,b,g,w]),L=l.useCallback((e=>{const r=o(g,b,w+(S-w)*e);i(x,R,r,j)}),[g,b,w,S,j]),V=l.useCallback((()=>{const e=o(g,b,S);i(x,R,e,j)}),[j,b,g,S]);return t.useAnimation({duration:B,onStart:D,onUpdate:L,onEnd:V},[S,B]),l.createElement("div",{...M},l.createElement("span",{className:A+(h?" "+h:""),style:y},$),l.createElement("div",{className:"k-progressbar-value k-selected",style:N,ref:x},l.createElement("span",{className:A+(C?" "+C:""),ref:R},$)))}));b.propTypes={animation:a.any,ariaLabel:a.string,disabled:a.bool,reverse:a.bool,label:a.any,labelVisible:a.bool,labelPlacement:a.oneOf(["start","center","end"]),max:a.number,min:a.number,value:a.number,tabIndex:a.number,emptyStyle:a.object,emptyClassName:a.string,progressStyle:a.object,progressClassName:a.string};const p={animation:!1,min:0,max:100,value:0,disabled:!1,reverse:!1,labelVisible:!0};b.displayName="KendoProgressBar",e.ChunkProgressBar=m,e.ProgressBar=b}));
package/index.d.mts CHANGED
@@ -27,7 +27,9 @@ declare interface BaseProps {
27
27
  * Set to `null` to enable the indeterminate state of the progress bar.
28
28
  * See examples ([here]({% slug overview_progressbar %})) and ([here]({% slug overview_chunkprogressbar %})).
29
29
  *
30
- * Example:
30
+ * @default 0
31
+ *
32
+ * @example
31
33
  * ```jsx
32
34
  * <ProgressBar value={50} />
33
35
  * ```
@@ -36,7 +38,9 @@ declare interface BaseProps {
36
38
  /**
37
39
  * Specifies the minimum value of the progress bar. Defaults to `0`.
38
40
  *
39
- * Example:
41
+ * @default 0
42
+ *
43
+ * @example
40
44
  * ```jsx
41
45
  * <ProgressBar min={0} />
42
46
  * ```
@@ -45,7 +49,9 @@ declare interface BaseProps {
45
49
  /**
46
50
  * Specifies the maximum value of the progress bar. Defaults to `100`.
47
51
  *
48
- * Example:
52
+ * @default 100
53
+ *
54
+ * @example
49
55
  * ```jsx
50
56
  * <ProgressBar max={100} />
51
57
  * ```
@@ -54,7 +60,7 @@ declare interface BaseProps {
54
60
  /**
55
61
  * Sets the `dir` HTML attribute to switch between LTR and RTL directions.
56
62
  *
57
- * Example:
63
+ * @example
58
64
  * ```jsx
59
65
  * <ProgressBar dir="rtl" />
60
66
  * ```
@@ -63,7 +69,7 @@ declare interface BaseProps {
63
69
  /**
64
70
  * Provides an accessible label for the component.
65
71
  *
66
- * Example:
72
+ * @example
67
73
  * ```jsx
68
74
  * <ProgressBar ariaLabel="Loading progress" />
69
75
  * ```
@@ -73,7 +79,7 @@ declare interface BaseProps {
73
79
  * Determines whether the progress bar is in a disabled state.
74
80
  * See examples ([here]({% slug progressbar_disabled %})) and ([here]({% slug chunkprogressbar_disabled %})).
75
81
  *
76
- * Example:
82
+ * @example
77
83
  * ```jsx
78
84
  * <ProgressBar disabled={true} />
79
85
  * ```
@@ -83,7 +89,9 @@ declare interface BaseProps {
83
89
  * Specifies the orientation of the progress bar. Can be `horizontal` or `vertical`. Defaults to `horizontal`.
84
90
  * See examples ([here]({% slug progressbar_orientation %})) and ([here]({% slug chunkprogressbar_orientation %})).
85
91
  *
86
- * Example:
92
+ * @default "horizontal"
93
+ *
94
+ * @example
87
95
  * ```jsx
88
96
  * <ProgressBar orientation="vertical" />
89
97
  * ```
@@ -93,7 +101,9 @@ declare interface BaseProps {
93
101
  * If set to `true`, reverses the direction of the progress bar. Defaults to `false`.
94
102
  * See examples ([here]({% slug progressbar_direction %})) and ([here]({% slug chunkprogressbar_direction %})).
95
103
  *
96
- * Example:
104
+ * @default false
105
+ *
106
+ * @example
97
107
  * ```jsx
98
108
  * <ProgressBar reverse={true} />
99
109
  * ```
@@ -102,7 +112,7 @@ declare interface BaseProps {
102
112
  /**
103
113
  * Adds a list of CSS classes to the progress bar element.
104
114
  *
105
- * Example:
115
+ * @example
106
116
  * ```jsx
107
117
  * <ProgressBar className="custom-progress-bar" />
108
118
  * ```
@@ -111,7 +121,7 @@ declare interface BaseProps {
111
121
  /**
112
122
  * Applies additional CSS styles to the progress bar.
113
123
  *
114
- * Example:
124
+ * @example
115
125
  * ```jsx
116
126
  * <ProgressBar style={{ backgroundColor: 'red' }} />
117
127
  * ```
@@ -121,7 +131,7 @@ declare interface BaseProps {
121
131
  * Specifies the styles applied to the inner element representing the empty portion of the progress bar.
122
132
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
123
133
  *
124
- * Example:
134
+ * @example
125
135
  * ```jsx
126
136
  * <ProgressBar emptyStyle={{ backgroundColor: 'lightgray' }} />
127
137
  * ```
@@ -131,7 +141,7 @@ declare interface BaseProps {
131
141
  * Adds additional CSS classes to the inner element representing the empty portion of the progress bar.
132
142
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
133
143
  *
134
- * Example:
144
+ * @example
135
145
  * ```jsx
136
146
  * <ProgressBar emptyClassName="custom-empty-class" />
137
147
  * ```
@@ -141,7 +151,7 @@ declare interface BaseProps {
141
151
  * Specifies the styles applied to the inner element representing the full portion of the progress bar.
142
152
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
143
153
  *
144
- * Example:
154
+ * @example
145
155
  * ```jsx
146
156
  * <ProgressBar progressStyle={{ backgroundColor: 'green' }} />
147
157
  * ```
@@ -151,7 +161,7 @@ declare interface BaseProps {
151
161
  * Adds additional CSS classes to the inner element representing the full portion of the progress bar.
152
162
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
153
163
  *
154
- * Example:
164
+ * @example
155
165
  * ```jsx
156
166
  * <ProgressBar progressClassName="custom-progress-class" />
157
167
  * ```
@@ -160,7 +170,7 @@ declare interface BaseProps {
160
170
  /**
161
171
  * Sets the `tabIndex` attribute of the progress bar for keyboard navigation.
162
172
  *
163
- * Example:
173
+ * @example
164
174
  * ```jsx
165
175
  * <ProgressBar tabIndex={0} />
166
176
  * ```
@@ -204,6 +214,8 @@ export declare interface ChunkProgressBarProps extends BaseProps {
204
214
  * Defines the number of chunks into which the ChunkProgressBar is divided. Defaults to `5`.
205
215
  * Each chunk visually represents a portion of the progress bar.
206
216
  *
217
+ * @default 5
218
+ *
207
219
  * @example
208
220
  * ```jsx
209
221
  * <ChunkProgressBar chunkCount={10} />
@@ -242,6 +254,8 @@ export declare const ProgressBar: React_2.ForwardRefExoticComponent<ProgressBarP
242
254
  export declare interface ProgressBarAnimation {
243
255
  /**
244
256
  * Specifies the duration of the ProgressBar animation. Defaults to `400`.
257
+ *
258
+ * @default 400
245
259
  */
246
260
  duration: number;
247
261
  }
@@ -277,6 +291,8 @@ export declare interface ProgressBarProps extends BaseProps {
277
291
  * If set to a boolean, it enables or disables the default animation.
278
292
  * If set to a `ProgressBarAnimation` object, it allows customization of the slide animation duration in milliseconds.
279
293
  *
294
+ * @default false
295
+ *
280
296
  * @example
281
297
  * ```jsx
282
298
  * <ProgressBar animation={{ duration: 500 }} />
@@ -296,6 +312,8 @@ export declare interface ProgressBarProps extends BaseProps {
296
312
  /**
297
313
  * Determines whether the progress status label is visible. Defaults to `true`.
298
314
  *
315
+ * @default true
316
+ *
299
317
  * @example
300
318
  * ```jsx
301
319
  * <ProgressBar labelVisible={false} />
@@ -305,6 +323,8 @@ export declare interface ProgressBarProps extends BaseProps {
305
323
  /**
306
324
  * Specifies the position of the progress status label. Defaults to `end` ([see example]({% slug progressbar_label %})).
307
325
  *
326
+ * @default "end"
327
+ *
308
328
  * @example
309
329
  * ```jsx
310
330
  * <ProgressBar labelPlacement="center" />
package/index.d.ts CHANGED
@@ -27,7 +27,9 @@ declare interface BaseProps {
27
27
  * Set to `null` to enable the indeterminate state of the progress bar.
28
28
  * See examples ([here]({% slug overview_progressbar %})) and ([here]({% slug overview_chunkprogressbar %})).
29
29
  *
30
- * Example:
30
+ * @default 0
31
+ *
32
+ * @example
31
33
  * ```jsx
32
34
  * <ProgressBar value={50} />
33
35
  * ```
@@ -36,7 +38,9 @@ declare interface BaseProps {
36
38
  /**
37
39
  * Specifies the minimum value of the progress bar. Defaults to `0`.
38
40
  *
39
- * Example:
41
+ * @default 0
42
+ *
43
+ * @example
40
44
  * ```jsx
41
45
  * <ProgressBar min={0} />
42
46
  * ```
@@ -45,7 +49,9 @@ declare interface BaseProps {
45
49
  /**
46
50
  * Specifies the maximum value of the progress bar. Defaults to `100`.
47
51
  *
48
- * Example:
52
+ * @default 100
53
+ *
54
+ * @example
49
55
  * ```jsx
50
56
  * <ProgressBar max={100} />
51
57
  * ```
@@ -54,7 +60,7 @@ declare interface BaseProps {
54
60
  /**
55
61
  * Sets the `dir` HTML attribute to switch between LTR and RTL directions.
56
62
  *
57
- * Example:
63
+ * @example
58
64
  * ```jsx
59
65
  * <ProgressBar dir="rtl" />
60
66
  * ```
@@ -63,7 +69,7 @@ declare interface BaseProps {
63
69
  /**
64
70
  * Provides an accessible label for the component.
65
71
  *
66
- * Example:
72
+ * @example
67
73
  * ```jsx
68
74
  * <ProgressBar ariaLabel="Loading progress" />
69
75
  * ```
@@ -73,7 +79,7 @@ declare interface BaseProps {
73
79
  * Determines whether the progress bar is in a disabled state.
74
80
  * See examples ([here]({% slug progressbar_disabled %})) and ([here]({% slug chunkprogressbar_disabled %})).
75
81
  *
76
- * Example:
82
+ * @example
77
83
  * ```jsx
78
84
  * <ProgressBar disabled={true} />
79
85
  * ```
@@ -83,7 +89,9 @@ declare interface BaseProps {
83
89
  * Specifies the orientation of the progress bar. Can be `horizontal` or `vertical`. Defaults to `horizontal`.
84
90
  * See examples ([here]({% slug progressbar_orientation %})) and ([here]({% slug chunkprogressbar_orientation %})).
85
91
  *
86
- * Example:
92
+ * @default "horizontal"
93
+ *
94
+ * @example
87
95
  * ```jsx
88
96
  * <ProgressBar orientation="vertical" />
89
97
  * ```
@@ -93,7 +101,9 @@ declare interface BaseProps {
93
101
  * If set to `true`, reverses the direction of the progress bar. Defaults to `false`.
94
102
  * See examples ([here]({% slug progressbar_direction %})) and ([here]({% slug chunkprogressbar_direction %})).
95
103
  *
96
- * Example:
104
+ * @default false
105
+ *
106
+ * @example
97
107
  * ```jsx
98
108
  * <ProgressBar reverse={true} />
99
109
  * ```
@@ -102,7 +112,7 @@ declare interface BaseProps {
102
112
  /**
103
113
  * Adds a list of CSS classes to the progress bar element.
104
114
  *
105
- * Example:
115
+ * @example
106
116
  * ```jsx
107
117
  * <ProgressBar className="custom-progress-bar" />
108
118
  * ```
@@ -111,7 +121,7 @@ declare interface BaseProps {
111
121
  /**
112
122
  * Applies additional CSS styles to the progress bar.
113
123
  *
114
- * Example:
124
+ * @example
115
125
  * ```jsx
116
126
  * <ProgressBar style={{ backgroundColor: 'red' }} />
117
127
  * ```
@@ -121,7 +131,7 @@ declare interface BaseProps {
121
131
  * Specifies the styles applied to the inner element representing the empty portion of the progress bar.
122
132
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
123
133
  *
124
- * Example:
134
+ * @example
125
135
  * ```jsx
126
136
  * <ProgressBar emptyStyle={{ backgroundColor: 'lightgray' }} />
127
137
  * ```
@@ -131,7 +141,7 @@ declare interface BaseProps {
131
141
  * Adds additional CSS classes to the inner element representing the empty portion of the progress bar.
132
142
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
133
143
  *
134
- * Example:
144
+ * @example
135
145
  * ```jsx
136
146
  * <ProgressBar emptyClassName="custom-empty-class" />
137
147
  * ```
@@ -141,7 +151,7 @@ declare interface BaseProps {
141
151
  * Specifies the styles applied to the inner element representing the full portion of the progress bar.
142
152
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
143
153
  *
144
- * Example:
154
+ * @example
145
155
  * ```jsx
146
156
  * <ProgressBar progressStyle={{ backgroundColor: 'green' }} />
147
157
  * ```
@@ -151,7 +161,7 @@ declare interface BaseProps {
151
161
  * Adds additional CSS classes to the inner element representing the full portion of the progress bar.
152
162
  * See examples ([here]({% slug progressbar_appearance %})) and ([here]({% slug chunkprogressbar_appearance %})).
153
163
  *
154
- * Example:
164
+ * @example
155
165
  * ```jsx
156
166
  * <ProgressBar progressClassName="custom-progress-class" />
157
167
  * ```
@@ -160,7 +170,7 @@ declare interface BaseProps {
160
170
  /**
161
171
  * Sets the `tabIndex` attribute of the progress bar for keyboard navigation.
162
172
  *
163
- * Example:
173
+ * @example
164
174
  * ```jsx
165
175
  * <ProgressBar tabIndex={0} />
166
176
  * ```
@@ -204,6 +214,8 @@ export declare interface ChunkProgressBarProps extends BaseProps {
204
214
  * Defines the number of chunks into which the ChunkProgressBar is divided. Defaults to `5`.
205
215
  * Each chunk visually represents a portion of the progress bar.
206
216
  *
217
+ * @default 5
218
+ *
207
219
  * @example
208
220
  * ```jsx
209
221
  * <ChunkProgressBar chunkCount={10} />
@@ -242,6 +254,8 @@ export declare const ProgressBar: React_2.ForwardRefExoticComponent<ProgressBarP
242
254
  export declare interface ProgressBarAnimation {
243
255
  /**
244
256
  * Specifies the duration of the ProgressBar animation. Defaults to `400`.
257
+ *
258
+ * @default 400
245
259
  */
246
260
  duration: number;
247
261
  }
@@ -277,6 +291,8 @@ export declare interface ProgressBarProps extends BaseProps {
277
291
  * If set to a boolean, it enables or disables the default animation.
278
292
  * If set to a `ProgressBarAnimation` object, it allows customization of the slide animation duration in milliseconds.
279
293
  *
294
+ * @default false
295
+ *
280
296
  * @example
281
297
  * ```jsx
282
298
  * <ProgressBar animation={{ duration: 500 }} />
@@ -296,6 +312,8 @@ export declare interface ProgressBarProps extends BaseProps {
296
312
  /**
297
313
  * Determines whether the progress status label is visible. Defaults to `true`.
298
314
  *
315
+ * @default true
316
+ *
299
317
  * @example
300
318
  * ```jsx
301
319
  * <ProgressBar labelVisible={false} />
@@ -305,6 +323,8 @@ export declare interface ProgressBarProps extends BaseProps {
305
323
  /**
306
324
  * Specifies the position of the progress status label. Defaults to `end` ([see example]({% slug progressbar_label %})).
307
325
  *
326
+ * @default "end"
327
+ *
308
328
  * @example
309
329
  * ```jsx
310
330
  * <ProgressBar labelPlacement="center" />
@@ -5,4 +5,4 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-progressbars",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1756966888,version:"12.0.2-develop.1",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
8
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-progressbars",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1757419390,version:"12.0.2-develop.3",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
@@ -10,8 +10,8 @@ const e = Object.freeze({
10
10
  productName: "KendoReact",
11
11
  productCode: "KENDOUIREACT",
12
12
  productCodes: ["KENDOUIREACT"],
13
- publishDate: 1756966888,
14
- version: "12.0.2-develop.1",
13
+ publishDate: 1757419390,
14
+ version: "12.0.2-develop.3",
15
15
  licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
16
16
  });
17
17
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-progressbars",
3
- "version": "12.0.2-develop.1",
3
+ "version": "12.0.2-develop.3",
4
4
  "description": "React ProgressBars offer a customizable interface for users to track and display the progress of a task. KendoReact ProgressBars package",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -26,8 +26,8 @@
26
26
  "sideEffects": false,
27
27
  "peerDependencies": {
28
28
  "@progress/kendo-licensing": "^1.7.0",
29
- "@progress/kendo-react-animation": "12.0.2-develop.1",
30
- "@progress/kendo-react-common": "12.0.2-develop.1",
29
+ "@progress/kendo-react-animation": "12.0.2-develop.3",
30
+ "@progress/kendo-react-common": "12.0.2-develop.3",
31
31
  "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
32
32
  "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
33
33
  },
@@ -56,7 +56,7 @@
56
56
  "package": {
57
57
  "productName": "KendoReact",
58
58
  "productCode": "KENDOUIREACT",
59
- "publishDate": 1756966888,
59
+ "publishDate": 1757419390,
60
60
  "licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
61
61
  }
62
62
  },