@syncfusion/ej2-ribbon 21.1.35

package/src/ribbon/models/ribbon-file-menu-settings-model.d.ts

@@ -0,0 +1,108 @@
+import { ChildProperty, Property, Event, EmitType, Complex, Collection, BaseEventArgs } from '@syncfusion/ej2-base';import { MenuAnimationSettings, MenuAnimationSettingsModel, MenuItem, MenuItemModel } from '@syncfusion/ej2-navigations';import { RibbonTooltip } from './ribbon-tooltip';import { RibbonTooltipModel } from './ribbon-tooltip-model';
+import {FileMenuBeforeOpenCloseEventArgs,FileMenuEventArgs,FileMenuOpenCloseEventArgs} from "./ribbon-file-menu-settings";
+
+/**
+ * Interface for a class FileMenuSettings
+ */
+export interface FileMenuSettingsModel {
+
+    /**
+     * Defines the text content of file menu button.
+     *
+     * @default 'File'
+     */
+    text?: string;
+
+    /**
+     * Defines whether to show the file menu button.
+     *
+     * @default false
+     */
+    visible?: boolean;
+
+    /**
+     * Defines the list of menu items for the file menu.
+     *
+     * @default []
+     */
+    menuItems?: MenuItemModel[];
+
+    /**
+     * Specifies whether to show the sub menu or not on click.
+     * When set to true, the sub menu will open only on mouse click.
+     *
+     * @default false
+     */
+    showItemOnClick?: boolean;
+
+    /**
+     * Specifies the animation settings for the sub menu open/close.
+     *
+     * @default ''
+     */
+    animationSettings?: MenuAnimationSettingsModel;
+
+    /**
+     * Specifies the template for file menu item.
+     *
+     * @default ''
+     */
+    itemTemplate?: string;
+
+    /**
+     * Specifies the custom content for the file menu popup.
+     *
+     * @default ''
+     */
+    popupTemplate?: string | HTMLElement;
+
+    /**
+     * Specifies the tooltip settings for the file menu button.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings?: RibbonTooltipModel;
+
+    /**
+     * Event triggers before closing the file menu popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose?: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers before opening the file menu popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen?: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while rendering each ribbon file menu item.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender?: EmitType<FileMenuEventArgs>;
+
+    /**
+     * Event triggers when file menu popup is closed.
+     *
+     * @event close
+     */
+    close?: EmitType<FileMenuOpenCloseEventArgs>;
+
+    /**
+     * Event triggers when file menu popup is opened.
+     *
+     * @event open
+     */
+    open?: EmitType<FileMenuOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while selecting an item in ribbon file menu.
+     *
+     * @event select
+     */
+    select?: EmitType<FileMenuEventArgs>;
+
+}

package/src/ribbon/models/ribbon-file-menu-settings.d.ts

