@progress/kendo-vue-scrollview 5.3.0-dev.202409130647 → 5.3.0-develop.1

package/README.md

@@ -1,39 +1,46 @@
-<a href="https://www.telerik.com/kendo-vue-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview&utm_content=banner" target="_blank">
+<a href="https://www.telerik.com/kendo-vue-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-utils&utm_content=banner" target="_blank">
 <img src="https://www.telerik.com/kendo-vue-ui/npm-banner.svg" alt="Kendo UI for Vue NPM Banner">
 </a>
 
-
-# Kendo UI for Vue ScrollView Component for Vue
+## Kendo UI for Vue Scrollview Package for Vue
 
 > **Important**
-> * This package is а part of [Kendo UI for Vue](https://www.telerik.com/kendo-vue-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)&mdash;a commercial UI library.
-> * You will need to install a license key when adding the package to your project. For more information, please refer to the [Kendo UI for Vue My License page](https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview).
-> * To receive a license key, you need to either [purchase a license](https://www.telerik.com/purchase/kendo-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview) or register for a [free trial](https://www.telerik.com/try/kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview). Doing so indicates that you [accept the Kendo UI for Vue License Agreement](https://www.telerik.com/purchase/license-agreement/progress-kendovue?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview).
-> * The 30-day free trial gives you access to all the Kendo UI for Vue components and their full functionality. Additionally, for the period of your license, you get access to our legendary technical support provided directly by the Kendo UI for Vue dev team!
 >
-> [Start using Kendo UI for Vue](https://www.telerik.com/try/kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview) and speed up your development process!
+> -   This package is а part of [Kendo UI for Vue](https://www.telerik.com/kendo-vue-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)&mdash;a commercial UI library.
+> -   You will need to install a license key when adding the package to your project. For more information, please refer to the [Kendo UI for Vue My License page](https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview).
+> -   To receive a license key, you need to either [purchase a license](https://www.telerik.com/purchase/kendo-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview) or register for a [free trial](https://www.telerik.com/download-login-v2-kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview). Doing so indicates that you [accept the Kendo UI for Vue License Agreement](https://www.telerik.com/kendo-vue-ui-develop/my-license/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview).
+> -   The 30-day free trial gives you access to all the Kendo UI for Vue components and their full functionality. Additionally, for the period of your license, you get access to our legendary technical support provided directly by the Kendo UI for Vue dev team!
+>
+> [Start using Kendo UI for Vue](https://www.telerik.com/download-login-v2-kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview) and speed up your development process!
+
+## Vue Scrollview
 
 > Historically, all Kendo UI for Vue Native components support both **Vue 2** and **Vue 3**, however, Vue 2 is currently in its end-of-support phase till Nov 2024. After our last major release for 2024, Vue 2 will no longer be supported in the new versions of the Kendo UI for Vue components. Please check our [Vue 2 End of Support article](https://www.telerik.com/kendo-vue-ui/components/vue2-deprecation/) for more details.
 
+Among the many features which the Kendo UI for Vue Scrollview deliver are:
+
+-   TODO 1
+-   TODO 2
+-   TODO 3
+
 ## Support Options
 
-For any issues you might encounter while working with the Kendo UI for Vue ScrollView, use any of the available support channels:
+For any issues you might encounter while working with the Kendo UI for Vue Scrollview, use any of the available support channels:
 
-* Industry-leading technical support&mdash;Kendo UI for Vue paid license holders and users with an active (free) trial license can take advantage of our outstanding customer support. To submit a ticket, use [the dedicated Kendo UI for Vue support system](https://www.telerik.com/account/support-tickets?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview).
-* Product forums&mdash;The [Kendo UI for Vue forums](https://www.telerik.com/forums/kendo-ui-vue?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview) are part of the free support you can get from the community and from the Kendo UI for Vue team.
-* Feedback portal&mdash;The [Kendo UI for Vue feedback portal](https://feedback.telerik.com/kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview) is where you can request and vote for new features to be added.
+-   Industry-leading technical support&mdash;Kendo UI for Vue paid license holders and users with an active (free) trial license can take advantage of our outstanding customer support. To submit a ticket, use [the dedicated Kendo UI for Vue support system](https://www.telerik.com/account/support-tickets?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview).
+-   Product forums&mdash;The [Kendo UI for Vue forums](https://www.telerik.com/forums/kendo-ui-vue?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview) are part of the free support you can get from the community and from the Kendo UI for Vue team.
+-   Feedback portal&mdash;The [Kendo UI for Vue feedback portal](https://feedback.telerik.com/kendo-vue-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview) is where you can request and vote for new features to be added.
 
 ## Resources
 
-* [Getting Started with Kendo UI for Vue](https://www.telerik.com/kendo-vue-ui/getting-started/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Get Started with the Kendo UI for Vue ScrollView](https://www.telerik.com/kendo-vue-ui/components/scrollview/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [API Reference of the Kendo UI for Vue ScrollView](https://www.telerik.com/kendo-vue-ui/components/scrollview/api/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Kendo UI for Vue Roadmap](https://www.telerik.com/support/whats-new/kendo-vue-ui/roadmap?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Blogs](https://www.telerik.com/blogs/tag/vue?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Demos, documentation, and component reference](https://www.telerik.com/kendo-vue-ui/components/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Kendo UI for Vue pricing and licensing](https://www.telerik.com/purchase/kendo-ui/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
-* [Changelog](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npm-scrollview)
+-   [Getting Started with Kendo UI for Vue](https://www.telerik.com/kendo-vue-ui/getting-started/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [Getting Started with the Kendo UI for Vue Scrollview](https://www.telerik.com/kendo-vue-ui/components/scrollview/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [API Reference of the Kendo UI for Vue Scrollview](https://www.telerik.com/kendo-vue-ui/components/scrollview/api/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [Kendo UI for Vue Roadmap](https://www.telerik.com/kendo-vue-ui/roadmap/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [Blogs](https://www.telerik.com/blogs/tag/vue?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [Demos, documentation, and component reference](https://www.telerik.com/kendo-vue-ui/components/?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
+-   [Kendo UI for Vue pricing and licensing](https://www.telerik.com/purchase/kendo-ui?utm_medium=referral&utm_source=npm&utm_campaign=kendo-ui-vue-trial-npmscrollview)
 
-*Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.*
+_Copyright © 2024 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved._
 
-*Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries.*
+_Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries._

package/ScrollView.js

@@ -0,0 +1,8 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("vue"),i=require("@progress/kendo-vue-common"),v=require("./package-metadata.js"),l=require("@progress/kendo-svg-icons"),u=t.defineComponent({name:"KendoScrollView",props:{activeView:{type:Number,default:1},dataItems:{type:Array,default:function(){return[]}},arrows:{type:Boolean,default:!0},automaticViewChange:{type:Boolean,default:!0},automaticViewChangeInterval:{type:Number,default:5e3},content:[Object,String,Function],dir:String,endless:Boolean,pageable:{type:Boolean,default:!0},pagerOverlay:{type:String,default:"none"}},created(){i.validatePackage(v.packageMetadata),this.timeoutRef=null},mounted(){this.wrapElement=i.getRef(this,"wrapElement"),this.currentDir=this.$props.dir!==void 0?this.$props.dir:i.isRtl(this.$el)?"rtl":"ltr",this.runAutomaticChange()},updated(){const e=this.dataItems.length;this.wrapElement&&(this.wrapElement.style.setProperty("--kendo-scrollview-views",`${e}`),this.wrapElement.style.setProperty("--kendo-scrollview-current",`${this.active}`)),this.runAutomaticChange()},data(){return{active:this.activeView||1,currentDir:void 0}},computed:{scrollViewClasses(){return{"k-scrollview":!0,"k-scrollview-light":this.pagerOverlay==="light","k-scrollview-dark":this.pagerOverlay==="dark"}},displayLeftArrow(){let e;return this.isRtl?e=this.active<this.dataItems.length:e=this.active>1,(this.endless||e)&&this.dataItems.length>0},displayRightArrow(){let e;return this.isRtl?e=this.active>1:e=this.active<this.dataItems.length,(this.endless||e)&&this.dataItems.length>0},isRtl(){return this.currentDir==="rtl"}},render(){const{pageable:e,arrows:s,content:n}=this.$props,c=this.dataItems.length,o=this.dataItems.map(function(r,a){const h=i.templateRendering.call(this,r.content||n,i.getListeners.call(this)),d=i.getTemplate.call(this,{h:t.h,template:h,defaultRendering:null,additionalProps:{item:r,items:this.dataItems}});return t.createVNode("div",{class:"k-scrollview-view","aria-hidden":this.active!==a+1},[d])},this);return t.createVNode("div",{class:this.scrollViewClasses,tabindex:0,dir:this.currentDir,onKeydown:this.handleKeyDown},[t.createVNode("div",{class:"k-scrollview-wrap k-scrollview-animate",style:`--kendo-scrollview-views:${c}; --kendo-scrollview-current:${this.active};`,ref:i.setRef(this,"wrapElement")},[o]),t.createVNode("div",{class:"k-scrollview-elements"},[s&&[this.displayLeftArrow&&t.createVNode("span",{class:"k-scrollview-prev","aria-label":"previous",onClick:this.handlePrevClick},[t.createVNode(i.Icon,{name:this.isRtl?"chevron-right":"chevron-left",icon:this.isRtl?l.chevronRightIcon:l.chevronLeftIcon,size:"xxxlarge"},null)]),this.displayRightArrow&&t.createVNode("span",{class:"k-scrollview-next","aria-label":"next",onClick:this.handleNextClick},[t.createVNode(i.Icon,{name:this.isRtl?"chevron-left":"chevron-right",icon:this.isRtl?l.chevronLeftIcon:l.chevronRightIcon,size:"xxxlarge"},null)])],e&&t.createVNode("div",{class:"k-scrollview-nav-wrap"},[t.createVNode("ul",{class:"k-scrollview-nav"},[this.dataItems.map(function(r,a){return t.createVNode("li",{class:i.classNames("k-link",{"k-primary":this.active===a+1}),key:a+1,onClick:()=>this.setActive(a+1)},null)},this)])])])])},methods:{runAutomaticChange(){if(this.automaticViewChange){this.resetTimeout();const e=this,s=this.active;this.timeoutRef=setTimeout(function(){e.setActive(s===e.dataItems.length?e.endless?1:s:s+1)},this.automaticViewChangeInterval)}},resetTimeout(){this.timeoutRef&&clearTimeout(this.timeoutRef)},setActive(e){this.active=e},focusElement(){this.$el&&this.$el.focus()},prev(){this.endless?this.active>1?this.setActive(this.active-1):this.setActive(this.dataItems.length):this.active>1&&this.setActive(this.active-1)},next(){this.endless?this.active<this.dataItems.length?this.setActive(this.active+1):this.setActive(1):this.active<this.dataItems.length&&this.setActive(this.active+1)},handlePrevClick(){this.isRtl?this.next():this.prev()},handleNextClick(){this.isRtl?this.prev():this.next()},handleKeyDown(e){switch(e.keyCode){case i.Keys.left:e.preventDefault(),this.isRtl?this.next():this.prev();break;case i.Keys.right:e.preventDefault(),this.isRtl?this.prev():this.next();break}}}});exports.ScrollView=u;

package/ScrollView.mjs

@@ -0,0 +1,191 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { defineComponent as m, h as p, createVNode as e } from "vue";
+import { validatePackage as f, getRef as w, isRtl as g, templateRendering as k, getListeners as y, getTemplate as R, setRef as I, Icon as l, classNames as C, Keys as r } from "@progress/kendo-vue-common";
+import { packageMetadata as A } from "./package-metadata.mjs";
+import { chevronRightIcon as n, chevronLeftIcon as h } from "@progress/kendo-svg-icons";
+const D = /* @__PURE__ */ m({
+  name: "KendoScrollView",
+  props: {
+    activeView: {
+      type: Number,
+      default: 1
+    },
+    dataItems: {
+      type: Array,
+      default: function() {
+        return [];
+      }
+    },
+    arrows: {
+      type: Boolean,
+      default: !0
+    },
+    automaticViewChange: {
+      type: Boolean,
+      default: !0
+    },
+    automaticViewChangeInterval: {
+      type: Number,
+      default: 5e3
+    },
+    content: [Object, String, Function],
+    dir: String,
+    endless: Boolean,
+    pageable: {
+      type: Boolean,
+      default: !0
+    },
+    pagerOverlay: {
+      type: String,
+      default: "none"
+    }
+  },
+  created() {
+    f(A), this.timeoutRef = null;
+  },
+  mounted() {
+    this.wrapElement = w(this, "wrapElement"), this.currentDir = this.$props.dir !== void 0 ? this.$props.dir : g(this.$el) ? "rtl" : "ltr", this.runAutomaticChange();
+  },
+  updated() {
+    const t = this.dataItems.length;
+    this.wrapElement && (this.wrapElement.style.setProperty("--kendo-scrollview-views", `${t}`), this.wrapElement.style.setProperty("--kendo-scrollview-current", `${this.active}`)), this.runAutomaticChange();
+  },
+  data() {
+    return {
+      active: this.activeView || 1,
+      currentDir: void 0
+    };
+  },
+  computed: {
+    scrollViewClasses() {
+      return {
+        "k-scrollview": !0,
+        "k-scrollview-light": this.pagerOverlay === "light",
+        "k-scrollview-dark": this.pagerOverlay === "dark"
+      };
+    },
+    displayLeftArrow() {
+      let t;
+      return this.isRtl ? t = this.active < this.dataItems.length : t = this.active > 1, (this.endless || t) && this.dataItems.length > 0;
+    },
+    displayRightArrow() {
+      let t;
+      return this.isRtl ? t = this.active > 1 : t = this.active < this.dataItems.length, (this.endless || t) && this.dataItems.length > 0;
+    },
+    isRtl() {
+      return this.currentDir === "rtl";
+    }
+  },
+  render() {
+    const {
+      pageable: t,
+      arrows: i,
+      content: o
+    } = this.$props, c = this.dataItems.length, d = this.dataItems.map(function(a, s) {
+      const v = k.call(this, a.content || o, y.call(this)), u = R.call(this, {
+        h: p,
+        template: v,
+        defaultRendering: null,
+        additionalProps: {
+          item: a,
+          items: this.dataItems
+        }
+      });
+      return e("div", {
+        class: "k-scrollview-view",
+        "aria-hidden": this.active !== s + 1
+      }, [u]);
+    }, this);
+    return e("div", {
+      class: this.scrollViewClasses,
+      tabindex: 0,
+      dir: this.currentDir,
+      onKeydown: this.handleKeyDown
+    }, [e("div", {
+      class: "k-scrollview-wrap k-scrollview-animate",
+      style: `--kendo-scrollview-views:${c}; --kendo-scrollview-current:${this.active};`,
+      ref: I(this, "wrapElement")
+    }, [d]), e("div", {
+      class: "k-scrollview-elements"
+    }, [i && [this.displayLeftArrow && e("span", {
+      class: "k-scrollview-prev",
+      "aria-label": "previous",
+      onClick: this.handlePrevClick
+    }, [e(l, {
+      name: this.isRtl ? "chevron-right" : "chevron-left",
+      icon: this.isRtl ? n : h,
+      size: "xxxlarge"
+    }, null)]), this.displayRightArrow && e("span", {
+      class: "k-scrollview-next",
+      "aria-label": "next",
+      onClick: this.handleNextClick
+    }, [e(l, {
+      name: this.isRtl ? "chevron-left" : "chevron-right",
+      icon: this.isRtl ? h : n,
+      size: "xxxlarge"
+    }, null)])], t && e("div", {
+      class: "k-scrollview-nav-wrap"
+    }, [e("ul", {
+      class: "k-scrollview-nav"
+    }, [this.dataItems.map(function(a, s) {
+      return e("li", {
+        class: C("k-link", {
+          "k-primary": this.active === s + 1
+        }),
+        key: s + 1,
+        onClick: () => this.setActive(s + 1)
+      }, null);
+    }, this)])])])]);
+  },
+  methods: {
+    runAutomaticChange() {
+      if (this.automaticViewChange) {
+        this.resetTimeout();
+        const t = this, i = this.active;
+        this.timeoutRef = setTimeout(function() {
+          t.setActive(i === t.dataItems.length ? t.endless ? 1 : i : i + 1);
+        }, this.automaticViewChangeInterval);
+      }
+    },
+    resetTimeout() {
+      this.timeoutRef && clearTimeout(this.timeoutRef);
+    },
+    setActive(t) {
+      this.active = t;
+    },
+    focusElement() {
+      this.$el && this.$el.focus();
+    },
+    prev() {
+      this.endless ? this.active > 1 ? this.setActive(this.active - 1) : this.setActive(this.dataItems.length) : this.active > 1 && this.setActive(this.active - 1);
+    },
+    next() {
+      this.endless ? this.active < this.dataItems.length ? this.setActive(this.active + 1) : this.setActive(1) : this.active < this.dataItems.length && this.setActive(this.active + 1);
+    },
+    handlePrevClick() {
+      this.isRtl ? this.next() : this.prev();
+    },
+    handleNextClick() {
+      this.isRtl ? this.prev() : this.next();
+    },
+    handleKeyDown(t) {
+      switch (t.keyCode) {
+        case r.left:
+          t.preventDefault(), this.isRtl ? this.next() : this.prev();
+          break;
+        case r.right:
+          t.preventDefault(), this.isRtl ? this.prev() : this.next();
+          break;
+      }
+    }
+  }
+});
+export {
+  D as ScrollView
+};