@progress/kendo-vue-dropdowns 3.10.2 → 3.11.0-dev.202305230751

package/dist/es/DropDownList/DropDownList.js

@@ -25,6 +25,7 @@ import { ListFilter } from '../common/ListFilter';
 import { ListDefaultItem } from '../common/ListDefaultItem';
 import { List } from '../common/List';
 import DropDownBase from '../common/DropDownBase';
+import { GroupStickyHeader } from '../common/GroupStickyHeader';
 import { selectButton, messages } from '../messages/main';
 import { provideLocalizationService } from '@progress/kendo-vue-intl';
 import { isPresent, getItemValue, sameCharsOnly, shuffleData, matchText, areSame, preventDefaultNonInputs, getFocusedItem } from '../common/utils';
@@ -127,6 +128,8 @@ var DropDownListVue2 = {
       }
     },
     itemRender: [String, Function, Object],
+    groupHeaderItemRender: [String, Function, Object],
+    groupStickyHeaderItemRender: [String, Function, Object],
     listNoDataRender: [String, Function, Object],
     focusedItemIndex: Function,
     header: [String, Function, Object],
@@ -163,6 +166,9 @@ var DropDownListVue2 = {
       validator: function validator(value) {
         return ['small', 'medium', 'large'].includes(value);
       }
+    },
+    groupField: {
+      type: String
     }
   },
   inject: {
@@ -183,7 +189,10 @@ var DropDownListVue2 = {
       },
       _skipFocusEvent: false,
       valueDuringOnChange: {},
-      _navigated: false
+      _navigated: false,
+      group: undefined,
+      isScrolling: false,
+      itemHeight: 0
     };
   },
   watch: {
@@ -234,11 +243,14 @@ var DropDownListVue2 = {
     this.setValidity();
   },
   updated: function updated() {
-    var _a = this.$props,
-      _b = _a.dataItems,
-      dataItems = _b === void 0 ? [] : _b,
-      dataItemKey = _a.dataItemKey,
-      virtual = _a.virtual;
+    var _a;
+    var _b = this.$props,
+      _c = _b.dataItems,
+      dataItems = _c === void 0 ? [] : _c,
+      dataItemKey = _b.dataItemKey,
+      virtual = _b.virtual,
+      groupField = _b.groupField,
+      textField = _b.textField;
     var opened = this.$props.opened !== undefined ? this.$props.opened : this.currentOpened;
     var prevOpened = this.prevOpened !== undefined ? this.prevOpened : this.prevCurrentOpened;
     var opening = !prevOpened && opened;
@@ -282,11 +294,19 @@ var DropDownListVue2 = {
       var selectedItemIndex = dataItems.findIndex(function (i) {
         return areSame(i, selectedItem_1, dataItemKey);
       });
+      // Needed to calculate the proper item index when in grouping mode
+      if (groupField) {
+        selectedItemIndex = (_a = this.base.getGroupedDataModernMode(dataItems, groupField)) === null || _a === void 0 ? void 0 : _a.indexOf(selectedItem_1);
+      }
       var selectedItemChanged = !areSame(prevSelectedItem, selectedItem_1, dataItemKey);
       if (opening && virtual) {
         this.base.scrollToVirtualItem(virtual, selectedItemIndex);
         this.prevCurrentOpened = true;
       } else if (opening && !virtual) {
+        // Resets the sticky header group value for scenarios with open/close of component's popup
+        if (dataItems && dataItems.length !== 0) {
+          this.base.resetGroupStickyHeader(dataItems[0][groupField], this);
+        }
         this.base.scrollToItem(selectedItemIndex);
         this.prevCurrentOpened = true;
       } else if (opened && prevOpened && selectedItem_1 && selectedItemChanged && !this._navigated) {
@@ -487,6 +507,9 @@ var DropDownListVue2 = {
       }
     },
     handleKeyDown: function handleKeyDown(event) {
+      if (this.isScrolling) {
+        this.isScrolling = false;
+      }
       var _a = this.$props,
         _b = _a.dataItems,
         dataItems = _b === void 0 ? [] : _b,
@@ -611,6 +634,8 @@ var DropDownListVue2 = {
         state.data.currentText = event.target.value;
       }
       this.base.filterChanged(event.target.value, state);
+      // Used to reset the value of the StickyHeader when filtering the data
+      state.data.group = undefined;
       this.applyState(state);
     },
     onPopupOpened: function onPopupOpened() {
@@ -682,6 +707,39 @@ var DropDownListVue2 = {
     },
     repositionPopup: function repositionPopup() {
       this.base.repositionPopup();
+    },
+    onScroll: function onScroll(event) {
+      this.isScrolling = true;
+      var _a = this.base,
+        vs = _a.vs,
+        list = _a.list;
+      vs.scrollHandler(event);
+      var state = this.base.initState();
+      var groupField = this.$props.groupField;
+      var _b = this.$props.dataItems,
+        dataItems = _b === void 0 ? [] : _b;
+      if (!groupField || !dataItems.length) {
+        return;
+      }
+      var itemHeight = this.itemHeight = this.itemHeight || (vs.enabled ? vs.itemHeight : list ? list.children[0].offsetHeight : 0);
+      var target = event.target;
+      var scrollTop = target.scrollTop - vs.skip * itemHeight;
+      if (groupField) {
+        dataItems = this.base.getGroupedDataModernMode(dataItems, groupField);
+      }
+      var group = dataItems[0][groupField];
+      for (var i = 1; i < dataItems.length; i++) {
+        if (itemHeight * i > scrollTop) {
+          break;
+        }
+        if (dataItems[i] && dataItems[i][groupField]) {
+          group = dataItems[i][groupField];
+        }
+      }
+      if (group !== this.group) {
+        state.data.group = group;
+        this.applyState(state);
+      }
     }
   },
   render: function render(createElement) {
@@ -799,11 +857,18 @@ var DropDownListVue2 = {
     };
     var renderList = function renderList() {
       var _this2 = this;
-      var textField = this.$props.textField;
+      var _a = this.$props,
+        textField = _a.textField,
+        groupField = _a.groupField;
+      var dataItemsToRender = this.$props.dataItems || [];
       var itemRender = templateRendering.call(this, this.$props.itemRender, getListeners.call(this));
+      var groupHeaderItemRender = templateRendering.call(this, this.$props.groupHeaderItemRender, getListeners.call(this));
       var listNoDataRender = templateRendering.call(this, this.$props.listNoDataRender, getListeners.call(this));
       var skip = virtual.skip;
       var translate = "translateY(".concat(vs.translate, "px)");
+      if (groupField) {
+        dataItemsToRender = this.base.getGroupedDataModernMode(dataItemsToRender, groupField);
+      }
       return (
         // @ts-ignore  function children
         h(List, {
@@ -811,7 +876,7 @@ var DropDownListVue2 = {
           attrs: this.v3 ? undefined : {
             id: this.base.listBoxId,
             show: opened,
-            dataItems: dataItems.slice(),
+            dataItems: dataItemsToRender.slice(),
             focusedIndex: this.focusedIndex(),
             value: this.computedValue(),
             textField: textField,
@@ -826,10 +891,12 @@ var DropDownListVue2 = {
             } : undefined,
             skip: skip,
             itemRender: itemRender,
-            noDataRender: listNoDataRender
+            groupHeaderItemRender: groupHeaderItemRender,
+            noDataRender: listNoDataRender,
+            groupField: groupField
           },
           show: opened,
-          dataItems: dataItems.slice(),
+          dataItems: dataItemsToRender.slice(),
           focusedIndex: this.focusedIndex(),
           value: this.computedValue(),
           textField: textField,
@@ -848,11 +915,13 @@ var DropDownListVue2 = {
           onListclick: this.handleItemClick,
           on: this.v3 ? undefined : {
             "listclick": this.handleItemClick,
-            "scroll": vs.scrollHandler
+            "scroll": this.onScroll
           },
           itemRender: itemRender,
+          groupHeaderItemRender: groupHeaderItemRender,
           noDataRender: listNoDataRender,
-          onScroll: vs.scrollHandler
+          groupField: groupField,
+          onScroll: this.onScroll
         }, this.v3 ? function () {
           return [renderScrollElement.call(_this2)];
         } : [renderScrollElement.call(_this2)])
@@ -893,6 +962,7 @@ var DropDownListVue2 = {
       var _a;
       var headerTemplate = templateRendering.call(this, this.$props.header, getListeners.call(this));
       var footerTemplate = templateRendering.call(this, this.$props.footer, getListeners.call(this));
+      var groupStickyHeaderTemplate = templateRendering.call(this, this.$props.groupStickyHeaderItemRender, getListeners.call(this));
       var header = getTemplate.call(this, {
         h: h,
         template: headerTemplate
@@ -902,6 +972,9 @@ var DropDownListVue2 = {
         template: footerTemplate
       });
       var popupWidth = popupSettings.width !== undefined ? popupSettings.width : base.popupWidth;
+      if (this.group === undefined && this.$props.groupField !== undefined) {
+        this.group = getItemValue(dataItems[0], this.$props.groupField);
+      }
       return (
         // @ts-ignore  function children
         h(ListContainer, {
@@ -937,12 +1010,26 @@ var DropDownListVue2 = {
           onClose: this.onPopupClosed,
           onBlur: this.handleBlur
         }, this.v3 ? function () {
-          return [renderListFilter.call(_this3), renderDefaultItem.call(_this3), header && h("div", {
+          return [renderListFilter.call(_this3), renderDefaultItem.call(_this3), _this3.group && dataItems.length !== 0 && h(GroupStickyHeader, {
+            group: _this3.group,
+            attrs: _this3.v3 ? undefined : {
+              group: _this3.group,
+              render: groupStickyHeaderTemplate
+            },
+            render: groupStickyHeaderTemplate
+          }), header && h("div", {
             "class": "k-list-header"
           }, [header]), renderList.call(_this3), footer && h("div", {
             "class": "k-list-footer"
           }, [footer])];
-        } : [renderListFilter.call(_this3), renderDefaultItem.call(_this3), header && h("div", {
+        } : [renderListFilter.call(_this3), renderDefaultItem.call(_this3), _this3.group && dataItems.length !== 0 && h(GroupStickyHeader, {
+          group: _this3.group,
+          attrs: _this3.v3 ? undefined : {
+            group: _this3.group,
+            render: groupStickyHeaderTemplate
+          },
+          render: groupStickyHeaderTemplate
+        }), header && h("div", {
           "class": "k-list-header"
         }, [header]), renderList.call(_this3), footer && h("div", {
           "class": "k-list-footer"

package/dist/es/DropDownList/DropDownListProps.d.ts

@@ -284,4 +284,16 @@ export interface DropDownListProps extends FormComponentProps {
      * @default `solid`
      */
     fillMode?: null | 'solid' | 'outline' | 'flat' | string;
+    /**
+     * Sets the data item field that represents the start of a group. Applicable to objects data.
+     */
+    groupField?: string;
+    /**
+     * Fires when a DropDownList group header item is about to be rendered. Used to override the default appearance of the group's headers.
+     */
+    groupHeaderItemRender?: any;
+    /**
+     * Fires when a DropDownList sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.
+     */
+    groupStickyHeaderItemRender?: any;
 }

package/dist/es/DropDownTree/DropDownTree.d.ts

@@ -1 +1,49 @@
-
+import { DefineComponent, RecordPropsDefinition, ComponentOptions, Vue2type } from '../additionalTypes';
+declare type DefaultData<V> = object | ((this: V) => {});
+declare type DefaultMethods<V> = {
+    [key: string]: (this: V, ...args: any[]) => any;
+};
+import { DropDownTreeProps } from './DropDownTreeProps';
+/**
+ * @hidden
+ */
+export interface DropDownTreeState {
+    calculatedId: string;
+    anchor: string;
+}
+/**
+ * @hidden
+ */
+export interface DropDownTreeComputed {
+    [key: string]: any;
+    isOpen: boolean;
+    computedValue: any;
+    hasValue: boolean;
+    currentValueText: string;
+    wrapperClass: object;
+}
+/**
+ * @hidden
+ */
+export interface DropDownTreeMethods {
+    [key: string]: any;
+}
+/**
+ * @hidden
+ */
+export interface DropDownTreeData {
+}
+/**
+ * @hidden
+ */
+export interface DropDownTreeAll extends Vue2type, DropDownTreeMethods, DropDownTreeData, DropDownTreeComputed, DropDownTreeState {
+}
+/**
+ * @hidden
+ */
+declare let DropDownTreeVue2: ComponentOptions<DropDownTreeAll, DefaultData<DropDownTreeData>, DefaultMethods<DropDownTreeAll>, DropDownTreeComputed, RecordPropsDefinition<DropDownTreeProps>>;
+/**
+ * @hidden
+ */
+declare const DropDownTree: DefineComponent<DropDownTreeProps, any, DropDownTreeData, DropDownTreeComputed, DropDownTreeMethods, {}, {}, {}, string, DropDownTreeProps, DropDownTreeProps, {}>;
+export { DropDownTree, DropDownTreeVue2 };