@syncfusion/ej2-ribbon 22.2.11 → 23.1.36

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.
Files changed (126) hide show
  1. package/CHANGELOG.md +0 -16
  2. package/dist/ej2-ribbon.umd.min.js +2 -2
  3. package/dist/ej2-ribbon.umd.min.js.map +1 -1
  4. package/dist/es6/ej2-ribbon.es2015.js +1739 -192
  5. package/dist/es6/ej2-ribbon.es2015.js.map +1 -1
  6. package/dist/es6/ej2-ribbon.es5.js +1800 -135
  7. package/dist/es6/ej2-ribbon.es5.js.map +1 -1
  8. package/dist/global/ej2-ribbon.min.js +2 -2
  9. package/dist/global/ej2-ribbon.min.js.map +1 -1
  10. package/dist/global/index.d.ts +1 -1
  11. package/package.json +13 -13
  12. package/src/global.js +1 -1
  13. package/src/ribbon/base/constant.d.ts +40 -0
  14. package/src/ribbon/base/constant.js +40 -0
  15. package/src/ribbon/base/interface.d.ts +49 -2
  16. package/src/ribbon/base/interface.js +19 -1
  17. package/src/ribbon/base/ribbon-model.d.ts +25 -1
  18. package/src/ribbon/base/ribbon.d.ts +108 -3
  19. package/src/ribbon/base/ribbon.js +434 -61
  20. package/src/ribbon/items/index.d.ts +1 -0
  21. package/src/ribbon/items/index.js +1 -0
  22. package/src/ribbon/items/ribbon-button.js +3 -0
  23. package/src/ribbon/items/ribbon-colorpicker.js +1 -1
  24. package/src/ribbon/items/ribbon-dropdown.js +2 -1
  25. package/src/ribbon/items/ribbon-groupbutton.d.ts +69 -0
  26. package/src/ribbon/items/ribbon-groupbutton.js +444 -0
  27. package/src/ribbon/models/index.d.ts +10 -0
  28. package/src/ribbon/models/index.js +5 -0
  29. package/src/ribbon/models/ribbon-back-button-model.d.ts +29 -0
  30. package/src/ribbon/models/ribbon-back-button.d.ts +24 -0
  31. package/src/ribbon/models/ribbon-back-button.js +40 -0
  32. package/src/ribbon/models/ribbon-back-stage-settings-model.d.ts +76 -0
  33. package/src/ribbon/models/ribbon-back-stage-settings.d.ts +75 -0
  34. package/src/ribbon/models/ribbon-back-stage-settings.js +70 -0
  35. package/src/ribbon/models/ribbon-backstage-item-model.d.ts +62 -0
  36. package/src/ribbon/models/ribbon-backstage-item.d.ts +74 -0
  37. package/src/ribbon/models/ribbon-backstage-item.js +52 -0
  38. package/src/ribbon/models/ribbon-combobox-settings-model.d.ts +15 -0
  39. package/src/ribbon/models/ribbon-combobox-settings.d.ts +15 -0
  40. package/src/ribbon/models/ribbon-dropdown-settings-model.d.ts +7 -0
  41. package/src/ribbon/models/ribbon-dropdown-settings.d.ts +6 -0
  42. package/src/ribbon/models/ribbon-dropdown-settings.js +3 -0
  43. package/src/ribbon/models/ribbon-file-menu-settings-model.d.ts +6 -0
  44. package/src/ribbon/models/ribbon-file-menu-settings.d.ts +6 -0
  45. package/src/ribbon/models/ribbon-group-button-item-model.d.ts +50 -0
  46. package/src/ribbon/models/ribbon-group-button-item.d.ts +44 -0
  47. package/src/ribbon/models/ribbon-group-button-item.js +50 -0
  48. package/src/ribbon/models/ribbon-group-button-settings-model.d.ts +25 -0
  49. package/src/ribbon/models/ribbon-group-button-settings.d.ts +23 -0
  50. package/src/ribbon/models/ribbon-group-button-settings.js +38 -0
  51. package/src/ribbon/models/ribbon-item-model.d.ts +11 -1
  52. package/src/ribbon/models/ribbon-item.d.ts +10 -0
  53. package/src/ribbon/models/ribbon-item.js +4 -0
  54. package/src/ribbon/modules/index.d.ts +1 -0
  55. package/src/ribbon/modules/index.js +1 -0
  56. package/src/ribbon/modules/ribbon-backstage.d.ts +112 -0
  57. package/src/ribbon/modules/ribbon-backstage.js +554 -0
  58. package/styles/bootstrap-dark.css +511 -8
  59. package/styles/bootstrap.css +511 -8
  60. package/styles/bootstrap4.css +511 -8
  61. package/styles/bootstrap5-dark.css +511 -8
  62. package/styles/bootstrap5.css +511 -8
  63. package/styles/fabric-dark.css +511 -8
  64. package/styles/fabric.css +511 -8
  65. package/styles/fluent-dark.css +511 -8
  66. package/styles/fluent.css +511 -8
  67. package/styles/highcontrast-light.css +511 -8
  68. package/styles/highcontrast.css +511 -8
  69. package/styles/material-dark.css +511 -9
  70. package/styles/material.css +512 -9
  71. package/styles/material3-dark.css +511 -9
  72. package/styles/material3-dark.scss +1 -1
  73. package/styles/material3.css +511 -9
  74. package/styles/material3.scss +1 -1
  75. package/styles/ribbon/_bootstrap-dark-definition.scss +65 -0
  76. package/styles/ribbon/_bootstrap-definition.scss +65 -0
  77. package/styles/ribbon/_bootstrap4-definition.scss +65 -0
  78. package/styles/ribbon/_bootstrap5-definition.scss +65 -0
  79. package/styles/ribbon/_fabric-dark-definition.scss +65 -0
  80. package/styles/ribbon/_fabric-definition.scss +65 -0
  81. package/styles/ribbon/_fluent-definition.scss +65 -0
  82. package/styles/ribbon/_fusionnew-definition.scss +65 -0
  83. package/styles/ribbon/_highcontrast-definition.scss +65 -0
  84. package/styles/ribbon/_highcontrast-light-definition.scss +65 -0
  85. package/styles/ribbon/_layout.scss +280 -5
  86. package/styles/ribbon/_material-dark-definition.scss +65 -0
  87. package/styles/ribbon/_material-definition.scss +65 -0
  88. package/styles/ribbon/_material3-definition.scss +66 -0
  89. package/styles/ribbon/_tailwind-definition.scss +65 -0
  90. package/styles/ribbon/_theme.scss +144 -1
  91. package/styles/ribbon/bootstrap-dark.css +511 -8
  92. package/styles/ribbon/bootstrap-dark.scss +1 -1
  93. package/styles/ribbon/bootstrap.css +511 -8
  94. package/styles/ribbon/bootstrap.scss +1 -1
  95. package/styles/ribbon/bootstrap4.css +511 -8
  96. package/styles/ribbon/bootstrap4.scss +1 -1
  97. package/styles/ribbon/bootstrap5-dark.css +511 -8
  98. package/styles/ribbon/bootstrap5-dark.scss +1 -1
  99. package/styles/ribbon/bootstrap5.css +511 -8
  100. package/styles/ribbon/bootstrap5.scss +1 -1
  101. package/styles/ribbon/fabric-dark.css +511 -8
  102. package/styles/ribbon/fabric-dark.scss +1 -1
  103. package/styles/ribbon/fabric.css +511 -8
  104. package/styles/ribbon/fabric.scss +1 -1
  105. package/styles/ribbon/fluent-dark.css +511 -8
  106. package/styles/ribbon/fluent-dark.scss +1 -1
  107. package/styles/ribbon/fluent.css +511 -8
  108. package/styles/ribbon/fluent.scss +1 -1
  109. package/styles/ribbon/highcontrast-light.css +511 -8
  110. package/styles/ribbon/highcontrast-light.scss +1 -1
  111. package/styles/ribbon/highcontrast.css +511 -8
  112. package/styles/ribbon/highcontrast.scss +1 -1
  113. package/styles/ribbon/material-dark.css +511 -9
  114. package/styles/ribbon/material-dark.scss +1 -1
  115. package/styles/ribbon/material.css +512 -9
  116. package/styles/ribbon/material.scss +1 -1
  117. package/styles/ribbon/material3-dark.css +511 -9
  118. package/styles/ribbon/material3-dark.scss +1 -1
  119. package/styles/ribbon/material3.css +511 -9
  120. package/styles/ribbon/material3.scss +1 -1
  121. package/styles/ribbon/tailwind-dark.css +511 -9
  122. package/styles/ribbon/tailwind-dark.scss +1 -1
  123. package/styles/ribbon/tailwind.css +511 -9
  124. package/styles/ribbon/tailwind.scss +1 -1
  125. package/styles/tailwind-dark.css +511 -9
  126. package/styles/tailwind.css +511 -9
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * filename: index.d.ts
3
- * version : 22.2.11
3
+ * version : 23.1.36
4
4
  * Copyright Syncfusion Inc. 2001 - 2020. All rights reserved.
