@progress/kendo-react-scrollview 7.2.4-develop.3 → 7.2.4-develop.4
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.
- package/ScrollView.js +8 -0
- package/ScrollView.mjs +151 -0
- package/dist/cdn/js/kendo-react-scrollview.js +8 -5
- package/index.d.mts +117 -5
- package/index.d.ts +117 -6
- package/index.js +8 -5
- package/index.mjs +9 -151
- package/package-metadata.js +8 -0
- package/package-metadata.mjs +19 -0
- package/package.json +2 -2
- package/ScrollView.d.ts +0 -52
- package/ScrollViewProps.d.ts +0 -62
- package/package-metadata.d.ts +0 -9
package/ScrollView.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const M=require("react"),r=require("prop-types"),o=require("@progress/kendo-react-common"),A=require("./package-metadata.js"),p=require("@progress/kendo-svg-icons");function _(c){const m=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(c){for(const i in c)if(i!=="default"){const f=Object.getOwnPropertyDescriptor(c,i);Object.defineProperty(m,i,f.get?f:{enumerable:!0,get:()=>c[i]})}}return m.default=c,Object.freeze(m)}const e=_(M),k=e.forwardRef((c,m)=>{o.validatePackage(A.packageMetadata);const{className:i,style:f,children:N,pagerOverlay:b,pageable:O,arrows:P,endless:n,activeView:S,automaticViewChange:E,automaticViewChangeInterval:R}=c,[t,s]=e.useState(S||1),g=e.useRef(null),d=e.useRef(null),y=e.useRef(null),l=e.Children.toArray(N),C=o.useRtl(g,c.dir),u=C==="rtl",I=e.useCallback(()=>{g.current&&g.current.focus()},[]),T=e.useCallback(()=>({element:g.current,focus:I}),[I]);e.useImperativeHandle(m,T);const h=e.useCallback(()=>{n?t>1?s(t-1):s(l.length):t>1&&s(t-1)},[t,l.length,n]),w=e.useCallback(()=>{n?t<l.length?s(t+1):s(1):t<l.length&&s(t+1)},[t,l.length,n]);e.useEffect(()=>{let a=l.length;d.current&&(d.current.style.setProperty("--kendo-scrollview-views",`${a}`),d.current.style.setProperty("--kendo-scrollview-current",`${t}`))},[l,t,C]);function V(){y.current&&clearTimeout(y.current)}e.useEffect(()=>{if(E)return V(),y.current=setTimeout(()=>s(a=>a===l.length?n?1:a:a+1),R),()=>{V()}},[E,R,l.length,t,n]);const j=e.useCallback(a=>{switch(a.keyCode){case o.Keys.left:a.preventDefault(),u?w():h();break;case o.Keys.right:a.preventDefault(),u?h():w();break}},[u,w,h]),D=e.useMemo(()=>o.classNames("k-scrollview",{"k-scrollview-light":b==="light","k-scrollview-dark":b==="dark"},i),[i,b]),q=e.Children.map(N||null,(a,v)=>e.createElement("div",{className:"k-scrollview-view","aria-hidden":t!==v+1},a)),x=e.useCallback(()=>{let a;return a=t>1,(n||a)&&l.length>0},[t,l.length,n]),K=e.useCallback(()=>{let a;return a=t<l.length,(n||a)&&l.length>0},[t,l.length,n]);return e.createElement("div",{className:D,style:f,ref:g,tabIndex:0,dir:C,onKeyDown:j},e.createElement("div",{className:"k-scrollview-wrap k-scrollview-animate",ref:d},q),e.createElement("div",{className:"k-scrollview-elements"},P&&e.createElement(e.Fragment,null,x()&&e.createElement("span",{className:"k-scrollview-prev","aria-label":"previous",onClick:h},e.createElement(o.IconWrap,{name:u?"chevron-right":"chevron-left",icon:u?p.chevronRightIcon:p.chevronLeftIcon,size:"xxxlarge"})),K()&&e.createElement("span",{className:"k-scrollview-next",onClick:w},e.createElement(o.IconWrap,{name:u?"chevron-left":"chevron-right",icon:u?p.chevronLeftIcon:p.chevronRightIcon,size:"xxxlarge"}))),O&&e.createElement("div",{className:"k-scrollview-nav-wrap"},e.createElement("div",{className:"k-scrollview-nav"},l.map((a,v)=>e.createElement("span",{className:o.classNames("k-link",{"k-primary":t===v+1}),key:v+1,onClick:()=>s(v+1)}))))))});k.propTypes={activeView:r.number,arrows:r.bool,automaticViewChange:r.bool,automaticViewChangeInterval:r.number,children:r.any,className:r.string,dir:r.string,endless:r.bool,pageable:r.bool,pageOverlay:r.string,style:r.object};const z={activeView:1,arrows:!0,automaticViewChange:!0,automaticViewChangeInterval:5e3,endless:!1,pageable:!0,pageOverlay:"none"};k.defaultProps=z;k.displayName="KendoScrollView";exports.ScrollView=k;
|
package/ScrollView.mjs
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
"use client";
|
|
9
|
+
import * as e from "react";
|
|
10
|
+
import r from "prop-types";
|
|
11
|
+
import { validatePackage as M, useRtl as $, Keys as N, classNames as R, IconWrap as V } from "@progress/kendo-react-common";
|
|
12
|
+
import { packageMetadata as j } from "./package-metadata.mjs";
|
|
13
|
+
import { chevronRightIcon as I, chevronLeftIcon as x } from "@progress/kendo-svg-icons";
|
|
14
|
+
const h = e.forwardRef((p, P) => {
|
|
15
|
+
M(j);
|
|
16
|
+
const {
|
|
17
|
+
className: d,
|
|
18
|
+
style: T,
|
|
19
|
+
children: k,
|
|
20
|
+
pagerOverlay: f,
|
|
21
|
+
pageable: A,
|
|
22
|
+
arrows: D,
|
|
23
|
+
endless: n,
|
|
24
|
+
activeView: K,
|
|
25
|
+
automaticViewChange: y,
|
|
26
|
+
automaticViewChangeInterval: b
|
|
27
|
+
} = p, [t, s] = e.useState(K || 1), o = e.useRef(null), m = e.useRef(null), g = e.useRef(null), a = e.Children.toArray(k), w = $(o, p.dir), c = w === "rtl", C = e.useCallback(
|
|
28
|
+
() => {
|
|
29
|
+
o.current && o.current.focus();
|
|
30
|
+
},
|
|
31
|
+
[]
|
|
32
|
+
), O = e.useCallback(
|
|
33
|
+
() => ({
|
|
34
|
+
element: o.current,
|
|
35
|
+
focus: C
|
|
36
|
+
}),
|
|
37
|
+
[C]
|
|
38
|
+
);
|
|
39
|
+
e.useImperativeHandle(P, O);
|
|
40
|
+
const u = e.useCallback(() => {
|
|
41
|
+
n ? t > 1 ? s(t - 1) : s(a.length) : t > 1 && s(t - 1);
|
|
42
|
+
}, [t, a.length, n]), v = e.useCallback(() => {
|
|
43
|
+
n ? t < a.length ? s(t + 1) : s(1) : t < a.length && s(t + 1);
|
|
44
|
+
}, [t, a.length, n]);
|
|
45
|
+
e.useEffect(() => {
|
|
46
|
+
let l = a.length;
|
|
47
|
+
m.current && (m.current.style.setProperty("--kendo-scrollview-views", `${l}`), m.current.style.setProperty("--kendo-scrollview-current", `${t}`));
|
|
48
|
+
}, [a, t, w]);
|
|
49
|
+
function E() {
|
|
50
|
+
g.current && clearTimeout(g.current);
|
|
51
|
+
}
|
|
52
|
+
e.useEffect(() => {
|
|
53
|
+
if (y)
|
|
54
|
+
return E(), g.current = setTimeout(
|
|
55
|
+
() => s((l) => l === a.length ? n ? 1 : l : l + 1),
|
|
56
|
+
b
|
|
57
|
+
), () => {
|
|
58
|
+
E();
|
|
59
|
+
};
|
|
60
|
+
}, [y, b, a.length, t, n]);
|
|
61
|
+
const S = e.useCallback(
|
|
62
|
+
(l) => {
|
|
63
|
+
switch (l.keyCode) {
|
|
64
|
+
case N.left:
|
|
65
|
+
l.preventDefault(), c ? v() : u();
|
|
66
|
+
break;
|
|
67
|
+
case N.right:
|
|
68
|
+
l.preventDefault(), c ? u() : v();
|
|
69
|
+
break;
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
[c, v, u]
|
|
73
|
+
), z = e.useMemo(
|
|
74
|
+
() => R(
|
|
75
|
+
"k-scrollview",
|
|
76
|
+
{
|
|
77
|
+
"k-scrollview-light": f === "light",
|
|
78
|
+
"k-scrollview-dark": f === "dark"
|
|
79
|
+
},
|
|
80
|
+
d
|
|
81
|
+
),
|
|
82
|
+
[d, f]
|
|
83
|
+
), B = e.Children.map(k || null, (l, i) => /* @__PURE__ */ e.createElement(
|
|
84
|
+
"div",
|
|
85
|
+
{
|
|
86
|
+
className: "k-scrollview-view",
|
|
87
|
+
"aria-hidden": t !== i + 1
|
|
88
|
+
},
|
|
89
|
+
l
|
|
90
|
+
)), H = e.useCallback(() => {
|
|
91
|
+
let l;
|
|
92
|
+
return l = t > 1, (n || l) && a.length > 0;
|
|
93
|
+
}, [t, a.length, n]), L = e.useCallback(() => {
|
|
94
|
+
let l;
|
|
95
|
+
return l = t < a.length, (n || l) && a.length > 0;
|
|
96
|
+
}, [t, a.length, n]);
|
|
97
|
+
return /* @__PURE__ */ e.createElement("div", { className: z, style: T, ref: o, tabIndex: 0, dir: w, onKeyDown: S }, /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-wrap k-scrollview-animate", ref: m }, B), /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-elements" }, D && /* @__PURE__ */ e.createElement(e.Fragment, null, H() && /* @__PURE__ */ e.createElement("span", { className: "k-scrollview-prev", "aria-label": "previous", onClick: u }, /* @__PURE__ */ e.createElement(
|
|
98
|
+
V,
|
|
99
|
+
{
|
|
100
|
+
name: c ? "chevron-right" : "chevron-left",
|
|
101
|
+
icon: c ? I : x,
|
|
102
|
+
size: "xxxlarge"
|
|
103
|
+
}
|
|
104
|
+
)), L() && /* @__PURE__ */ e.createElement("span", { className: "k-scrollview-next", onClick: v }, /* @__PURE__ */ e.createElement(
|
|
105
|
+
V,
|
|
106
|
+
{
|
|
107
|
+
name: c ? "chevron-left" : "chevron-right",
|
|
108
|
+
icon: c ? x : I,
|
|
109
|
+
size: "xxxlarge"
|
|
110
|
+
}
|
|
111
|
+
))), A && /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-nav-wrap" }, /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-nav" }, a.map((l, i) => /* @__PURE__ */ e.createElement(
|
|
112
|
+
"span",
|
|
113
|
+
{
|
|
114
|
+
className: R(
|
|
115
|
+
"k-link",
|
|
116
|
+
{
|
|
117
|
+
"k-primary": t === i + 1
|
|
118
|
+
}
|
|
119
|
+
),
|
|
120
|
+
key: i + 1,
|
|
121
|
+
onClick: () => s(i + 1)
|
|
122
|
+
}
|
|
123
|
+
))))));
|
|
124
|
+
});
|
|
125
|
+
h.propTypes = {
|
|
126
|
+
activeView: r.number,
|
|
127
|
+
arrows: r.bool,
|
|
128
|
+
automaticViewChange: r.bool,
|
|
129
|
+
automaticViewChangeInterval: r.number,
|
|
130
|
+
children: r.any,
|
|
131
|
+
className: r.string,
|
|
132
|
+
dir: r.string,
|
|
133
|
+
endless: r.bool,
|
|
134
|
+
pageable: r.bool,
|
|
135
|
+
pageOverlay: r.string,
|
|
136
|
+
style: r.object
|
|
137
|
+
};
|
|
138
|
+
const F = {
|
|
139
|
+
activeView: 1,
|
|
140
|
+
arrows: !0,
|
|
141
|
+
automaticViewChange: !0,
|
|
142
|
+
automaticViewChangeInterval: 5e3,
|
|
143
|
+
endless: !1,
|
|
144
|
+
pageable: !0,
|
|
145
|
+
pageOverlay: "none"
|
|
146
|
+
};
|
|
147
|
+
h.defaultProps = F;
|
|
148
|
+
h.displayName = "KendoScrollView";
|
|
149
|
+
export {
|
|
150
|
+
h as ScrollView
|
|
151
|
+
};
|
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
!function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports,require("react"),require("prop-types"),require("@progress/kendo-react-common"),require("@progress/kendo-svg-icons")):"function"==typeof define&&define.amd?define(["exports","react","prop-types","@progress/kendo-react-common","@progress/kendo-svg-icons"],r):r((e="undefined"!=typeof globalThis?globalThis:e||self).KendoReactScrollview={},e.React,e.PropTypes,e.KendoReactCommon,e.KendoSvgIcons)}(this,(function(e,r,t,l,n){"use strict";function a(e){var r=Object.create(null);return e&&Object.keys(e).forEach((function(t){if("default"!==t){var l=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,l.get?l:{enumerable:!0,get:function(){return e[t]}})}})),r.default=e,Object.freeze(r)}var c=a(r);const s={name:"@progress/kendo-react-scrollview",productName:"KendoReact",productCodes:["KENDOUIREACT","KENDOUICOMPLETE"],publishDate:0,version:"",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"},o=c.forwardRef(((e,r)=>{l.validatePackage(s);const{className:t,style:a,children:o,pagerOverlay:i,pageable:u,arrows:m,endless:p,activeView:d,automaticViewChange:v,automaticViewChangeInterval:g}=e,[h,f]=c.useState(d||1),k=c.useRef(null),w=c.useRef(null),y=c.useRef(null),b=c.Children.toArray(o),C=l.useRtl(k,e.dir),E="rtl"===C,N=c.useCallback((()=>{k.current&&k.current.focus()}),[]),I=c.useCallback((()=>({element:k.current,focus:N})),[N]);c.useImperativeHandle(r,I);const O=c.useCallback((()=>{p?f(h>1?h-1:b.length):h>1&&f(h-1)}),[h,b.length,p]),R=c.useCallback((()=>{p?h<b.length?f(h+1):f(1):h<b.length&&f(h+1)}),[h,b.length,p]);function x(){y.current&&clearTimeout(y.current)}c.useEffect((()=>{let e=b.length;w.current&&(w.current.style.setProperty("--kendo-scrollview-views",`${e}`),w.current.style.setProperty("--kendo-scrollview-current",`${h}`))}),[b,h,C]),c.useEffect((()=>{if(v)return x(),y.current=setTimeout((()=>f((e=>e===b.length?p?1:e:e+1))),g),()=>{x()}}),[v,g,b.length,h,p]);const V=c.useCallback((e=>{switch(e.keyCode){case l.Keys.left:e.preventDefault(),E?R():O();break;case l.Keys.right:e.preventDefault(),E?O():R()}}),[E,R,O]),K=c.useMemo((()=>l.classNames("k-scrollview",{"k-scrollview-light":"light"===i,"k-scrollview-dark":"dark"===i},t)),[t,i]),D=c.Children.map(o||null,((e,r)=>c.createElement("div",{className:"k-scrollview-view","aria-hidden":h!==r+1},e))),P=c.useCallback((()=>{let e;return e=h>1,(p||e)&&b.length>0}),[h,b.length,p]),T=c.useCallback((()=>{let e;return e=h<b.length,(p||e)&&b.length>0}),[h,b.length,p]);return c.createElement("div",{className:K,style:a,ref:k,tabIndex:0,dir:C,onKeyDown:V},c.createElement("div",{className:"k-scrollview-wrap k-scrollview-animate",ref:w},D),c.createElement("div",{className:"k-scrollview-elements"},m&&c.createElement(c.Fragment,null,P()&&c.createElement("span",{className:"k-scrollview-prev","aria-label":"previous",onClick:O},c.createElement(l.IconWrap,{name:E?"chevron-right":"chevron-left",icon:E?n.chevronRightIcon:n.chevronLeftIcon,size:"xxxlarge"})),T()&&c.createElement("span",{className:"k-scrollview-next",onClick:R},c.createElement(l.IconWrap,{name:E?"chevron-left":"chevron-right",icon:E?n.chevronLeftIcon:n.chevronRightIcon,size:"xxxlarge"}))),u&&c.createElement("div",{className:"k-scrollview-nav-wrap"},c.createElement("div",{className:"k-scrollview-nav"},b.map(((e,r)=>c.createElement("span",{className:l.classNames("k-link",{"k-primary":h===r+1}),key:r+1,onClick:()=>f(r+1)})))))))}));o.propTypes={activeView:t.number,arrows:t.bool,automaticViewChange:t.bool,automaticViewChangeInterval:t.number,children:t.any,className:t.string,dir:t.string,endless:t.bool,pageable:t.bool,pageOverlay:t.string,style:t.object};o.defaultProps={activeView:1,arrows:!0,automaticViewChange:!0,automaticViewChangeInterval:5e3,endless:!1,pageable:!0,pageOverlay:"none"},o.displayName="KendoScrollView",e.ScrollView=o}));
|
package/index.d.mts
CHANGED
|
@@ -1,5 +1,117 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import * as React_2 from 'react';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Represents the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```jsx
|
|
15
|
+
* const App = () => {
|
|
16
|
+
* const items: any[] = [
|
|
17
|
+
* { position: 1, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image1.jpg' },
|
|
18
|
+
* { position: 2, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image2.jpg' },
|
|
19
|
+
* { position: 3, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image3.jpg' }
|
|
20
|
+
* ];
|
|
21
|
+
* return (
|
|
22
|
+
* <ScrollView style={{width: 512, height: 384}}>
|
|
23
|
+
* {items.map((item, index) => {
|
|
24
|
+
* return (
|
|
25
|
+
* <div className="image-with-text" key={index}>
|
|
26
|
+
* <p>Showing image {item.position} of {items.length}.</p>
|
|
27
|
+
* <img
|
|
28
|
+
* src={item.url}
|
|
29
|
+
* alt={'Photo'}
|
|
30
|
+
* style={{width: 512, height: 384}}
|
|
31
|
+
* draggable={false}
|
|
32
|
+
* />
|
|
33
|
+
* </div>
|
|
34
|
+
* );
|
|
35
|
+
* })}
|
|
36
|
+
* </ScrollView>
|
|
37
|
+
* );
|
|
38
|
+
* };
|
|
39
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const ScrollView: React_2.ForwardRefExoticComponent<ScrollViewProps & React_2.RefAttributes<ScrollViewHandle | null>>;
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* The ScrollView ref.
|
|
46
|
+
*/
|
|
47
|
+
export declare interface ScrollViewHandle {
|
|
48
|
+
/**
|
|
49
|
+
* The ScrollView element.
|
|
50
|
+
*/
|
|
51
|
+
element: HTMLDivElement | null;
|
|
52
|
+
/**
|
|
53
|
+
* Focus the ScrollView.
|
|
54
|
+
*/
|
|
55
|
+
focus: () => void;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Represents the props of the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
60
|
+
*/
|
|
61
|
+
export declare interface ScrollViewProps {
|
|
62
|
+
/**
|
|
63
|
+
* Represents the current active view ([see example]({% slug activeview_scrollview %})). Defaults to `1`.
|
|
64
|
+
*/
|
|
65
|
+
activeView?: number;
|
|
66
|
+
/**
|
|
67
|
+
* Enables or disables the built-in navigation arrows ([see example]({% slug arrows_scrollview %})). Defaults to `true`.
|
|
68
|
+
*/
|
|
69
|
+
arrows?: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* Allows the ScrollView to switch the next page automatically after a short delay ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
72
|
+
* Defaults to `true`.
|
|
73
|
+
*/
|
|
74
|
+
automaticViewChange?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Defines the automatic page change delay in milliseconds ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
77
|
+
* Defaults to `5000`.
|
|
78
|
+
*/
|
|
79
|
+
automaticViewChangeInterval?: number;
|
|
80
|
+
/**
|
|
81
|
+
* Sets the ScrollView children elements.
|
|
82
|
+
*/
|
|
83
|
+
children?: React.ReactNode;
|
|
84
|
+
/**
|
|
85
|
+
* Specifies a list of CSS classes that will be added to the ScrollView.
|
|
86
|
+
*/
|
|
87
|
+
className?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
|
|
90
|
+
*/
|
|
91
|
+
dir?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Toggles the endless scrolling mode in which the data items are endlessly looped
|
|
94
|
+
* ([see example]({% slug endlessscrolling_scrollview %})). Defaults to `false`.
|
|
95
|
+
*/
|
|
96
|
+
endless?: boolean;
|
|
97
|
+
/**
|
|
98
|
+
* Toggles the built-in pager ([see example]({% slug paging_scrollview %})). Defaults to `true`.
|
|
99
|
+
*/
|
|
100
|
+
pageable?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Sets the pager overlay ([see example]({% slug paging_scrollview %})).
|
|
103
|
+
*
|
|
104
|
+
* * The possible values are:
|
|
105
|
+
* * `none`(Default) — No overlay is set.
|
|
106
|
+
* * `dark` — Dark overlay is set.
|
|
107
|
+
* * `light` — Light overlay is set.
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
pagerOverlay?: 'dark' | 'light' | 'none';
|
|
111
|
+
/**
|
|
112
|
+
* Sets additional CSS styles to the ScrollView.
|
|
113
|
+
*/
|
|
114
|
+
style?: React.CSSProperties;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export { }
|
package/index.d.ts
CHANGED
|
@@ -1,6 +1,117 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import * as React_2 from 'react';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Represents the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```jsx
|
|
15
|
+
* const App = () => {
|
|
16
|
+
* const items: any[] = [
|
|
17
|
+
* { position: 1, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image1.jpg' },
|
|
18
|
+
* { position: 2, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image2.jpg' },
|
|
19
|
+
* { position: 3, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image3.jpg' }
|
|
20
|
+
* ];
|
|
21
|
+
* return (
|
|
22
|
+
* <ScrollView style={{width: 512, height: 384}}>
|
|
23
|
+
* {items.map((item, index) => {
|
|
24
|
+
* return (
|
|
25
|
+
* <div className="image-with-text" key={index}>
|
|
26
|
+
* <p>Showing image {item.position} of {items.length}.</p>
|
|
27
|
+
* <img
|
|
28
|
+
* src={item.url}
|
|
29
|
+
* alt={'Photo'}
|
|
30
|
+
* style={{width: 512, height: 384}}
|
|
31
|
+
* draggable={false}
|
|
32
|
+
* />
|
|
33
|
+
* </div>
|
|
34
|
+
* );
|
|
35
|
+
* })}
|
|
36
|
+
* </ScrollView>
|
|
37
|
+
* );
|
|
38
|
+
* };
|
|
39
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export declare const ScrollView: React_2.ForwardRefExoticComponent<ScrollViewProps & React_2.RefAttributes<ScrollViewHandle | null>>;
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* The ScrollView ref.
|
|
46
|
+
*/
|
|
47
|
+
export declare interface ScrollViewHandle {
|
|
48
|
+
/**
|
|
49
|
+
* The ScrollView element.
|
|
50
|
+
*/
|
|
51
|
+
element: HTMLDivElement | null;
|
|
52
|
+
/**
|
|
53
|
+
* Focus the ScrollView.
|
|
54
|
+
*/
|
|
55
|
+
focus: () => void;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Represents the props of the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
60
|
+
*/
|
|
61
|
+
export declare interface ScrollViewProps {
|
|
62
|
+
/**
|
|
63
|
+
* Represents the current active view ([see example]({% slug activeview_scrollview %})). Defaults to `1`.
|
|
64
|
+
*/
|
|
65
|
+
activeView?: number;
|
|
66
|
+
/**
|
|
67
|
+
* Enables or disables the built-in navigation arrows ([see example]({% slug arrows_scrollview %})). Defaults to `true`.
|
|
68
|
+
*/
|
|
69
|
+
arrows?: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* Allows the ScrollView to switch the next page automatically after a short delay ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
72
|
+
* Defaults to `true`.
|
|
73
|
+
*/
|
|
74
|
+
automaticViewChange?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Defines the automatic page change delay in milliseconds ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
77
|
+
* Defaults to `5000`.
|
|
78
|
+
*/
|
|
79
|
+
automaticViewChangeInterval?: number;
|
|
80
|
+
/**
|
|
81
|
+
* Sets the ScrollView children elements.
|
|
82
|
+
*/
|
|
83
|
+
children?: React.ReactNode;
|
|
84
|
+
/**
|
|
85
|
+
* Specifies a list of CSS classes that will be added to the ScrollView.
|
|
86
|
+
*/
|
|
87
|
+
className?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
|
|
90
|
+
*/
|
|
91
|
+
dir?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Toggles the endless scrolling mode in which the data items are endlessly looped
|
|
94
|
+
* ([see example]({% slug endlessscrolling_scrollview %})). Defaults to `false`.
|
|
95
|
+
*/
|
|
96
|
+
endless?: boolean;
|
|
97
|
+
/**
|
|
98
|
+
* Toggles the built-in pager ([see example]({% slug paging_scrollview %})). Defaults to `true`.
|
|
99
|
+
*/
|
|
100
|
+
pageable?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Sets the pager overlay ([see example]({% slug paging_scrollview %})).
|
|
103
|
+
*
|
|
104
|
+
* * The possible values are:
|
|
105
|
+
* * `none`(Default) — No overlay is set.
|
|
106
|
+
* * `dark` — Dark overlay is set.
|
|
107
|
+
* * `light` — Light overlay is set.
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
pagerOverlay?: 'dark' | 'light' | 'none';
|
|
111
|
+
/**
|
|
112
|
+
* Sets additional CSS styles to the ScrollView.
|
|
113
|
+
*/
|
|
114
|
+
style?: React.CSSProperties;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export { }
|
package/index.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./ScrollView.js");exports.ScrollView=e.ScrollView;
|
package/index.mjs
CHANGED
|
@@ -1,154 +1,12 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
5
8
|
"use client";
|
|
6
|
-
import
|
|
7
|
-
import r from "prop-types";
|
|
8
|
-
import { validatePackage as B, useRtl as H, Keys as N, classNames as R, IconWrap as V } from "@progress/kendo-react-common";
|
|
9
|
-
import { chevronRightIcon as I, chevronLeftIcon as D } from "@progress/kendo-svg-icons";
|
|
10
|
-
const $ = {
|
|
11
|
-
name: "@progress/kendo-react-scrollview",
|
|
12
|
-
productName: "KendoReact",
|
|
13
|
-
productCodes: ["KENDOUIREACT", "KENDOUICOMPLETE"],
|
|
14
|
-
publishDate: 1709632272,
|
|
15
|
-
version: "",
|
|
16
|
-
licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
17
|
-
}, d = e.forwardRef((f, K) => {
|
|
18
|
-
B($);
|
|
19
|
-
const {
|
|
20
|
-
className: h,
|
|
21
|
-
style: P,
|
|
22
|
-
children: k,
|
|
23
|
-
pagerOverlay: w,
|
|
24
|
-
pageable: T,
|
|
25
|
-
arrows: x,
|
|
26
|
-
endless: n,
|
|
27
|
-
activeView: O,
|
|
28
|
-
automaticViewChange: C,
|
|
29
|
-
automaticViewChangeInterval: y
|
|
30
|
-
} = f, [t, s] = e.useState(O || 1), o = e.useRef(null), m = e.useRef(null), g = e.useRef(null), a = e.Children.toArray(k), p = H(o, f.dir), c = p === "rtl", b = e.useCallback(
|
|
31
|
-
() => {
|
|
32
|
-
o.current && o.current.focus();
|
|
33
|
-
},
|
|
34
|
-
[]
|
|
35
|
-
), A = e.useCallback(
|
|
36
|
-
() => ({
|
|
37
|
-
element: o.current,
|
|
38
|
-
focus: b
|
|
39
|
-
}),
|
|
40
|
-
[b]
|
|
41
|
-
);
|
|
42
|
-
e.useImperativeHandle(K, A);
|
|
43
|
-
const u = e.useCallback(() => {
|
|
44
|
-
n ? t > 1 ? s(t - 1) : s(a.length) : t > 1 && s(t - 1);
|
|
45
|
-
}, [t, a.length, n]), v = e.useCallback(() => {
|
|
46
|
-
n ? t < a.length ? s(t + 1) : s(1) : t < a.length && s(t + 1);
|
|
47
|
-
}, [t, a.length, n]);
|
|
48
|
-
e.useEffect(() => {
|
|
49
|
-
let l = a.length;
|
|
50
|
-
m.current && (m.current.style.setProperty("--kendo-scrollview-views", `${l}`), m.current.style.setProperty("--kendo-scrollview-current", `${t}`));
|
|
51
|
-
}, [a, t, p]);
|
|
52
|
-
function E() {
|
|
53
|
-
g.current && clearTimeout(g.current);
|
|
54
|
-
}
|
|
55
|
-
e.useEffect(() => {
|
|
56
|
-
if (C)
|
|
57
|
-
return E(), g.current = setTimeout(
|
|
58
|
-
() => s((l) => l === a.length ? n ? 1 : l : l + 1),
|
|
59
|
-
y
|
|
60
|
-
), () => {
|
|
61
|
-
E();
|
|
62
|
-
};
|
|
63
|
-
}, [C, y, a.length, t, n]);
|
|
64
|
-
const L = e.useCallback(
|
|
65
|
-
(l) => {
|
|
66
|
-
switch (l.keyCode) {
|
|
67
|
-
case N.left:
|
|
68
|
-
l.preventDefault(), c ? v() : u();
|
|
69
|
-
break;
|
|
70
|
-
case N.right:
|
|
71
|
-
l.preventDefault(), c ? u() : v();
|
|
72
|
-
break;
|
|
73
|
-
}
|
|
74
|
-
},
|
|
75
|
-
[c, v, u]
|
|
76
|
-
), M = e.useMemo(
|
|
77
|
-
() => R(
|
|
78
|
-
"k-scrollview",
|
|
79
|
-
{
|
|
80
|
-
"k-scrollview-light": w === "light",
|
|
81
|
-
"k-scrollview-dark": w === "dark"
|
|
82
|
-
},
|
|
83
|
-
h
|
|
84
|
-
),
|
|
85
|
-
[h, w]
|
|
86
|
-
), S = e.Children.map(k || null, (l, i) => /* @__PURE__ */ e.createElement(
|
|
87
|
-
"div",
|
|
88
|
-
{
|
|
89
|
-
className: "k-scrollview-view",
|
|
90
|
-
"aria-hidden": t !== i + 1
|
|
91
|
-
},
|
|
92
|
-
l
|
|
93
|
-
)), U = e.useCallback(() => {
|
|
94
|
-
let l;
|
|
95
|
-
return l = t > 1, (n || l) && a.length > 0;
|
|
96
|
-
}, [t, a.length, n]), z = e.useCallback(() => {
|
|
97
|
-
let l;
|
|
98
|
-
return l = t < a.length, (n || l) && a.length > 0;
|
|
99
|
-
}, [t, a.length, n]);
|
|
100
|
-
return /* @__PURE__ */ e.createElement("div", { className: M, style: P, ref: o, tabIndex: 0, dir: p, onKeyDown: L }, /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-wrap k-scrollview-animate", ref: m }, S), /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-elements" }, x && /* @__PURE__ */ e.createElement(e.Fragment, null, U() && /* @__PURE__ */ e.createElement("span", { className: "k-scrollview-prev", "aria-label": "previous", onClick: u }, /* @__PURE__ */ e.createElement(
|
|
101
|
-
V,
|
|
102
|
-
{
|
|
103
|
-
name: c ? "chevron-right" : "chevron-left",
|
|
104
|
-
icon: c ? I : D,
|
|
105
|
-
size: "xxxlarge"
|
|
106
|
-
}
|
|
107
|
-
)), z() && /* @__PURE__ */ e.createElement("span", { className: "k-scrollview-next", onClick: v }, /* @__PURE__ */ e.createElement(
|
|
108
|
-
V,
|
|
109
|
-
{
|
|
110
|
-
name: c ? "chevron-left" : "chevron-right",
|
|
111
|
-
icon: c ? D : I,
|
|
112
|
-
size: "xxxlarge"
|
|
113
|
-
}
|
|
114
|
-
))), T && /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-nav-wrap" }, /* @__PURE__ */ e.createElement("div", { className: "k-scrollview-nav" }, a.map((l, i) => /* @__PURE__ */ e.createElement(
|
|
115
|
-
"span",
|
|
116
|
-
{
|
|
117
|
-
className: R(
|
|
118
|
-
"k-link",
|
|
119
|
-
{
|
|
120
|
-
"k-primary": t === i + 1
|
|
121
|
-
}
|
|
122
|
-
),
|
|
123
|
-
key: i + 1,
|
|
124
|
-
onClick: () => s(i + 1)
|
|
125
|
-
}
|
|
126
|
-
))))));
|
|
127
|
-
});
|
|
128
|
-
d.propTypes = {
|
|
129
|
-
activeView: r.number,
|
|
130
|
-
arrows: r.bool,
|
|
131
|
-
automaticViewChange: r.bool,
|
|
132
|
-
automaticViewChangeInterval: r.number,
|
|
133
|
-
children: r.any,
|
|
134
|
-
className: r.string,
|
|
135
|
-
dir: r.string,
|
|
136
|
-
endless: r.bool,
|
|
137
|
-
pageable: r.bool,
|
|
138
|
-
pageOverlay: r.string,
|
|
139
|
-
style: r.object
|
|
140
|
-
};
|
|
141
|
-
const j = {
|
|
142
|
-
activeView: 1,
|
|
143
|
-
arrows: !0,
|
|
144
|
-
automaticViewChange: !0,
|
|
145
|
-
automaticViewChangeInterval: 5e3,
|
|
146
|
-
endless: !1,
|
|
147
|
-
pageable: !0,
|
|
148
|
-
pageOverlay: "none"
|
|
149
|
-
};
|
|
150
|
-
d.defaultProps = j;
|
|
151
|
-
d.displayName = "KendoScrollView";
|
|
9
|
+
import { ScrollView as o } from "./ScrollView.mjs";
|
|
152
10
|
export {
|
|
153
|
-
|
|
11
|
+
o as ScrollView
|
|
154
12
|
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-react-scrollview",productName:"KendoReact",productCodes:["KENDOUIREACT","KENDOUICOMPLETE"],publishDate:0,version:"",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};exports.packageMetadata=e;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
"use client";
|
|
9
|
+
const e = {
|
|
10
|
+
name: "@progress/kendo-react-scrollview",
|
|
11
|
+
productName: "KendoReact",
|
|
12
|
+
productCodes: ["KENDOUIREACT", "KENDOUICOMPLETE"],
|
|
13
|
+
publishDate: 1709714525,
|
|
14
|
+
version: "",
|
|
15
|
+
licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
16
|
+
};
|
|
17
|
+
export {
|
|
18
|
+
e as packageMetadata
|
|
19
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progress/kendo-react-scrollview",
|
|
3
|
-
"version": "7.2.4-develop.
|
|
3
|
+
"version": "7.2.4-develop.4",
|
|
4
4
|
"description": "React ScrollView (React Carousel) displays images or content in a horizontally scrollable collection. KendoReact ScrollView package",
|
|
5
5
|
"author": "Progress",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"sideEffects": false,
|
|
24
24
|
"peerDependencies": {
|
|
25
25
|
"@progress/kendo-licensing": "^1.3.4",
|
|
26
|
-
"@progress/kendo-react-common": "7.2.4-develop.
|
|
26
|
+
"@progress/kendo-react-common": "7.2.4-develop.4",
|
|
27
27
|
"@progress/kendo-svg-icons": "^2.1.0",
|
|
28
28
|
"react": "^16.8.2 || ^17.0.0 || ^18.0.0",
|
|
29
29
|
"react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0"
|
package/ScrollView.d.ts
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
/**-----------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
3
|
-
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
4
|
-
*-------------------------------------------------------------------------------------------*/
|
|
5
|
-
import * as React from 'react';
|
|
6
|
-
import { ScrollViewProps } from './ScrollViewProps';
|
|
7
|
-
/**
|
|
8
|
-
* The ScrollView ref.
|
|
9
|
-
*/
|
|
10
|
-
export interface ScrollViewHandle {
|
|
11
|
-
/**
|
|
12
|
-
* The ScrollView element.
|
|
13
|
-
*/
|
|
14
|
-
element: HTMLDivElement | null;
|
|
15
|
-
/**
|
|
16
|
-
* Focus the ScrollView.
|
|
17
|
-
*/
|
|
18
|
-
focus: () => void;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Represents the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```jsx
|
|
25
|
-
* const App = () => {
|
|
26
|
-
* const items: any[] = [
|
|
27
|
-
* { position: 1, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image1.jpg' },
|
|
28
|
-
* { position: 2, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image2.jpg' },
|
|
29
|
-
* { position: 3, url: 'https://demos.telerik.com/kendo-ui/content/web/scrollview/image3.jpg' }
|
|
30
|
-
* ];
|
|
31
|
-
* return (
|
|
32
|
-
* <ScrollView style={{width: 512, height: 384}}>
|
|
33
|
-
* {items.map((item, index) => {
|
|
34
|
-
* return (
|
|
35
|
-
* <div className="image-with-text" key={index}>
|
|
36
|
-
* <p>Showing image {item.position} of {items.length}.</p>
|
|
37
|
-
* <img
|
|
38
|
-
* src={item.url}
|
|
39
|
-
* alt={'Photo'}
|
|
40
|
-
* style={{width: 512, height: 384}}
|
|
41
|
-
* draggable={false}
|
|
42
|
-
* />
|
|
43
|
-
* </div>
|
|
44
|
-
* );
|
|
45
|
-
* })}
|
|
46
|
-
* </ScrollView>
|
|
47
|
-
* );
|
|
48
|
-
* };
|
|
49
|
-
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
50
|
-
* ```
|
|
51
|
-
*/
|
|
52
|
-
export declare const ScrollView: React.ForwardRefExoticComponent<ScrollViewProps & React.RefAttributes<ScrollViewHandle | null>>;
|
package/ScrollViewProps.d.ts
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
/**-----------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
3
|
-
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
4
|
-
*-------------------------------------------------------------------------------------------*/
|
|
5
|
-
/**
|
|
6
|
-
* Represents the props of the [KendoReact ScrollView component]({% slug overview_scrollview %}).
|
|
7
|
-
*/
|
|
8
|
-
export interface ScrollViewProps {
|
|
9
|
-
/**
|
|
10
|
-
* Represents the current active view ([see example]({% slug activeview_scrollview %})). Defaults to `1`.
|
|
11
|
-
*/
|
|
12
|
-
activeView?: number;
|
|
13
|
-
/**
|
|
14
|
-
* Enables or disables the built-in navigation arrows ([see example]({% slug arrows_scrollview %})). Defaults to `true`.
|
|
15
|
-
*/
|
|
16
|
-
arrows?: boolean;
|
|
17
|
-
/**
|
|
18
|
-
* Allows the ScrollView to switch the next page automatically after a short delay ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
19
|
-
* Defaults to `true`.
|
|
20
|
-
*/
|
|
21
|
-
automaticViewChange?: boolean;
|
|
22
|
-
/**
|
|
23
|
-
* Defines the automatic page change delay in milliseconds ([see example]({% slug automatic_scrolling_scrollview %})).
|
|
24
|
-
* Defaults to `5000`.
|
|
25
|
-
*/
|
|
26
|
-
automaticViewChangeInterval?: number;
|
|
27
|
-
/**
|
|
28
|
-
* Sets the ScrollView children elements.
|
|
29
|
-
*/
|
|
30
|
-
children?: React.ReactNode;
|
|
31
|
-
/**
|
|
32
|
-
* Specifies a list of CSS classes that will be added to the ScrollView.
|
|
33
|
-
*/
|
|
34
|
-
className?: string;
|
|
35
|
-
/**
|
|
36
|
-
* Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
|
|
37
|
-
*/
|
|
38
|
-
dir?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Toggles the endless scrolling mode in which the data items are endlessly looped
|
|
41
|
-
* ([see example]({% slug endlessscrolling_scrollview %})). Defaults to `false`.
|
|
42
|
-
*/
|
|
43
|
-
endless?: boolean;
|
|
44
|
-
/**
|
|
45
|
-
* Toggles the built-in pager ([see example]({% slug paging_scrollview %})). Defaults to `true`.
|
|
46
|
-
*/
|
|
47
|
-
pageable?: boolean;
|
|
48
|
-
/**
|
|
49
|
-
* Sets the pager overlay ([see example]({% slug paging_scrollview %})).
|
|
50
|
-
*
|
|
51
|
-
* * The possible values are:
|
|
52
|
-
* * `none`(Default) — No overlay is set.
|
|
53
|
-
* * `dark` — Dark overlay is set.
|
|
54
|
-
* * `light` — Light overlay is set.
|
|
55
|
-
*
|
|
56
|
-
*/
|
|
57
|
-
pagerOverlay?: 'dark' | 'light' | 'none';
|
|
58
|
-
/**
|
|
59
|
-
* Sets additional CSS styles to the ScrollView.
|
|
60
|
-
*/
|
|
61
|
-
style?: React.CSSProperties;
|
|
62
|
-
}
|
package/package-metadata.d.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
/**-----------------------------------------------------------------------------------------
|
|
2
|
-
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
3
|
-
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
4
|
-
*-------------------------------------------------------------------------------------------*/
|
|
5
|
-
import { PackageMetadata } from '@progress/kendo-licensing';
|
|
6
|
-
/**
|
|
7
|
-
* @hidden
|
|
8
|
-
*/
|
|
9
|
-
export declare const packageMetadata: PackageMetadata;
|