@syncfusion/ej2-ribbon 21.1.35

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

@@ -0,0 +1,120 @@
+import { ChildProperty, Complex, Property } from '@syncfusion/ej2-base';import { RibbonItemType, RibbonItemSize, DisplayMode } from '../base/interface';import { RibbonButtonSettings } from './ribbon-button-settings';import { RibbonButtonSettingsModel } from './ribbon-button-settings-model';import { RibbonCheckBoxSettings } from './ribbon-checkbox-settings';import { RibbonCheckBoxSettingsModel } from './ribbon-checkbox-settings-model';import { RibbonColorPickerSettings } from './ribbon-colorpicker-settings';import { RibbonColorPickerSettingsModel } from './ribbon-colorpicker-settings-model';import { RibbonComboBoxSettings } from './ribbon-combobox-settings';import { RibbonComboBoxSettingsModel } from './ribbon-combobox-settings-model';import { RibbonDropDownSettings } from './ribbon-dropdown-settings';import { RibbonDropDownSettingsModel } from './ribbon-dropdown-settings-model';import { RibbonSplitButtonSettings } from './ribbon-splitbutton-settings';import { RibbonSplitButtonSettingsModel } from './ribbon-splitbutton-settings-model';import { RibbonTooltip } from './ribbon-tooltip';import { RibbonTooltipModel } from './ribbon-tooltip-model';
+
+/**
+ * Interface for a class RibbonItem
+ */
+export interface RibbonItemModel {
+
+    /**
+     * Defines the active size of the ribbon item.
+     *
+     * @default 'Medium'
+     * @aspNumberEnum
+     */
+    activeSize?: RibbonItemSize;
+
+    /**
+     * Defines the sizes that are allowed for the ribbon item on ribbon resize.
+     *
+     * @default null
+     * @aspNumberEnum
+     */
+    allowedSizes?: RibbonItemSize;
+
+    /**
+     * Defines a unique identifier for the item.
+     *
+     * @default ''
+     */
+    id?: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of item.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+
+    /**
+     * Defines the template content for the ribbon item.
+     * `ActiveSize` property is passed as string in template context.
+     *
+     * @default ''
+     * @aspType string
+     */
+    itemTemplate?: string | HTMLElement;
+
+    /**
+     * Defines the type of control to be added as the Ribbon Item.
+     *
+     * @isenumeration true
+     * @default RibbonItemType.Button
+     * @asptype RibbonItemType
+     */
+    type?: RibbonItemType | string;
+
+    /**
+     * Defines the display options for the ribbon item.
+     *
+     * @default 'Auto'
+     * @aspNumberEnum
+     */
+    displayOptions?: DisplayMode;
+
+    /**
+     * Defines the settings for the tooltip of the item.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings?: RibbonTooltipModel;
+
+    /**
+     * Defines the settings for the ribbon button.
+     *
+     * @default {}
+     */
+    buttonSettings?: RibbonButtonSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon dropdown button.
+     *
+     * @default {}
+     */
+    dropDownSettings?: RibbonDropDownSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon checkbox.
+     *
+     * @default {}
+     */
+    checkBoxSettings?: RibbonCheckBoxSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon color picker.
+     *
+     * @default {}
+     */
+    colorPickerSettings?: RibbonColorPickerSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon combobox.
+     *
+     * @default {}
+     */
+    comboBoxSettings?: RibbonComboBoxSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon split button.
+     *
+     * @default {}
+     */
+    splitButtonSettings?: RibbonSplitButtonSettingsModel;
+
+}

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