5
5
  * Use of this code is subject to the terms of our license.
6
6
  * A copy of the current license can be obtained at any time by e-mailing
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "_from": "@syncfusion/ej2-ribbon@*",
3
- "_id": "@syncfusion/ej2-ribbon@22.2.5",
3
+ "_id": "@syncfusion/ej2-ribbon@21.22.0",
4
4
  "_inBundle": false,
5
- "_integrity": "sha512-jPYEE9x4otVzG1p540DS2xI1tX0qB6B/InVj383QyPs67lPMppf9xNhdq5pXH+Q3MF0y6NH88ezpnMFcQ5donA==",
5
+ "_integrity": "sha512-Q0pcyouzFXSEoCBOwpf7hCIWm4z8gYsUYYLhh1xnwJump+inbNer0fUQKSn4cVXCivYuREWJIn17X8Ln4KY6lQ==",
6
6
  "_location": "/@syncfusion/ej2-ribbon",
7
7
  "_phantomChildren": {},
8
8
  "_requested": {
@@ -23,10 +23,10 @@
23
23
  "/@syncfusion/ej2-react-ribbon",
24
24
  "/@syncfusion/ej2-vue-ribbon"
25
25
  ],
26
- "_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-ribbon/-/ej2-ribbon-22.2.5.tgz",
27
- "_shasum": "56e59e14946ad866450e8b886f1f81555b3a0bd3",
26
+ "_resolved": "https://nexus.syncfusion.com/repository/ej2-release/@syncfusion/ej2-ribbon/-/ej2-ribbon-21.22.0.tgz",
27
+ "_shasum": "02b50c97b7c2a8fc87f88021d6f10de7e632a8dc",
28
28
  "_spec": "@syncfusion/ej2-ribbon@*",
