@progress/kendo-vue-grid 3.5.0 → 3.5.1-dev.202208100944

package/dist/esm/columnMenu/GridColumnMenuItemGroup.js

@@ -0,0 +1,33 @@
+// @ts-ignore
+import * as Vue from 'vue';
+var allVue = Vue;
+var gh = allVue.h;
+var isV3 = allVue.version && allVue.version[0] === '3';
+import { getDefaultSlots } from '@progress/kendo-vue-common';
+/**
+ * @hidden
+ */
+
+var GridColumnMenuItemGroupVue2 = {
+  // @ts-ignore
+  setup: !isV3 ? undefined : function () {
+    var v3 = !!isV3;
+    return {
+      v3: v3
+    };
+  },
+  // @ts-ignore
+  render: function render(createElement) {
+    var h = gh || createElement;
+    var defaultSlot = getDefaultSlots(this);
+    return h("div", {
+      "class": "k-columnmenu-item-wrapper"
+    }, [defaultSlot]);
+  }
+};
+/**
+ * @hidden
+ */
+
+var GridColumnMenuItemGroup = GridColumnMenuItemGroupVue2;
+export { GridColumnMenuItemGroup, GridColumnMenuItemGroupVue2 };

package/dist/esm/columnMenu/GridColumnMenuSort.d.ts