@@ -0,0 +1,159 @@
+import { ChildProperty, EmitType, BaseEventArgs } from '@syncfusion/ej2-base';
+import { MenuAnimationSettingsModel, MenuItemModel } from '@syncfusion/ej2-navigations';
+import { RibbonTooltipModel } from './ribbon-tooltip-model';
+/**
+ * Defines the ribbon file menu settings.
+ */
+export declare class FileMenuSettings extends ChildProperty<FileMenuSettings> {
+    /**
+     * Defines the text content of file menu button.
+     *
+     * @default 'File'
+     */
+    text: string;
+    /**
+     * Defines whether to show the file menu button.
+     *
+     * @default false
+     */
+    visible: boolean;
+    /**
+     * Defines the list of menu items for the file menu.
+     *
+     * @default []
+     */
+    menuItems: MenuItemModel[];
+    /**
+     * Specifies whether to show the sub menu or not on click.
+     * When set to true, the sub menu will open only on mouse click.
+     *
+     * @default false
+     */
+    showItemOnClick: boolean;
+    /**
+     * Specifies the animation settings for the sub menu open/close.
+     *
+     * @default ''
+     */
+    animationSettings: MenuAnimationSettingsModel;
+    /**
+     * Specifies the template for file menu item.
+     *
+     * @default ''
+     */
+    itemTemplate: string;
+    /**
+     * Specifies the custom content for the file menu popup.
+     *
+     * @default ''
+     */
+    popupTemplate: string | HTMLElement;
+    /**
+     * Specifies the tooltip settings for the file menu button.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings: RibbonTooltipModel;
+    /**
+     * Event triggers before closing the file menu popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+    /**
+     * Event triggers before opening the file menu popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+    /**
+     * Event triggers while rendering each ribbon file menu item.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender: EmitType<FileMenuEventArgs>;
+    /**
+     * Event triggers when file menu popup is closed.
+     *
+     * @event close
+     */
+    close: EmitType<FileMenuOpenCloseEventArgs>;
+    /**
+     * Event triggers when file menu popup is opened.
+     *
+     * @event open
+     */
+    open: EmitType<FileMenuOpenCloseEventArgs>;
+    /**
+     * Event triggers while selecting an item in ribbon file menu.
+     *
+     * @event select
+     */
+    select: EmitType<FileMenuEventArgs>;
+    /**
+     * @param {Object} prop - Gets the property of FileMenu.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}
+/**
+ * Event Triggers when selecting or creating the file menu item.
+ */
+export interface FileMenuEventArgs extends BaseEventArgs {
+    /**
+     *  Provides the HTML element of the file menu item.
+     */
+    element: HTMLElement;
+    /**
+     * Provides the file menu item object.
+     */
+    item: MenuItemModel;
+    /**
+     * Provides the actual native event.
+     */
+    event?: Event;
+}
+/**
+ * Event Triggers when opening or closing the file menu.
+ */
+export interface FileMenuOpenCloseEventArgs extends BaseEventArgs {
+    /**
+     *  Provides the HTML element of the file menu popup.
+     */
+    element: HTMLElement;
+    /**
+     * Provides the file menu item object.
+     */
+    items?: MenuItemModel[];
+    /**
+     * Provides the parent file menu item of the popup, in case of sub-menu.
+     */
+    parentItem?: MenuItemModel;
+}
+/**
+ * Event Triggers before opening or closing the file menu.
+ */
+export interface FileMenuBeforeOpenCloseEventArgs extends BaseEventArgs {
+    /**
+     * Defines whether to cancel the file menu popup opening or closing.
+     */
+    cancel: boolean;
+    /**
+     *  Provides the HTML element of the file menu popup.
+     */
+    element: HTMLElement;
+    /**
+     * Provides the file menu item object.
+     */
+    items?: MenuItemModel[];
+    /**
+     * Provides the parent file menu item of the popup, in case of sub-menu.
+     */
+    parentItem?: MenuItemModel;
+    /**
+     * Provides the actual native event.
+     */
+    event: Event;
+}

package/src/ribbon/models/ribbon-file-menu-settings.js

@@ -0,0 +1,84 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { ChildProperty, Property, Event, Complex, Collection } from '@syncfusion/ej2-base';
+import { MenuAnimationSettings, MenuItem } from '@syncfusion/ej2-navigations';
+import { RibbonTooltip } from './ribbon-tooltip';
+/**
+ * Defines the ribbon file menu settings.
+ */
+var FileMenuSettings = /** @class */ (function (_super) {
+    __extends(FileMenuSettings, _super);
+    function FileMenuSettings() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @param {Object} prop - Gets the property of FileMenu.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    FileMenuSettings.prototype.setProperties = function (prop, muteOnChange) {
+        _super.prototype.setProperties.call(this, prop, muteOnChange);
+    };
+    __decorate([
+        Property('File')
+    ], FileMenuSettings.prototype, "text", void 0);
+    __decorate([
+        Property(false)
+    ], FileMenuSettings.prototype, "visible", void 0);
+    __decorate([
+        Collection([], MenuItem)
+    ], FileMenuSettings.prototype, "menuItems", void 0);
+    __decorate([
+        Property(false)
+    ], FileMenuSettings.prototype, "showItemOnClick", void 0);
+    __decorate([
+        Complex({}, MenuAnimationSettings)
+    ], FileMenuSettings.prototype, "animationSettings", void 0);
+    __decorate([
+        Property('')
+    ], FileMenuSettings.prototype, "itemTemplate", void 0);
+    __decorate([
+        Property('')
+    ], FileMenuSettings.prototype, "popupTemplate", void 0);
+    __decorate([
+        Complex({}, RibbonTooltip)
+    ], FileMenuSettings.prototype, "ribbonTooltipSettings", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "beforeClose", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "beforeOpen", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "beforeItemRender", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "close", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "open", void 0);
+    __decorate([
+        Event()
+    ], FileMenuSettings.prototype, "select", void 0);
+    return FileMenuSettings;
+}(ChildProperty));
+export { FileMenuSettings };

package/src/ribbon/models/ribbon-group-model.d.ts

@@ -0,0 +1,91 @@
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';import { RibbonCollectionModel } from './ribbon-collection-model';import { ItemOrientation } from '../base/interface';import { RibbonCollection } from './ribbon-collection';
+
+/**
+ * Interface for a class RibbonGroup
+ */
+export interface RibbonGroupModel {
+
+    /**
+     * Defines the list of ribbon collections.
+     *
+     * @default []
+     * @aspType List<RibbonCollection>
+     */
+    collections?: RibbonCollectionModel[];
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of group.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines a unique identifier for the group.
+     *
+     * @default ''
+     */
+    id?: string;
+
+    /**
+     * Defines whether the group is in collapsed state or not during classic mode.
+     *
+     * @default false
+     */
+    isCollapsed?: boolean;
+
+    /**
+     * Defines whether the group can be collapsed on resize during classic mode.
+     *
+     * @default true
+     */
+    isCollapsible?: boolean;
+
+    /**
+     * Defines whether to add a separate popup for the overflow items in the group.
+     * If it is set to false, the overflow items will be shown in the common overflow popup present at the right end of the tab content.
+     *
+     * @default false
+     */
+    enableGroupOverflow?: boolean;
+
+    /**
+     * Defines the CSS class for the icons to be shown in the group overflow dropdown button in classic mode.
+     * During overflow, the entire group will be shown in a popup of a dropdown button which appears in the place of the group in ribbon tab.
+     *
+     * @default ''
+     */
+    groupIconCss?: string;
+
+    /**
+     * Defines the content of group header.
+     *
+     * @default ''
+     */
+    header?: string;
+
+    /**
+     * Defines whether to orientation in which the items of the group should be arranged.
+     *
+     * @isenumeration true
+     * @default ItemOrientation.Column
+     * @aspType ItemOrientation
+     */
+    orientation?: ItemOrientation | string;
+
+    /**
+     * Defines the priority order at which the group should be collapsed or expanded.
+     * For collapsing value is fetched in ascending order and for expanding value is fetched in descending order.
+     *
+     * @default 0
+     */
+    priority?: number;
+
+    /**
+     * Defines whether to show or hide the launcher icon for the group.
+     *
+     * @default false
+     */
+    showLauncherIcon?: boolean;
+
+}

package/src/ribbon/models/ribbon-group.d.ts

@@ -0,0 +1,87 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { RibbonCollectionModel } from './ribbon-collection-model';
+import { ItemOrientation } from '../base/interface';
+/**
+ * Defines the ribbon group.
+ */
+export declare class RibbonGroup extends ChildProperty<RibbonGroup> {
+    /**
+     * Defines the list of ribbon collections.
+     *
+     * @default []
+     * @aspType List<RibbonCollection>
+     */
+    collections: RibbonCollectionModel[];
+    /**
+     * Defines one or more CSS classes to customize the appearance of group.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines a unique identifier for the group.
+     *
+     * @default ''
+     */
+    id: string;
+    /**
+     * Defines whether the group is in collapsed state or not during classic mode.
+     *
+     * @default false
+     */
+    isCollapsed: boolean;
+    /**
+     * Defines whether the group can be collapsed on resize during classic mode.
+     *
+     * @default true
+     */
+    isCollapsible: boolean;
+    /**
+     * Defines whether to add a separate popup for the overflow items in the group.
+     * If it is set to false, the overflow items will be shown in the common overflow popup present at the right end of the tab content.
+     *
+     * @default false
+     */
+    enableGroupOverflow: boolean;
+    /**
+     * Defines the CSS class for the icons to be shown in the group overflow dropdown button in classic mode.
+     * During overflow, the entire group will be shown in a popup of a dropdown button which appears in the place of the group in ribbon tab.
+     *
+     * @default ''
+     */
+    groupIconCss: string;
+    /**
+     * Defines the content of group header.
+     *
+     * @default ''
+     */
+    header: string;
+    /**
+     * Defines whether to orientation in which the items of the group should be arranged.
+     *
+     * @isenumeration true
+     * @default ItemOrientation.Column
+     * @aspType ItemOrientation
+     */
+    orientation: ItemOrientation | string;
+    /**
+     * Defines the priority order at which the group should be collapsed or expanded.
+     * For collapsing value is fetched in ascending order and for expanding value is fetched in descending order.
+     *
+     * @default 0
+     */
+    priority: number;
+    /**
+     * Defines whether to show or hide the launcher icon for the group.
+     *
+     * @default false
+     */
+    showLauncherIcon: boolean;
+    /**
+     * @param {Object} prop - Gets the property of Group.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}

package/src/ribbon/models/ribbon-group.js

@@ -0,0 +1,74 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';
+import { RibbonCollection } from './ribbon-collection';
+/**
+ * Defines the ribbon group.
+ */
+var RibbonGroup = /** @class */ (function (_super) {
+    __extends(RibbonGroup, _super);
+    function RibbonGroup() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @param {Object} prop - Gets the property of Group.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    RibbonGroup.prototype.setProperties = function (prop, muteOnChange) {
+        _super.prototype.setProperties.call(this, prop, muteOnChange);
+    };
+    __decorate([
+        Collection([], RibbonCollection)
+    ], RibbonGroup.prototype, "collections", void 0);
+    __decorate([
+        Property('')
+    ], RibbonGroup.prototype, "cssClass", void 0);
+    __decorate([
+        Property('')
+    ], RibbonGroup.prototype, "id", void 0);
+    __decorate([
+        Property(false)
+    ], RibbonGroup.prototype, "isCollapsed", void 0);
+    __decorate([
+        Property(true)
+    ], RibbonGroup.prototype, "isCollapsible", void 0);
+    __decorate([
+        Property(false)
+    ], RibbonGroup.prototype, "enableGroupOverflow", void 0);
+    __decorate([
+        Property('')
+    ], RibbonGroup.prototype, "groupIconCss", void 0);
+    __decorate([
+        Property('')
+    ], RibbonGroup.prototype, "header", void 0);
+    __decorate([
+        Property('Column')
+    ], RibbonGroup.prototype, "orientation", void 0);
+    __decorate([
+        Property(0)
+    ], RibbonGroup.prototype, "priority", void 0);
+    __decorate([
+        Property(false)
+    ], RibbonGroup.prototype, "showLauncherIcon", void 0);
+    return RibbonGroup;
+}(ChildProperty));
+export { RibbonGroup };