29
- "_where": "/jenkins/workspace/elease-automation_release_21.1.1/packages/included",
29
+ "_where": "/jenkins/workspace/elease-automation_release_23.1.1/packages/included",
30
30
  "author": {
31
31
  "name": "Syncfusion Inc."
32
32
  },
@@ -35,13 +35,13 @@
35
35
  },
36
36
  "bundleDependencies": false,
37
37
  "dependencies": {
38
- "@syncfusion/ej2-base": "~22.2.10",
39
- "@syncfusion/ej2-buttons": "~22.2.9",
40
- "@syncfusion/ej2-dropdowns": "~22.2.11",
41
- "@syncfusion/ej2-lists": "~22.2.11",
42
- "@syncfusion/ej2-navigations": "~22.2.11",
43
- "@syncfusion/ej2-popups": "~22.2.11",
44
- "@syncfusion/ej2-splitbuttons": "~22.2.8"
38
+ "@syncfusion/ej2-base": "~23.1.36",
39
+ "@syncfusion/ej2-buttons": "~23.1.36",
40
+ "@syncfusion/ej2-dropdowns": "~23.1.36",
41
+ "@syncfusion/ej2-lists": "~23.1.36",
42
+ "@syncfusion/ej2-navigations": "~23.1.36",
43
+ "@syncfusion/ej2-popups": "~23.1.36",
44
+ "@syncfusion/ej2-splitbuttons": "~23.1.36"
45
45
  },
46
46
  "deprecated": false,
47
47
  "description": "Essential JS 2 Component",
@@ -62,6 +62,6 @@
62
62
  "url": "git+https://github.com/syncfusion/ej2-ribbon-component.git"
63
63
  },
64
64
  "typings": "index.d.ts",
65
- "version": "22.2.11",
65
+ "version": "23.1.36",
66
66
  "sideEffects": false
67
67
  }
package/src/global.js CHANGED
@@ -1,3 +1,3 @@
1
1
  import * as index from './index';
2
- index.Ribbon.Inject(index.RibbonButton, index.RibbonDropDown, index.RibbonSplitButton, index.RibbonCheckBox, index.RibbonColorPicker, index.RibbonComboBox, index.RibbonFileMenu);
2
+ index.Ribbon.Inject(index.RibbonButton, index.RibbonDropDown, index.RibbonSplitButton, index.RibbonCheckBox, index.RibbonColorPicker, index.RibbonComboBox, index.RibbonGroupButton, index.RibbonFileMenu, index.RibbonBackstage);
3
3
  export * from './index';
@@ -6,6 +6,8 @@ export declare const ITEM_VERTICAL_CENTER: string;
6
6
  /** @hidden */
7
7
  export declare const EXPAND_COLLAPSE_ICON: string;
8
8
  /** @hidden */
9
+ export declare const BACKSTAGE_CLOSE_ICON: string;
10
+ /** @hidden */
9
11
  export declare const OVERFLOW_ICON: string;
