@syncfusion/ej2-ribbon 21.2.3 → 22.1.34

package/dist/global/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 *  filename: index.d.ts
-*  version : 21.2.3
+*  version : 22.1.34
 *  Copyright Syncfusion Inc. 2001 - 2020. All rights reserved.
 *  Use of this code is subject to the terms of our license.
 *  A copy of the current license can be obtained at any time by e-mailing

package/package.json

@@ -1,8 +1,8 @@
 {
   "_from": "@syncfusion/ej2-ribbon@*",
-  "_id": "@syncfusion/ej2-ribbon@21.1.37",
+  "_id": "@syncfusion/ej2-ribbon@21.4.0",
   "_inBundle": false,
-  "_integrity": "sha512-gWwlbD+kTmoNDnyq+liFGtG0dXmxD7B5M/OMAWv8wXSJZWlzmdrVUIa8fSL80eQSFzyzU/fU8z0pjyXVu8VSXA==",
+  "_integrity": "sha512-vZoyP4dghRkI9iMifn2pVA5+dnXyvxVxh3lfxrdCDsUwBrDoLSuaUueAt+GasfVFirDPMJrb/5mrO0J0OK8QGw==",
   "_location": "/@syncfusion/ej2-ribbon",
   "_phantomChildren": {},
   "_requested": {
@@ -18,10 +18,13 @@
   },
   "_requiredBy": [
     "/",
-    "/@syncfusion/ej2"
+    "/@syncfusion/ej2",
+    "/@syncfusion/ej2-angular-ribbon",
+    "/@syncfusion/ej2-react-ribbon",
+    "/@syncfusion/ej2-vue-ribbon"
   ],
-  "_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-ribbon/-/ej2-ribbon-21.1.37.tgz",
-  "_shasum": "724d27c29aa2886be6969a2149fc3c97645677e2",
+  "_resolved": "https://nexus.syncfusion.com/repository/ej2-release/@syncfusion/ej2-ribbon/-/ej2-ribbon-21.4.0.tgz",
+  "_shasum": "b0a80c279ae948b7a24f86c1dcc1e66d9b0081dc",
   "_spec": "@syncfusion/ej2-ribbon@*",
   "_where": "/jenkins/workspace/elease-automation_release_21.1.1/packages/included",
   "author": {
@@ -32,13 +35,13 @@
   },
   "bundleDependencies": false,
   "dependencies": {
-    "@syncfusion/ej2-base": "~21.2.3",
-    "@syncfusion/ej2-buttons": "~21.2.3",
-    "@syncfusion/ej2-dropdowns": "~21.2.3",
-    "@syncfusion/ej2-lists": "~21.2.3",
-    "@syncfusion/ej2-navigations": "~21.2.3",
-    "@syncfusion/ej2-popups": "~21.2.3",
-    "@syncfusion/ej2-splitbuttons": "~21.2.3"
+    "@syncfusion/ej2-base": "~22.1.34",
+    "@syncfusion/ej2-buttons": "~22.1.34",
+    "@syncfusion/ej2-dropdowns": "~22.1.34",
+    "@syncfusion/ej2-lists": "~22.1.34",
+    "@syncfusion/ej2-navigations": "~22.1.34",
+    "@syncfusion/ej2-popups": "~22.1.34",
+    "@syncfusion/ej2-splitbuttons": "~22.1.34"
   },
   "deprecated": false,
   "description": "Essential JS 2 Component",
@@ -59,6 +62,6 @@
     "url": "git+https://github.com/syncfusion/ej2-ribbon-component.git"
   },
   "typings": "index.d.ts",
-  "version": "21.2.3",
+  "version": "22.1.34",
   "sideEffects": false
 }

package/src/ribbon/base/interface.d.ts