@@ -0,0 +1,283 @@
+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 { SortDescriptor } from '@progress/kendo-data-query';
+import { GridColumnMenuSortBaseProps } from '../interfaces/GridColumnMenuSortBaseProps';
+/**
+ * Can be used to check if sorting is applied to a specific field ([see example]({% slug column_menu_grid %}#toc-styling-the-column-menu-icon)). Useful for creating active sort indicators.
+ */
+export declare const sortGroupByField: (field: string, sort?: SortDescriptor[]) => boolean;
+/**
+ * The props of the GridColumnMenuSort component.
+ */
+export interface GridColumnMenuSortProps extends GridColumnMenuSortBaseProps {
+}
+/**
+ * @example
+ *  {% meta height:410 %}
+ *  ```html-preview
+ *  <div id="vueapp">
+ *     <Grid :style="{height: '280px'}"
+ *          :data-items="gridData"
+ *          :sortable="true"
+ *          :sort= "sort"
+ *          :filter="filter"
+ *          :expand-field="'Discontinued'"
+ *          @dataStateChange="dataStateChange"
+ *          @expandchange="expandChange"
+ *          :columns="columns">
+ *       </Grid>
+ *  </div>
+ * ```
+ * ```js
+ * import { Grid, GridColumnMenuSort } from '@progress/kendo-vue-grid';
+ * import { process } from '@progress/kendo-data-query';
+ *      const ColumnMenu = {
+ *        props: {
+ *            column: Object,
+ *            sortable: [Boolean, Object],
+ *            sort: {
+ *                type: Array
+ *            },
+ *            filter: Object,
+ *            filterable: Boolean
+ *        },
+ *        components: {
+ *            GridColumnMenuSort
+ *        },
+ *        template: `<div>
+ *            <GridColumnMenuSort
+ *                :column="column"
+ *                :filterable="filterable"
+ *                :filter="filter"
+ *                @closemenu ="closeMenu"
+ *                @sortchange = "sortChange"
+ *            />
+ *        </div>`,
+ *        methods: {
+ *            closeMenu () {
+ *                this.$emit('closemenu');
+ *            },
+ *            sortChange (newDescriptor, e) {
+ *                this.$emit('filterchange', newDescriptor, e);
+ *            }
+ *        }
+ *      };
+ *
+ *      Vue.component('Grid', Grid);
+ *      new Vue({
+ *          el: '#vueapp',
+ *          components: {
+ *            Grid
+ *          },
+ *          created: function() {
+ *             this.getData();
+ *          },
+ *          methods: {
+ *            getData: function () {
+ *                let dataState = {
+ *                    filter: this.filter,
+ *                    sort: this.sort
+ *                };
+ *                this.gridData = process([{
+ *                    "ProductID": 1,
+ *                    "ProductName": "Chai",
+ *                    "UnitsInStock": 39,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 20)
+ *                },{
+ *                    "ProductID": 2,
+ *                    "ProductName": "Chang",
+ *                    "UnitsInStock": 17,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 7, 12)
+ *                },{
+ *                    "ProductID": 3,
+ *                    "ProductName": "Aniseed Syrup",
+ *                    "UnitsInStock": 13,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 26)
+ *                },{
+ *                    "ProductID": 4,
+ *                    "ProductName": "Chef Anton's Cajun Seasoning",
+ *                    "UnitsInStock": 53,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 9, 19)
+ *                }], dataState);
+ *            },
+ *            createAppState: function(dataState) {
+ *                this.sort = dataState.sort;
+ *                this.filter = dataState.filter;
+ *                this.getData();
+ *            },
+ *            dataStateChange: function (event) {
+ *                this.createAppState(event.data);
+ *            },
+ *            expandChange: function (event) {
+ *                Vue.set(event.dataItem, event.target.$props.expandField, event.value);
+ *            }
+ *          },
+ *          data: function () {
+ *              return {
+ *                 filter: null,
+ *                 sort: [],
+ *                  gridData: [],
+ *                  columns: [
+ *                      { field: 'ProductID'},
+ *                      { field: 'ProductName', title: 'Product Name' },
+ *                      { field: 'UnitsInStock', title: 'Units In Stock', columnMenu: ColumnMenu }
+ *                  ]
+ *              };
+ *          }
+ *       } );
+ * ```
+ */
+/**
+ * @hidden
+ */
+export interface GridColumnMenuSortMethods extends Vue2type {
+    onAscClick: (e: any) => void;
+    onDescClick: (e: any) => void;
+    onSort: (e: any, selectedDir: 'asc' | 'desc') => void;
+}
+/**
+ * @hidden
+ */
+declare let GridColumnMenuSortVue2: ComponentOptions<Vue2type, DefaultData<{}>, DefaultMethods<GridColumnMenuSortMethods>, {}, RecordPropsDefinition<GridColumnMenuSortProps>>;
+/**
+ *
+ *
+ * {% meta height:410 %}
+ *  ```html-preview
+ *  <div id="vueapp">
+ *     <Grid :style="{height: '280px'}"
+ *          :data-items="gridData"
+ *          :sortable="true"
+ *          :sort= "sort"
+ *          :filter="filter"
+ *          :expand-field="'Discontinued'"
+ *          @datastatechange="dataStateChange"
+ *          @expandchange="expandChange"
+ *          :columns="columns">
+ *       </Grid>
+ *  </div>
+ * ```
+ * ```js
+ * import { Grid, GridColumnMenuSort } from '@progress/kendo-vue-grid';
+ * import { process } from '@progress/kendo-data-query';
+ *      const ColumnMenu = {
+ *        props: {
+ *            column: Object,
+ *            sortable: [Boolean, Object],
+ *            sort: {
+ *                type: Array
+ *            },
+ *            filter: Object,
+ *            filterable: Boolean
+ *        },
+ *        components: {
+ *            GridColumnMenuSort
+ *        },
+ *        template: `<div>
+ *            <GridColumnMenuSort
+ *                :column="column"
+ *                :filterable="filterable"
+ *                :filter="filter"
+ *                @closemenu ="closeMenu"
+ *                @sortchange = "sortChange"
+ *            />
+ *        </div>`,
+ *        methods: {
+ *            closeMenu () {
+ *                this.$emit('closemenu');
+ *            },
+ *            sortChange (newDescriptor, e) {
+ *                this.$emit('filterchange', newDescriptor, e);
+ *            }
+ *        }
+ *      };
+ *
+ *      Vue.component('Grid', Grid);
+ *      new Vue({
+ *          el: '#vueapp',
+ *          components: {
+ *            Grid
+ *          },
+ *          created: function() {
+ *             this.getData();
+ *          },
+ *          methods: {
+ *            getData: function () {
+ *                let dataState = {
+ *                    filter: this.filter,
+ *                    sort: this.sort
+ *                };
+ *                this.gridData = process([{
+ *                    "ProductID": 1,
+ *                    "ProductName": "Chai",
+ *                    "UnitsInStock": 39,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 20)
+ *                },{
+ *                    "ProductID": 2,
+ *                    "ProductName": "Chang",
+ *                    "UnitsInStock": 17,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 7, 12)
+ *                },{
+ *                    "ProductID": 3,
+ *                    "ProductName": "Aniseed Syrup",
+ *                    "UnitsInStock": 13,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 26)
+ *                },{
+ *                    "ProductID": 4,
+ *                    "ProductName": "Chef Anton's Cajun Seasoning",
+ *                    "UnitsInStock": 53,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 9, 19)
+ *                }], dataState);
+ *            },
+ *            createAppState: function(dataState) {
+ *                this.sort = dataState.sort;
+ *                this.filter = dataState.filter;
+ *                this.getData();
+ *            },
+ *            dataStateChange: function (event) {
+ *                this.createAppState(event.data);
+ *            },
+ *            expandChange: function (event) {
+ *                 event.dataItem[event.target.$props.expandField] = event.value;
+ *                 //
+ *                 // In Vue 2 context, instead of the above line, inside the expandChange method we should have the following:
+ *                 //
+ *                 //   Vue.set(
+ *                 //     event.dataItem,
+ *                 //     event.target.$props.expandField,
+ *                 //     event.dataItem.expanded === undefined ? false : !event.dataItem.expanded
+ *                 //   );
+ *                 //
+ *            }
+ *          },
+ *          data: function () {
+ *              return {
+ *                 filter: null,
+ *                 sort: [],
+ *                  gridData: [],
+ *                  columns: [
+ *                      { field: 'ProductID'},
+ *                      { field: 'ProductName', title: 'Product Name' },
+ *                      { field: 'UnitsInStock', title: 'Units In Stock', columnMenu: ColumnMenu }
+ *                  ]
+ *              };
+ *          }
+ *       } );
+ * ```
+ *
+ *
+ * ### props <span class='code'>[GridColumnMenuSortProps]({% slug api_grid_gridcolumnmenusortprops %})</span>
+ */
+declare const GridColumnMenuSort: DefineComponent<GridColumnMenuSortProps, any, {}, {}, GridColumnMenuSortMethods, {}, {}, {}, string, GridColumnMenuSortProps, GridColumnMenuSortProps, {}>;
+export { GridColumnMenuSort, GridColumnMenuSortVue2 };