10
12
  /** @hidden */
11
13
  export declare const VERTICAL_DDB: string;
@@ -54,6 +56,14 @@ export declare const RIBBON_MINIMIZE: string;
54
56
  /** @hidden */
55
57
  export declare const RIBBON_GROUP: string;
56
58
  /** @hidden */
59
+ export declare const RIBBON_SINGLE_BUTTON_SELECTION: string;
60
+ /** @hidden */
61
+ export declare const RIBBON_MULTIPLE_BUTTON_SELECTION: string;
62
+ /** @hidden */
63
+ export declare const RIBBON_GROUP_BUTTON: string;
64
+ /** @hidden */
65
+ export declare const RIBBON_GROUP_BUTTON_OVERFLOW_POPUP: string;
66
+ /** @hidden */
57
67
  export declare const RIBBON_GROUP_CONTAINER: string;
58
68
  /** @hidden */
59
69
  export declare const RIBBON_OF_TAB_CONTAINER: string;
@@ -116,6 +126,26 @@ export declare const RIBBON_TEXT_CONTAINER: string;
116
126
  /** @hidden */
117
127
  export declare const RIBBON_SIMPLIFIED_MODE: string;
118
128
  /** @hidden */
129
+ export declare const RIBBON_BACKSTAGE_POPUP: string;
130
+ /** @hidden */
131
+ export declare const RIBBON_BACKSTAGE_OPEN: string;
132
+ /** @hidden */
133
+ export declare const RIBBON_BACKSTAGE_CONTENT: string;
134
+ /** @hidden */
135
+ export declare const RIBBON_SELECTED_CONTENT: string;
136
+ /** @hidden */
137
+ export declare const RIBBON_BACKSTAGE: string;
138
+ /** @hidden */
139
+ export declare const RIBBON_BACKSTAGE_MENU: string;
140
+ /** @hidden */
141
+ export declare const RIBBON_BACKSTAGE_TEMPLATE: string;
142
+ /** @hidden */
143
+ export declare const RIBBON_BACKSTAGE_MENU_WRAPPER: string;
144
+ /** @hidden */
145
+ export declare const RIBBON_BACKSTAGE_ITEMS_WRAPPER: string;
146
+ /** @hidden */
147
+ export declare const RIBBON_BACKSTAGE_TEXT_MENU: string;
148
+ /** @hidden */
119
149
  export declare const TAB_ID: string;
120
150
  /** @hidden */
121
151
  export declare const GROUP_ID: string;
@@ -144,10 +174,20 @@ export declare const DROPDOWN_ID: string;
144
174
  /** @hidden */
145
175
  export declare const RIBBON_FILE_MENU_ID: string;
146
176
  /** @hidden */
177
+ export declare const RIBBON_BACKSTAGE_MENU_ID: string;
178
+ /** @hidden */
179
+ export declare const RIBBON_BACKSTAGE_POPUP_ID: string;
180
+ /** @hidden */
147
181
  export declare const RIBBON_FILE_MENU_LIST: string;
148
182
  /** @hidden */
183
+ export declare const RIBBON_MENU_LIST: string;
184
+ /** @hidden */
185
+ export declare const RIBBON_FOOTER_MENU_LIST: string;
186
+ /** @hidden */
149
187
  export declare const RIBBON_HELP_PANE_TEMPLATE_ID: string;
150
188
  /** @hidden */
189
+ export declare const RIBBON_GROUP_BUTTON_ID: string;
190
+ /** @hidden */
151
191
  export declare const RIBBON_FILE_MENU_WIDTH: string;
152
192
  /** @hidden */
153
193
  export declare const RIBBON_HELP_PANE_TEMPLATE_WIDTH: string;
@@ -6,6 +6,8 @@ export var ITEM_VERTICAL_CENTER = 'e-ribbon-vertical-center';
6
6
  /** @hidden */
7
7
  export var EXPAND_COLLAPSE_ICON = 'e-icons e-drop-icon';
8
8
  /** @hidden */
9
+ export var BACKSTAGE_CLOSE_ICON = 'e-icons e-arrow-left';
10
+ /** @hidden */
9
11
  export var OVERFLOW_ICON = 'e-icons e-more-horizontal-1';
10
12
  /** @hidden */
11
13
  export var VERTICAL_DDB = 'e-vertical';
@@ -54,6 +56,14 @@ export var RIBBON_MINIMIZE = 'e-ribbon-minimize';
54
56
  /** @hidden */
55
57
  export var RIBBON_GROUP = 'e-ribbon-group';
56
58
  /** @hidden */