@@ -0,0 +1,118 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { RibbonItemType, RibbonItemSize, DisplayMode } from '../base/interface';
+import { RibbonButtonSettingsModel } from './ribbon-button-settings-model';
+import { RibbonCheckBoxSettingsModel } from './ribbon-checkbox-settings-model';
+import { RibbonColorPickerSettingsModel } from './ribbon-colorpicker-settings-model';
+import { RibbonComboBoxSettingsModel } from './ribbon-combobox-settings-model';
+import { RibbonDropDownSettingsModel } from './ribbon-dropdown-settings-model';
+import { RibbonSplitButtonSettingsModel } from './ribbon-splitbutton-settings-model';
+import { RibbonTooltipModel } from './ribbon-tooltip-model';
+/**
+ * Defines the ribbon item.
+ */
+export declare class RibbonItem extends ChildProperty<RibbonItem> {
+    /**
+     * Defines the active size of the ribbon item.
+     *
+     * @default 'Medium'
+     * @aspNumberEnum
+     */
+    activeSize: RibbonItemSize;
+    /**
+     * Defines the sizes that are allowed for the ribbon item on ribbon resize.
+     *
+     * @default null
+     * @aspNumberEnum
+     */
+    allowedSizes: RibbonItemSize;
+    /**
+     * Defines a unique identifier for the item.
+     *
+     * @default ''
+     */
+    id: string;
+    /**
+     * Defines one or more CSS classes to customize the appearance of item.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    disabled: boolean;
+    /**
+     * Defines the template content for the ribbon item.
+     * `ActiveSize` property is passed as string in template context.
+     *
+     * @default ''
+     * @aspType string
+     */
+    itemTemplate: string | HTMLElement;
+    /**
+     * Defines the type of control to be added as the Ribbon Item.
+     *
+     * @isenumeration true
+     * @default RibbonItemType.Button
+     * @asptype RibbonItemType
+     */
+    type: RibbonItemType | string;
+    /**
+     * Defines the display options for the ribbon item.
+     *
+     * @default 'Auto'
+     * @aspNumberEnum
+     */
+    displayOptions: DisplayMode;
+    /**
+     * Defines the settings for the tooltip of the item.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings: RibbonTooltipModel;
+    /**
+     * Defines the settings for the ribbon button.
+     *
+     * @default {}
+     */
+    buttonSettings: RibbonButtonSettingsModel;
+    /**
+     * Defines the settings for the ribbon dropdown button.
+     *
+     * @default {}
+     */
+    dropDownSettings: RibbonDropDownSettingsModel;
+    /**
+     * Defines the settings for the ribbon checkbox.
+     *
+     * @default {}
+     */
+    checkBoxSettings: RibbonCheckBoxSettingsModel;
+    /**
+     * Defines the settings for the ribbon color picker.
+     *
+     * @default {}
+     */
+    colorPickerSettings: RibbonColorPickerSettingsModel;
+    /**
+     * Defines the settings for the ribbon combobox.
+     *
+     * @default {}
+     */
+    comboBoxSettings: RibbonComboBoxSettingsModel;
+    /**
+     * Defines the settings for the ribbon split button.
+     *
+     * @default {}
+     */
+    splitButtonSettings: RibbonSplitButtonSettingsModel;
+    /**
+     * @param {Object} prop - Gets the property of item.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}

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

@@ -0,0 +1,93 @@
+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, Complex, Property } from '@syncfusion/ej2-base';
+import { RibbonItemSize, DisplayMode } from '../base/interface';
+import { RibbonButtonSettings } from './ribbon-button-settings';
+import { RibbonCheckBoxSettings } from './ribbon-checkbox-settings';
+import { RibbonColorPickerSettings } from './ribbon-colorpicker-settings';
+import { RibbonComboBoxSettings } from './ribbon-combobox-settings';
+import { RibbonDropDownSettings } from './ribbon-dropdown-settings';
+import { RibbonSplitButtonSettings } from './ribbon-splitbutton-settings';
+import { RibbonTooltip } from './ribbon-tooltip';
+/**
+ * Defines the ribbon item.
+ */
+var RibbonItem = /** @class */ (function (_super) {
+    __extends(RibbonItem, _super);
+    function RibbonItem() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @param {Object} prop - Gets the property of item.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    RibbonItem.prototype.setProperties = function (prop, muteOnChange) {
+        _super.prototype.setProperties.call(this, prop, muteOnChange);
+    };
+    __decorate([
+        Property(RibbonItemSize.Medium)
+    ], RibbonItem.prototype, "activeSize", void 0);
+    __decorate([
+        Property(RibbonItemSize.Small | RibbonItemSize.Medium | RibbonItemSize.Large)
+    ], RibbonItem.prototype, "allowedSizes", void 0);
+    __decorate([
+        Property('')
+    ], RibbonItem.prototype, "id", void 0);
+    __decorate([
+        Property('')
+    ], RibbonItem.prototype, "cssClass", void 0);
+    __decorate([
+        Property(false)
+    ], RibbonItem.prototype, "disabled", void 0);
+    __decorate([
+        Property('')
+    ], RibbonItem.prototype, "itemTemplate", void 0);
+    __decorate([
+        Property('Button')
+    ], RibbonItem.prototype, "type", void 0);
+    __decorate([
+        Property(DisplayMode.Auto)
+    ], RibbonItem.prototype, "displayOptions", void 0);
+    __decorate([
+        Complex({}, RibbonTooltip)
+    ], RibbonItem.prototype, "ribbonTooltipSettings", void 0);
+    __decorate([
+        Complex({}, RibbonButtonSettings)
+    ], RibbonItem.prototype, "buttonSettings", void 0);
+    __decorate([
+        Complex({}, RibbonDropDownSettings)
+    ], RibbonItem.prototype, "dropDownSettings", void 0);
+    __decorate([
+        Complex({}, RibbonCheckBoxSettings)
+    ], RibbonItem.prototype, "checkBoxSettings", void 0);
+    __decorate([
+        Complex({}, RibbonColorPickerSettings)
+    ], RibbonItem.prototype, "colorPickerSettings", void 0);
+    __decorate([
+        Complex({}, RibbonComboBoxSettings)
+    ], RibbonItem.prototype, "comboBoxSettings", void 0);
+    __decorate([
+        Complex({}, RibbonSplitButtonSettings)
+    ], RibbonItem.prototype, "splitButtonSettings", void 0);
+    return RibbonItem;
+}(ChildProperty));
+export { RibbonItem };

package/src/ribbon/models/ribbon-splitbutton-settings-model.d.ts

@@ -0,0 +1,107 @@
+import { ChildProperty, Collection, Event, EmitType, Property } from '@syncfusion/ej2-base';import { ItemModel, Item, BeforeOpenCloseMenuEventArgs, MenuEventArgs, OpenCloseMenuEventArgs, ClickEventArgs } from '@syncfusion/ej2-splitbuttons';
+
+/**
+ * Interface for a class RibbonSplitButtonSettings
+ */
+export interface RibbonSplitButtonSettingsModel {
+
+    /**
+     * Specifies the event to close the SplitButton popup.
+     *
+     * @default ''
+     */
+    closeActionEvents?: string;
+
+    /**
+     * Specifies the content of the SplitButton.
+     *
+     * @default ''
+     */
+    content?: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of SplitButton.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines the CSS class for the icons to be shown in the SplitButton.
+     *
+     * @default ''
+     */
+    iconCss?: string;
+
+    /**
+     * Defines the list of items for the SplitButton popup.
+     *
+     * @default []
+     */
+    items?: ItemModel[];
+
+    /**
+     * Specifies the selector for the element to be shown in the SplitButton popup.
+     *
+     * @default ''
+     * @aspType string
+     */
+    target?: string | HTMLElement;
+
+    /**
+     * Triggers before closing the SplitButton popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose?: EmitType<BeforeOpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while rendering each Popup item of SplitButton.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender?: EmitType<MenuEventArgs>;
+
+    /**
+     * Triggers before opening the SplitButton popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while closing the SplitButton popup.
+     *
+     * @event close
+     */
+    close?: EmitType<OpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while clicking the primary button in SplitButton.
+     *
+     * @event click
+     */
+    click?: EmitType<ClickEventArgs>;
+
+    /**
+     * Event triggers once the SplitButton is created.
+     *
+     * @event created
+     */
+    created?: EmitType<Event>;
+
+    /**
+     * Triggers while opening the SplitButton popup.
+     *
+     * @event open
+     */
+    open?: EmitType<OpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while selecting an action item in SplitButton popup.
+     *
+     * @event select
+     */
+    select?: EmitType<MenuEventArgs>;
+
+}

package/src/ribbon/models/ribbon-splitbutton-settings.d.ts

@@ -0,0 +1,99 @@
+import { ChildProperty, EmitType } from '@syncfusion/ej2-base';
+import { ItemModel, BeforeOpenCloseMenuEventArgs, MenuEventArgs, OpenCloseMenuEventArgs, ClickEventArgs } from '@syncfusion/ej2-splitbuttons';
+/**
+ * Defines the ribbon SplitButton item.
+ */
+export declare class RibbonSplitButtonSettings extends ChildProperty<RibbonSplitButtonSettings> {
+    /**
+     * Specifies the event to close the SplitButton popup.
+     *
+     * @default ''
+     */
+    closeActionEvents: string;
+    /**
+     * Specifies the content of the SplitButton.
+     *
+     * @default ''
+     */
+    content: string;
+    /**
+     * Defines one or more CSS classes to customize the appearance of SplitButton.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines the CSS class for the icons to be shown in the SplitButton.
+     *
+     * @default ''
+     */
+    iconCss: string;
+    /**
+     * Defines the list of items for the SplitButton popup.
+     *
+     * @default []
+     */
+    items: ItemModel[];
+    /**
+     * Specifies the selector for the element to be shown in the SplitButton popup.
+     *
+     * @default ''
+     * @aspType string
+     */
+    target: string | HTMLElement;
+    /**
+     * Triggers before closing the SplitButton popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose: EmitType<BeforeOpenCloseMenuEventArgs>;
+    /**
+     * Triggers while rendering each Popup item of SplitButton.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender: EmitType<MenuEventArgs>;
+    /**
+     * Triggers before opening the SplitButton popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
+    /**
+     * Triggers while closing the SplitButton popup.
+     *
+     * @event close
+     */
+    close: EmitType<OpenCloseMenuEventArgs>;
+    /**
+     * Triggers while clicking the primary button in SplitButton.
+     *
+     * @event click
+     */
+    click: EmitType<ClickEventArgs>;
+    /**
+     * Event triggers once the SplitButton is created.
+     *
+     * @event created
+     */
+    created: EmitType<Event>;
+    /**
+     * Triggers while opening the SplitButton popup.
+     *
+     * @event open
+     */
+    open: EmitType<OpenCloseMenuEventArgs>;
+    /**
+     * Triggers while selecting an action item in SplitButton popup.
+     *
+     * @event select
+     */
+    select: EmitType<MenuEventArgs>;
+    /**
+     * @param {Object} prop - Gets the property of DropDown.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}

package/src/ribbon/models/ribbon-splitbutton-settings.js

@@ -0,0 +1,83 @@
+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, Event, Property } from '@syncfusion/ej2-base';
+import { Item } from '@syncfusion/ej2-splitbuttons';
+/**
+ * Defines the ribbon SplitButton item.
+ */
+var RibbonSplitButtonSettings = /** @class */ (function (_super) {
+    __extends(RibbonSplitButtonSettings, _super);
+    function RibbonSplitButtonSettings() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @param {Object} prop - Gets the property of DropDown.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    RibbonSplitButtonSettings.prototype.setProperties = function (prop, muteOnChange) {
+        _super.prototype.setProperties.call(this, prop, muteOnChange);
+    };
+    __decorate([
+        Property('')
+    ], RibbonSplitButtonSettings.prototype, "closeActionEvents", void 0);
+    __decorate([
+        Property('')
+    ], RibbonSplitButtonSettings.prototype, "content", void 0);
+    __decorate([
+        Property('')
+    ], RibbonSplitButtonSettings.prototype, "cssClass", void 0);
+    __decorate([
+        Property('')
+    ], RibbonSplitButtonSettings.prototype, "iconCss", void 0);
+    __decorate([
+        Collection([], Item)
+    ], RibbonSplitButtonSettings.prototype, "items", void 0);
+    __decorate([
+        Property('')
+    ], RibbonSplitButtonSettings.prototype, "target", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "beforeClose", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "beforeItemRender", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "beforeOpen", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "close", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "click", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "created", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "open", void 0);
+    __decorate([
+        Event()
+    ], RibbonSplitButtonSettings.prototype, "select", void 0);
+    return RibbonSplitButtonSettings;
+}(ChildProperty));
+export { RibbonSplitButtonSettings };

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

@@ -0,0 +1,37 @@
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';import { RibbonGroup } from './ribbon-group';import { RibbonGroupModel } from './ribbon-group-model';
+
+/**
+ * Interface for a class RibbonTab
+ */
+export interface RibbonTabModel {
+
+    /**
+     * Defines a unique identifier for the tab.
+     *
+     * @default ''
+     */
+    id?: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of tab.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines the list of ribbon groups.
+     *
+     * @default []
+     * @aspType List<RibbonGroup>
+     */
+    groups?: RibbonGroupModel[];
+
+    /**
+     * Defines the content of tab header.
+     *
+     * @default ''
+     */
+    header?: string;
+
+}

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

@@ -0,0 +1,39 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { RibbonGroupModel } from './ribbon-group-model';
+/**
+ * Defines the ribbon tab.
+ */
+export declare class RibbonTab extends ChildProperty<RibbonTab> {
+    /**
+     * Defines a unique identifier for the tab.
+     *
+     * @default ''
+     */
+    id: string;
+    /**
+     * Defines one or more CSS classes to customize the appearance of tab.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines the list of ribbon groups.
+     *
+     * @default []
+     * @aspType List<RibbonGroup>
+     */
+    groups: RibbonGroupModel[];
+    /**
+     * Defines the content of tab header.
+     *
+     * @default ''
+     */
+    header: string;
+    /**
+     * @param {Object} prop - Gets the property of tab.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}