@@ -51,6 +51,10 @@ export declare enum RibbonItemSize {
  * @aspNumberEnum
  */
 export declare enum DisplayMode {
+    /**
+     * The item appears in the classic layout group.
+     */
+    Classic = 4,
     /**
      * The item appears in the simplified layout group.
      */
@@ -60,13 +64,9 @@ export declare enum DisplayMode {
      */
     Overflow = 1,
     /**
-     * The item appears in both simplified layout group and overflow popup based on ribbon overflow state.
-     */
-    Auto = 3,
-    /**
-     * The item is hidden in simplified mode.
+      * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
      */
-    None = 0
+    Auto = 7
 }
 /**
  * Defines the type of the ribbon item.

package/src/ribbon/base/interface.js

@@ -53,6 +53,10 @@ export var RibbonItemSize;
  */
 export var DisplayMode;
 (function (DisplayMode) {
+    /**
+     * The item appears in the classic layout group.
+     */
+    DisplayMode[DisplayMode["Classic"] = 4] = "Classic";
     /**
      * The item appears in the simplified layout group.
      */
@@ -62,13 +66,9 @@ export var DisplayMode;
      */
     DisplayMode[DisplayMode["Overflow"] = 1] = "Overflow";
     /**
-     * The item appears in both simplified layout group and overflow popup based on ribbon overflow state.
-     */
-    DisplayMode[DisplayMode["Auto"] = 3] = "Auto";
-    /**
-     * The item is hidden in simplified mode.
+      * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
      */
-    DisplayMode[DisplayMode["None"] = 0] = "None";
+    DisplayMode[DisplayMode["Auto"] = 7] = "Auto";
 })(DisplayMode || (DisplayMode = {}));
 /**
  * Defines the type of the ribbon item.

package/src/ribbon/base/ribbon-model.d.ts

@@ -1,4 +1,4 @@
-import { addClass, append, Event, Collection, Complex, Component, EmitType, EventHandler, formatUnit, getInstance, getComponent, getUniqueID, closest } from '@syncfusion/ej2-base';import { INotifyPropertyChanged, isNullOrUndefined, isUndefined, ModuleDeclaration, NotifyPropertyChanges, Property, remove, removeClass } from '@syncfusion/ej2-base';import { Tab, TabAnimationSettings, TabAnimationSettingsModel, TabItemModel, SelectEventArgs, SelectingEventArgs, HScroll, Toolbar } from '@syncfusion/ej2-navigations';import { RibbonTab, RibbonTabModel, RibbonGroupModel, RibbonCollectionModel, RibbonItemModel, FileMenuSettings, FileMenuSettingsModel, RibbonItem, RibbonCollection, RibbonGroup } from '../models/index';import { commonProperties, DisplayMode, ExpandCollapseEventArgs, itemProps, LauncherClickEventArgs, ribbonItemPropsList, RibbonLayout, ribbonTooltipData, TabSelectedEventArgs, TabSelectingEventArgs } from './interface';import { ItemOrientation, RibbonItemSize, RibbonItemType } from './interface';import { RibbonButton, RibbonComboBox, RibbonCheckBox, RibbonDropDown, RibbonColorPicker, RibbonSplitButton } from '../items/index';import { destroyControl, getCollection, getGroup, getIndex, getItem, getItemElement, updateCommonProperty, updateControlDisabled, isTooltipPresent, getTemplateFunction, createTooltip, destroyTooltip, updateTooltipProp } from './utils';import * as constants from './constant';import { RibbonFileMenu } from '../modules/index';import { RibbonTooltipModel } from '../models/ribbon-tooltip-model';import { Popup } from '@syncfusion/ej2-popups';import { BeforeOpenCloseMenuEventArgs, DropDownButton, SplitButton } from '@syncfusion/ej2-splitbuttons';
+import { addClass, append, Event, Collection, Complex, Component, EmitType, EventHandler, formatUnit, getInstance, getComponent, getUniqueID, closest, KeyboardEventArgs, KeyboardEvents } from '@syncfusion/ej2-base';import { INotifyPropertyChanged, isNullOrUndefined, isUndefined, ModuleDeclaration, NotifyPropertyChanges, Property, remove, removeClass } from '@syncfusion/ej2-base';import { Tab, TabAnimationSettings, TabAnimationSettingsModel, TabItemModel, SelectEventArgs, SelectingEventArgs, HScroll, Toolbar } from '@syncfusion/ej2-navigations';import { RibbonTab, RibbonTabModel, RibbonGroupModel, RibbonCollectionModel, RibbonItemModel, FileMenuSettings, FileMenuSettingsModel, RibbonItem, RibbonCollection, RibbonGroup } from '../models/index';import { commonProperties, DisplayMode, ExpandCollapseEventArgs, itemProps, LauncherClickEventArgs, ribbonItemPropsList, RibbonLayout, ribbonTooltipData, TabSelectedEventArgs, TabSelectingEventArgs } from './interface';import { ItemOrientation, RibbonItemSize, RibbonItemType } from './interface';import { RibbonButton, RibbonComboBox, RibbonCheckBox, RibbonDropDown, RibbonColorPicker, RibbonSplitButton } from '../items/index';import { destroyControl, getCollection, getGroup, getIndex, getItem, getItemElement, updateCommonProperty, updateControlDisabled, isTooltipPresent, getTemplateFunction, createTooltip, destroyTooltip, updateTooltipProp } from './utils';import * as constants from './constant';import { RibbonFileMenu } from '../modules/index';import { RibbonTooltipModel } from '../models/ribbon-tooltip-model';import { Popup } from '@syncfusion/ej2-popups';import { BeforeOpenCloseMenuEventArgs, DropDownButton, SplitButton } from '@syncfusion/ej2-splitbuttons';import { CheckBox } from '@syncfusion/ej2-buttons';
 import {ComponentModel} from '@syncfusion/ej2-base';
 
 /**
@@ -89,7 +89,7 @@ export interface RibbonModel extends ComponentModel{
      * @default ''
      * @aspType string
      */
-    helpPaneTemplate?: string | HTMLElement;
+    helpPaneTemplate?: string | HTMLElement | Function;
 
     /**
      * Event triggers before selecting the tab item.

package/src/ribbon/base/ribbon.d.ts

@@ -84,7 +84,7 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
      * @default ''
      * @aspType string
      */
-    helpPaneTemplate: string | HTMLElement;
+    helpPaneTemplate: string | HTMLElement | Function;
     /**
      * Event triggers before selecting the tab item.
      *
@@ -143,11 +143,15 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
      * The `ribbonFileMenuModule` is used to create and manipulate the ribbon file menu.
      */
     ribbonFileMenuModule: RibbonFileMenu;
+    private itemIndex;
     private idIndex;
     private isAddRemove;
     private collapseButton;
     private ribbonTempEle;
     private scrollModule;
+    private currentControlIndex;
+    private keyboardModuleRibbon;
+    private keyConfigs;
     /** @hidden */
     overflowDDB: DropDownButton;
     /** @hidden */
@@ -193,6 +197,9 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
     protected requiredModules(): ModuleDeclaration[];
     private initialize;
     private wireEvents;
+    private wireKeyboardEvent;
+    private keyActionHandler;
+    private handleNavigation;
     private resizeHandler;
     private renderTabs;
     private minimize;
@@ -209,6 +216,9 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
     private addOverflowEvents;
     private createOfTabContainer;
     private checkGroupShrinking;
+    private checkValidCollectionLength;
+    private checkClassicCollection;
+    private checkClassicItem;
     private checkLargeToMedium;
     private checkMediumToSmall;
     private checkGroupExpanding;
@@ -225,6 +235,8 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
     private createTabItems;
     private renderInitialTab;
     private addOverflowButton;
+    private upDownKeyHandler;
+    private findDisabledItem;
     private removeOverflowButton;
     private removeOverflowEvent;
     private createGroupContainer;
@@ -232,10 +244,12 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
     private removeExpandCollapse;
     private reRenderTabs;
     private switchLayout;
+    private createLauncherIcon;
     private launcherIconClicked;
     private createGroups;
     private validateItemSize;
     private createCollection;
+    private createRibbonItem;
     private createItems;
     private createHelpPaneTemplate;
     private createTemplateContent;
@@ -327,6 +341,34 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
      * @returns {void}
      */
     removeItem(itemId: string): void;
+    /**
+     * tab - Gets the ribbon tab to be updated. The id of the tab is a required property. Other properties are optional.
+     *
+     * @param {RibbonTabModel} tab - Gets the ribbon tab model.
+     * @returns {void}
+     */
+    updateTab(tab: RibbonTabModel): void;
+    /**
+     * group - Gets the ribbon group to be updated. The id of the group is a required property. Other properties are optional.
+     *
+     * @param {RibbonGroupModel} group - Gets the ribbon group model.
+     * @returns {void}
+     */
+    updateGroup(group: RibbonGroupModel): void;
+    /**
+     * collection - Gets the ribbon collection to be updated. The id of the collection is a required property. Other properties are optional.
+     *
+     * @param {RibbonCollectionModel} collection - Gets the ribbon collection model.
+     * @returns {void}
+     */
+    updateCollection(collection: RibbonCollectionModel): void;
+    /**
+     * item - Gets the ribbon item to be updated. The id of the item is a required property. Other properties are optional.
+     *
+     * @param {RibbonItemModel} item - Gets the ribbon item model.
+     * @returns {void}
+     */
+    updateItem(item: RibbonItemModel): void;
     private removeItemElement;
     /**
      * Enables ribbon item.