59
+ export var RIBBON_SINGLE_BUTTON_SELECTION = 'e-ribbon-single-selection';
60
+ /** @hidden */
61
+ export var RIBBON_MULTIPLE_BUTTON_SELECTION = 'e-ribbon-multiple-selection';
62
+ /** @hidden */
63
+ export var RIBBON_GROUP_BUTTON = 'e-ribbon-group-button';
64
+ /** @hidden */
65
+ export var RIBBON_GROUP_BUTTON_OVERFLOW_POPUP = 'e-ribbon-group-button-overflow-popup';
66
+ /** @hidden */
57
67
  export var RIBBON_GROUP_CONTAINER = 'e-ribbon-group-container';
58
68
  /** @hidden */
59
69
  export var RIBBON_OF_TAB_CONTAINER = 'e-ribbon-of-tab';
@@ -116,6 +126,26 @@ export var RIBBON_TEXT_CONTAINER = 'e-ribbon-text-container';
116
126
  /** @hidden */
117
127
  export var RIBBON_SIMPLIFIED_MODE = 'e-ribbon-simplified-mode';
118
128
  /** @hidden */
129
+ export var RIBBON_BACKSTAGE_POPUP = 'e-ribbon-backstage-popup';
130
+ /** @hidden */
131
+ export var RIBBON_BACKSTAGE_OPEN = 'e-ribbon-backstage-open';
132
+ /** @hidden */
133
+ export var RIBBON_BACKSTAGE_CONTENT = 'e-ribbon-backstage-content';
134
+ /** @hidden */
135
+ export var RIBBON_SELECTED_CONTENT = 'e-ribbon-selected-content';
136
+ /** @hidden */
137
+ export var RIBBON_BACKSTAGE = 'e-ribbon-backstage';
138
+ /** @hidden */
139
+ export var RIBBON_BACKSTAGE_MENU = 'e-ribbon-backstage-menu';
140
+ /** @hidden */
141
+ export var RIBBON_BACKSTAGE_TEMPLATE = 'e-ribbon-backstage-template';
142
+ /** @hidden */
143
+ export var RIBBON_BACKSTAGE_MENU_WRAPPER = 'e-ribbon-backstage-wrapper';
144
+ /** @hidden */
145
+ export var RIBBON_BACKSTAGE_ITEMS_WRAPPER = 'e-ribbon-backstage-items-wrapper';
146
+ /** @hidden */
147
+ export var RIBBON_BACKSTAGE_TEXT_MENU = 'e-blankicon';
148
+ /** @hidden */
119
149
  export var TAB_ID = '_tab';
120
150
  /** @hidden */
121
151
  export var GROUP_ID = '_group';
@@ -144,10 +174,20 @@ export var DROPDOWN_ID = '_dropdown';
144
174
  /** @hidden */
145
175
  export var RIBBON_FILE_MENU_ID = '_filemenu';
146
176
  /** @hidden */
177
+ export var RIBBON_BACKSTAGE_MENU_ID = '_backstage';
178
+ /** @hidden */
179
+ export var RIBBON_BACKSTAGE_POPUP_ID = '_backstagepopup';
180
+ /** @hidden */
147
181
  export var RIBBON_FILE_MENU_LIST = '_filemenulist';
148
182
  /** @hidden */
183
+ export var RIBBON_MENU_LIST = '_menulist';
184
+ /** @hidden */
185
+ export var RIBBON_FOOTER_MENU_LIST = '_footermenulist';
186
+ /** @hidden */
149
187
  export var RIBBON_HELP_PANE_TEMPLATE_ID = '_helppanetemplate';
150
188
  /** @hidden */
189
+ export var RIBBON_GROUP_BUTTON_ID = '_grpbtn';
190
+ /** @hidden */
151
191
  export var RIBBON_FILE_MENU_WIDTH = '--fileMenuWidth';
152
192
  /** @hidden */
153
193
  export var RIBBON_HELP_PANE_TEMPLATE_WIDTH = '--helpTemplateWidth';
@@ -1,5 +1,5 @@
1
1
  import { BaseEventArgs } from '@syncfusion/ej2-base';
2
- import { RibbonCollectionModel, RibbonGroupModel, RibbonItemModel, RibbonTooltipModel } from '../models';
2
+ import { RibbonCollectionModel, RibbonGroupButtonItemModel, RibbonGroupModel, RibbonItemModel, RibbonTooltipModel } from '../models';
3
3
  /**
4
4
  * Defines the layout types of ribbon.
5
5
  */
@@ -64,7 +64,7 @@ export declare enum DisplayMode {
64
64
  */
65
65
  Overflow = 1,
66
66
  /**
67
- * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
67
+ * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
68
68
  */
69
69
  Auto = 7
70
70
  }