package/dist/esm/columnMenu/GridColumnMenuSort.js

@@ -0,0 +1,375 @@
+// @ts-ignore
+import * as Vue from 'vue';
+var allVue = Vue;
+var gh = allVue.h;
+var isV3 = allVue.version && allVue.version[0] === '3';
+var inject = allVue.inject;
+import { GridColumnMenuItem } from './GridColumnMenuItem.js';
+import { GridColumnMenuItemGroup } from './GridColumnMenuItemGroup.js';
+import { normalize } from '../interfaces/GridSortSettings.js';
+import { provideLocalizationService } from '@progress/kendo-vue-intl';
+import { messages, sortAscending, sortDescending } from '../messages.js';
+import { hasListener } from '@progress/kendo-vue-common';
+/**
+ * @hidden
+ */
+
+var ASC_DIR = 'asc';
+/**
+ * @hidden
+ */
+
+var DESC_DIR = 'desc';
+/**
+ * @hidden
+ */
+
+var sortSeqMap = {
+  true: {
+    'asc': {
+      'asc': '',
+      'desc': 'desc'
+    },
+    'desc': {
+      'asc': 'asc',
+      'desc': ''
+    },
+    '': {
+      'asc': 'asc',
+      'desc': 'desc'
+    }
+  },
+  false: {
+    'asc': {
+      'asc': 'asc',
+      'desc': 'desc'
+    },
+    'desc': {
+      'asc': 'asc',
+      'desc': 'desc'
+    },
+    '': {
+      'asc': 'asc',
+      'desc': 'desc'
+    }
+  }
+};
+/**
+ * @hidden
+ */
+
+var sortIndex = function sortIndex(field, sort) {
+  if (!sort) {
+    return -1;
+  }
+
+  return sort.findIndex(function (s) {
+    return s.field === field;
+  });
+};
+/**
+ * @hidden
+ */
+
+
+var sortedAsc = function sortedAsc(sortedIndex, sort) {
+  return !!(sort && sortedIndex > -1 && sort[sortedIndex].dir === ASC_DIR);
+};
+/**
+ * @hidden
+ */
+
+
+var sortedDesc = function sortedDesc(sortedIndex, sort) {
+  return !!(sort && sortedIndex > -1 && sort[sortedIndex].dir === DESC_DIR);
+}; // tslint:disable:max-line-length
+
+/**
+ * Can be used to check if sorting is applied to a specific field ([see example]({% slug column_menu_grid %}#toc-styling-the-column-menu-icon)). Useful for creating active sort indicators.
+ */
+// tslint:enable:max-line-length
+
+
+export var sortGroupByField = function sortGroupByField(field, sort) {
+  var currentSortIndex = sortIndex(field, sort);
+  return sortedDesc(currentSortIndex, sort) || sortedAsc(currentSortIndex, sort);
+};
+/**
+ * @hidden
+ */
+
+var GridColumnMenuSortVue2 = {
+  props: {
+    sortable: [Boolean, Object],
+    sort: {
+      type: Array
+    },
+    column: Object
+  },
+  inject: {
+    kendoLocalizationService: {
+      default: null
+    }
+  },
+  methods: {
+    onAscClick: function onAscClick(e) {
+      this.onSort(e, ASC_DIR);
+      this.$emit('closemenu');
+    },
+    onDescClick: function onDescClick(e) {
+      this.onSort(e, DESC_DIR);
+      this.$emit('closemenu');
+    },
+    onSort: function onSort(e, selectedDir) {
+      e.preventDefault();
+
+      if (!hasListener.call(this, 'sortchange')) {
+        return;
+      }
+
+      var _a = this.$props,
+          column = _a.column,
+          sortable = _a.sortable,
+          sort = _a.sort;
+
+      var _b = normalize(sortable || false, false),
+          allowUnsort = _b.allowUnsort,
+          mode = _b.mode;
+
+      var oldDescriptor = (sort || []).filter(function (d) {
+        return d.field === column.field;
+      })[0];
+      var dir = sortSeqMap[allowUnsort][oldDescriptor && oldDescriptor.dir || ''][selectedDir];
+      var newDescriptor = mode === 'single' ? [] : (this.$props.sort || []).filter(function (d) {
+        return d.field !== column.field;
+      });
+
+      if (dir !== '' && column.field) {
+        newDescriptor.push({
+          field: column.field,
+          dir: dir
+        });
+      }
+
+      this.$emit('sortchange', newDescriptor, {
+        event: e,
+        field: this.$props.column.field
+      });
+    }
+  },
+  // @ts-ignore
+  setup: !isV3 ? undefined : function () {
+    var v3 = !!isV3;
+    var kendoLocalizationService = inject('kendoLocalizationService', {});
+    return {
+      v3: v3,
+      kendoLocalizationService: kendoLocalizationService
+    };
+  },
+  // @ts-ignore
+  render: function render(createElement) {
+    var _this = this;
+
+    var h = gh || createElement;
+    var _a = this.$props,
+        sort = _a.sort,
+        column = _a.column;
+    var currentSortIndex = sortIndex(column.field, sort);
+    var localizationService = provideLocalizationService(this);
+    return (// @ts-ignore function children
+      h(GridColumnMenuItemGroup, this.v3 ? function () {
+        return [// @ts-ignore
+        h(GridColumnMenuItem, {
+          title: localizationService.toLanguageString(sortAscending, messages[sortAscending]),
+          attrs: _this.v3 ? undefined : {
+            title: localizationService.toLanguageString(sortAscending, messages[sortAscending]),
+            iconClass: 'k-i-sort-asc-sm',
+            selected: sortedAsc(currentSortIndex, sort)
+          },
+          iconClass: 'k-i-sort-asc-sm',
+          selected: sortedAsc(currentSortIndex, sort),
+          onMenuitemclick: _this.onAscClick,
+          on: _this.v3 ? undefined : {
+            "menuitemclick": _this.onAscClick
+          }
+        }), // @ts-ignore
+        h(GridColumnMenuItem, {
+          title: localizationService.toLanguageString(sortDescending, messages[sortDescending]),
+          attrs: _this.v3 ? undefined : {
+            title: localizationService.toLanguageString(sortDescending, messages[sortDescending]),
+            iconClass: 'k-i-sort-desc-sm',
+            selected: sortedDesc(currentSortIndex, sort)
+          },
+          iconClass: 'k-i-sort-desc-sm',
+          selected: sortedDesc(currentSortIndex, sort),
+          onMenuitemclick: _this.onDescClick,
+          on: _this.v3 ? undefined : {
+            "menuitemclick": _this.onDescClick
+          }
+        })];
+      } : [h(GridColumnMenuItem, {
+        title: localizationService.toLanguageString(sortAscending, messages[sortAscending]),
+        attrs: _this.v3 ? undefined : {
+          title: localizationService.toLanguageString(sortAscending, messages[sortAscending]),
+          iconClass: 'k-i-sort-asc-sm',
+          selected: sortedAsc(currentSortIndex, sort)
+        },
+        iconClass: 'k-i-sort-asc-sm',
+        selected: sortedAsc(currentSortIndex, sort),
+        onMenuitemclick: _this.onAscClick,
+        on: _this.v3 ? undefined : {
+          "menuitemclick": _this.onAscClick
+        }
+      }), h(GridColumnMenuItem, {
+        title: localizationService.toLanguageString(sortDescending, messages[sortDescending]),
+        attrs: _this.v3 ? undefined : {
+          title: localizationService.toLanguageString(sortDescending, messages[sortDescending]),
+          iconClass: 'k-i-sort-desc-sm',
+          selected: sortedDesc(currentSortIndex, sort)
+        },
+        iconClass: 'k-i-sort-desc-sm',
+        selected: sortedDesc(currentSortIndex, sort),
+        onMenuitemclick: _this.onDescClick,
+        on: _this.v3 ? undefined : {
+          "menuitemclick": _this.onDescClick
+        }
+      })])
+    );
+  }
+};
+/**
+ *
+ *
+ * {% meta height:410 %}
+ *  ```html-preview
+ *  <div id="vueapp">
+ *     <Grid :style="{height: '280px'}"
+ *          :data-items="gridData"
+ *          :sortable="true"
+ *          :sort= "sort"
+ *          :filter="filter"
+ *          :expand-field="'Discontinued'"
+ *          @datastatechange="dataStateChange"
+ *          @expandchange="expandChange"
+ *          :columns="columns">
+ *       </Grid>
+ *  </div>
+ * ```
+ * ```js
+ * import { Grid, GridColumnMenuSort } from '@progress/kendo-vue-grid';
+ * import { process } from '@progress/kendo-data-query';
+ *      const ColumnMenu = {
+ *        props: {
+ *            column: Object,
+ *            sortable: [Boolean, Object],
+ *            sort: {
+ *                type: Array
+ *            },
+ *            filter: Object,
+ *            filterable: Boolean
+ *        },
+ *        components: {
+ *            GridColumnMenuSort
+ *        },
+ *        template: `<div>
+ *            <GridColumnMenuSort
+ *                :column="column"
+ *                :filterable="filterable"
+ *                :filter="filter"
+ *                @closemenu ="closeMenu"
+ *                @sortchange = "sortChange"
+ *            />
+ *        </div>`,
+ *        methods: {
+ *            closeMenu () {
+ *                this.$emit('closemenu');
+ *            },
+ *            sortChange (newDescriptor, e) {
+ *                this.$emit('filterchange', newDescriptor, e);
+ *            }
+ *        }
+ *      };
+ *
+ *      Vue.component('Grid', Grid);
+ *      new Vue({
+ *          el: '#vueapp',
+ *          components: {
+ *            Grid
+ *          },
+ *          created: function() {
+ *             this.getData();
+ *          },
+ *          methods: {
+ *            getData: function () {
+ *                let dataState = {
+ *                    filter: this.filter,
+ *                    sort: this.sort
+ *                };
+ *                this.gridData = process([{
+ *                    "ProductID": 1,
+ *                    "ProductName": "Chai",
+ *                    "UnitsInStock": 39,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 20)
+ *                },{
+ *                    "ProductID": 2,
+ *                    "ProductName": "Chang",
+ *                    "UnitsInStock": 17,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 7, 12)
+ *                },{
+ *                    "ProductID": 3,
+ *                    "ProductName": "Aniseed Syrup",
+ *                    "UnitsInStock": 13,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 8, 26)
+ *                },{
+ *                    "ProductID": 4,
+ *                    "ProductName": "Chef Anton's Cajun Seasoning",
+ *                    "UnitsInStock": 53,
+ *                    "Discontinued": false,
+ *                    "FirstOrderedOn": new Date(1996, 9, 19)
+ *                }], dataState);
+ *            },
+ *            createAppState: function(dataState) {
+ *                this.sort = dataState.sort;
+ *                this.filter = dataState.filter;
+ *                this.getData();
+ *            },
+ *            dataStateChange: function (event) {
+ *                this.createAppState(event.data);
+ *            },
+ *            expandChange: function (event) {
+ *                 event.dataItem[event.target.$props.expandField] = event.value;
+ *                 //
+ *                 // In Vue 2 context, instead of the above line, inside the expandChange method we should have the following:
+ *                 //
+ *                 //   Vue.set(
+ *                 //     event.dataItem,
+ *                 //     event.target.$props.expandField,
+ *                 //     event.dataItem.expanded === undefined ? false : !event.dataItem.expanded
+ *                 //   );
+ *                 //
+ *            }
+ *          },
+ *          data: function () {
+ *              return {
+ *                 filter: null,
+ *                 sort: [],
+ *                  gridData: [],
+ *                  columns: [
+ *                      { field: 'ProductID'},
+ *                      { field: 'ProductName', title: 'Product Name' },
+ *                      { field: 'UnitsInStock', title: 'Units In Stock', columnMenu: ColumnMenu }
+ *                  ]
+ *              };
+ *          }
+ *       } );
+ * ```
+ *
+ *
+ * ### props <span class='code'>[GridColumnMenuSortProps]({% slug api_grid_gridcolumnmenusortprops %})</span>
+ */
+
+var GridColumnMenuSort = GridColumnMenuSortVue2;
+export { GridColumnMenuSort, GridColumnMenuSortVue2 };