@@ -96,11 +96,28 @@ export declare enum RibbonItemType {
96
96
  * Renders splitbutton as ribbon item.
97
97
  */
98
98
  SplitButton = "SplitButton",
99
+ /**
100
+ * Renders the group button content as ribbon item.
101
+ */
102
+ GroupButton = "GroupButton",
99
103
  /**
100
104
  * Renders the template content as ribbon item.
101
105
  */
102
106
  Template = "Template"
103
107
  }
108
+ /**
109
+ * Defines the alignment of the items in the ribbon group.
110
+ */
111
+ export declare enum RibbonGroupButtonSelection {
112
+ /**
113
+ * Allows selecting single button from button group.
114
+ */
115
+ Single = "Single",
116
+ /**
117
+ * Allows selecting multiple buttons from button group.
118
+ */
119
+ Multiple = "Multiple"
120
+ }
104
121
  /**
105
122
  * Event triggers before selecting the tab item.
106
123
  */
@@ -153,6 +170,36 @@ export interface LauncherClickEventArgs extends BaseEventArgs {
153
170
  */
154
171
  groupId: string;
155
172
  }
173
+ /**
174
+ * Triggers before clicking the button from group button
175
+ */
176
+ export interface BeforeClickGroupButtonEventArgs extends BaseEventArgs {
177
+ /**
178
+ * Defines whether to cancel the event or not.
179
+ */
180
+ cancel: boolean;
181
+ /**
182
+ * Defines the collection of previous selected group button item(s).
183
+ */
184
+ previousItems: RibbonGroupButtonItemModel[];
185
+ /**
186
+ * Defines the collection of current selecting group button item(s).
187
+ */
188
+ selectingItems: RibbonGroupButtonItemModel[];
189
+ }
190
+ /**
191
+ * Triggers after clicking the button from group button.
192
+ */
193
+ export interface ClickGroupButtonEventArgs extends BaseEventArgs {
194
+ /**
195
+ * Defines the collection of previous selected group button item(s).
196
+ */
197
+ previousItems: RibbonGroupButtonItemModel[];
198
+ /**
199
+ * Defines the collection of current selected group button item(s).
200
+ */
201
+ selectedItems: RibbonGroupButtonItemModel[];
202
+ }
156
203
  /** @hidden */
157
204
  export interface itemProps {
158
205
  item?: RibbonItemModel;
@@ -66,7 +66,7 @@ export var DisplayMode;
66
66
  */
67
67
  DisplayMode[DisplayMode["Overflow"] = 1] = "Overflow";
68
68
  /**
69
- * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
69
+ * The item appears in classic layout group, simplified layout group, and overflow popup based on ribbon overflow state.
70
70
  */
71
71
  DisplayMode[DisplayMode["Auto"] = 7] = "Auto";
72
72
  })(DisplayMode || (DisplayMode = {}));
@@ -99,8 +99,26 @@ export var RibbonItemType;
99
99
  * Renders splitbutton as ribbon item.
100
100
  */
101
101
  RibbonItemType["SplitButton"] = "SplitButton";
102
+ /**
103
+ * Renders the group button content as ribbon item.
104
+ */
105
+ RibbonItemType["GroupButton"] = "GroupButton";
102
106
  /**
103
107
  * Renders the template content as ribbon item.
104
108
  */
105
109
  RibbonItemType["Template"] = "Template";
106
110
  })(RibbonItemType || (RibbonItemType = {}));
111
+ /**
112
+ * Defines the alignment of the items in the ribbon group.
113
+ */
114
+ export var RibbonGroupButtonSelection;
115
+ (function (RibbonGroupButtonSelection) {
116
+ /**
117
+ * Allows selecting single button from button group.
118
+ */
119
+ RibbonGroupButtonSelection["Single"] = "Single";
120
+ /**
121
+ * Allows selecting multiple buttons from button group.
122
+ */
123
+ RibbonGroupButtonSelection["Multiple"] = "Multiple";
124
+ })(RibbonGroupButtonSelection || (RibbonGroupButtonSelection = {}));
@@ -1,4 +1,4 @@
1
- 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';
1
+ 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, BackStageMenu, BackStageMenuModel, 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, RibbonGroupButton } 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, RibbonBackstage } 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';
2
2
  import {ComponentModel} from '@syncfusion/ej2-base';
3
3
 
4
4
  /**
@@ -32,6 +32,13 @@ export interface RibbonModel extends ComponentModel{
32
32
  */
33
33
  fileMenu?: FileMenuSettingsModel;
34
34
 
35
+ /**
36
+ * Defines the properties of ribbon backstage.
37
+ *
38
+ * @default {}
39
+ */
40
+ backStageMenu?: BackStageMenuModel;
41
+
35
42
  /**
36
43
  * Defines the icon CSS for the launcher icon button in group header.
37
44
  *
@@ -87,10 +94,20 @@ export interface RibbonModel extends ComponentModel{
87
94
  * The help pane appears on the right side of the ribbon header row.
88
95
  *
89
96
  * @default ''
97
+ * @angularType string | object | HTMLElement
98
+ * @reactType string | function | JSX.Element | HTMLElement
99
+ * @vueType string | function | HTMLElement
90
100
  * @aspType string
91
101
  */
92
102
  helpPaneTemplate?: string | HTMLElement | Function;
93
103
 
104
+ /**
105
+ * Defines whether to show the layout switcher button or not.
106
+ *
107
+ * @default false
108
+ */
109
+ hideLayoutSwitcher?: boolean;
110
+
94
111
  /**
95
112
  * Event triggers before selecting the tab item.
96
113
  *
@@ -126,4 +143,11 @@ export interface RibbonModel extends ComponentModel{
126
143
  */
127
144
  launcherIconClick?: EmitType<LauncherClickEventArgs>;
128
145
 
146
+ /**
147
+ * Event triggers once the Ribbon Component rendering is completed.
148
+ *
149
+ * @event created
150
+ */
151
+ created?: EmitType<Event>;
152
+
129
153
  }
@@ -1,11 +1,11 @@
1
1
  import { Component, EmitType } from '@syncfusion/ej2-base';
2
2
  import { INotifyPropertyChanged, ModuleDeclaration } from '@syncfusion/ej2-base';
3
3
  import { Tab, TabAnimationSettingsModel } from '@syncfusion/ej2-navigations';
4
- import { RibbonTabModel, RibbonGroupModel, RibbonCollectionModel, RibbonItemModel, FileMenuSettingsModel } from '../models/index';
4
+ import { RibbonTabModel, RibbonGroupModel, RibbonCollectionModel, RibbonItemModel, FileMenuSettingsModel, BackStageMenuModel } from '../models/index';
5
5
  import { RibbonModel } from './ribbon-model';
6
6
  import { ExpandCollapseEventArgs, LauncherClickEventArgs, RibbonLayout, ribbonTooltipData, TabSelectedEventArgs, TabSelectingEventArgs } from './interface';
7
- import { RibbonButton, RibbonComboBox, RibbonCheckBox, RibbonDropDown, RibbonColorPicker, RibbonSplitButton } from '../items/index';
8
- import { RibbonFileMenu } from '../modules/index';
7
+ import { RibbonButton, RibbonComboBox, RibbonCheckBox, RibbonDropDown, RibbonColorPicker, RibbonSplitButton, RibbonGroupButton } from '../items/index';
8
+ import { RibbonFileMenu, RibbonBackstage } from '../modules/index';
9
9
  import { DropDownButton } from '@syncfusion/ej2-splitbuttons';
10
10
  /**
11
11
  * The Ribbon Component is a structured layout to manage tools with tabs and groups.
@@ -34,6 +34,12 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
34
34
  * @default {}
35
35
  */
36
36
  fileMenu: FileMenuSettingsModel;
37
+ /**
38
+ * Defines the properties of ribbon backstage.
39
+ *
40
+ * @default {}
41
+ */
42
+ backStageMenu: BackStageMenuModel;
37
43
  /**
38
44
  * Defines the icon CSS for the launcher icon button in group header.
39
45
  *
@@ -82,9 +88,18 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
82
88
  * The help pane appears on the right side of the ribbon header row.
83
89
  *
84
90
  * @default ''
91
+ * @angularType string | object | HTMLElement
92
+ * @reactType string | function | JSX.Element | HTMLElement
93
+ * @vueType string | function | HTMLElement
85
94
  * @aspType string
86
95
  */
87
96
  helpPaneTemplate: string | HTMLElement | Function;
97
+ /**
98
+ * Defines whether to show the layout switcher button or not.
99
+ *
100
+ * @default false
101
+ */
102
+ hideLayoutSwitcher: boolean;
88
103
  /**
89
104
  * Event triggers before selecting the tab item.
90
105
  *
@@ -115,6 +130,12 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
115
130
  * @event launcherIconClick
116
131
  */
117
132
  launcherIconClick: EmitType<LauncherClickEventArgs>;
133
+ /**
134
+ * Event triggers once the Ribbon Component rendering is completed.
135
+ *
136
+ * @event created
137
+ */
138
+ created: EmitType<Event>;
118
139
  /**
119
140
  * The `ribbonButtonModule` is used to create and manipulate buttons in ribbon item.
120
141
  */
@@ -143,6 +164,14 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
143
164
  * The `ribbonFileMenuModule` is used to create and manipulate the ribbon file menu.
144
165
  */
145
166
  ribbonFileMenuModule: RibbonFileMenu;
167
+ /**
168
+ * The `ribbonBackstageModule` is used to create and manipulate the ribbon backstage.
169
+ */
170
+ ribbonBackstageModule: RibbonBackstage;
171
+ /**
172
+ * The `ribbonGroupButtonModule` is used to create and manipulate group button in ribbon item.
173
+ */
174
+ ribbonGroupButtonModule: RibbonGroupButton;
146
175
  private itemIndex;
147
176
  private idIndex;
148
177
  private isAddRemove;
@@ -224,6 +253,7 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
224
253
  private checkGroupExpanding;
225
254
  private checkSmallToMedium;
226
255
  private checkMediumToLarge;
256
+ private handleContentSize;
227
257
  private setItemSize;
228
258
  private createOverflowDropdown;
229
259
  private removeOverflowDropdown;
@@ -274,6 +304,36 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
274
304
  * @returns {void}
275
305
  */
276
306
  selectTab(tabId: string): void;
307
+ /**
308
+ * Shows a specific tab in the ribbon.
309
+ *
310
+ * @param {string} tabId - The ID of the tab to be shown.
311
+ * @returns {void}
312
+ */
313
+ showTab(tabId: string): void;
314
+ /**
315
+ * Hides a specific tab in the ribbon.
316
+ *
317
+ * @param {string} tabId - The ID of the tab to be hidden.
318
+ * @returns {void}
319
+ */
320
+ hideTab(tabId: string): void;
321
+ private showHideTab;
322
+ /**
323
+ * Enables a specific tab in the ribbon.
324
+ *
325
+ * @param {string} tabId - The ID of the tab to be enabled.
326
+ * @returns {void}
327
+ */
328
+ enableTab(tabId: string): void;
329
+ /**
330
+ * Disables a specific tab in the ribbon.
331
+ *
332
+ * @param {string} tabId - The ID of the tab to be disabled.
333
+ * @returns {void}
334
+ */
335
+ disableTab(tabId: string): void;
336
+ private enableDisableTab;
277
337
  /**
278
338
  * Adds the ribbon tab.
279
339
  *
@@ -307,6 +367,36 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
307
367
  * @returns {void}
308
368
  */
309
369
  removeGroup(groupId: string): void;
370
+ /**
371
+ * Hides a specific group within a ribbon tab.
372
+ *
373
+ * @param {string} groupID - The ID of the group to be hidden.
374
+ * @returns {void}
375
+ */
376
+ hideGroup(groupID: string): void;
377
+ /**
378
+ * Shows a specific group within a ribbon tab.
379
+ *
380
+ * @param {string} groupID - The ID of the group to be shown.
381
+ * @returns {void}
382
+ */
383
+ showGroup(groupID: string): void;
384
+ private showHideGroup;
385
+ /**
386
+ * Disables a specific group within a ribbon tab.
387
+ *
388
+ * @param {string} groupID - The ID of the group to be disabled.
389
+ * @returns {void}
390
+ */
391
+ disableGroup(groupID: string): void;
392
+ /**
393
+ * Enables a specific group within a ribbon tab.
394
+ *
395
+ * @param {string} groupID - The ID of the group to be enabled.
396
+ * @returns {void}
397
+ */
398
+ enableGroup(groupID: string): void;
399
+ private enableDisableGroup;
310
400
  /**
311
401
  * adds the ribbon collection.
312
402
  *
@@ -341,6 +431,21 @@ export declare class Ribbon extends Component<HTMLElement> implements INotifyPro
341
431
  * @returns {void}
342
432
  */
343
433
  removeItem(itemId: string): void;
434
+ /**
435
+ * Hides a specific ribbon item.
436
+ *
437
+ * @param {string} itemId - The ID of the item to be hidden.
438
+ * @returns {void}
439
+ */
440
+ hideItem(itemId: string): void;
441
+ /**
442
+ * Shows a specific ribbon item.
443
+ *
444
+ * @param {string} itemId - The ID of the item to be shown.
445
+ * @returns {void}
446
+ */
447
+ showItem(itemId: string): void;
448
+ private showHideItem;
344
449
  /**
345
450
  * tab - Gets the ribbon tab to be updated. The id of the tab is a required property. Other properties are optional.
346
451
  *