@syncfusion/ej2-ribbon 30.2.4 → 31.1.17

package/dist/ts/ribbon/models/ribbon-dropdown-settings.ts

@@ -0,0 +1,139 @@
+import { ChildProperty, Collection, Event, EmitType, Property } from '@syncfusion/ej2-base';
+import { ItemModel, Item, BeforeOpenCloseMenuEventArgs, MenuEventArgs, OpenCloseMenuEventArgs } from '@syncfusion/ej2-splitbuttons';
+
+/**
+ * Defines the ribbon DropDownButton item.
+ */
+export class RibbonDropDownSettings extends ChildProperty<RibbonDropDownSettings>  {
+
+    /**
+     * Specifies the event to close the DropDownButton popup.
+     *
+     * @default ''
+     */
+    @Property('')
+    public closeActionEvents: string;
+
+    /**
+     * Specifies the content of the DropDownButton.
+     *
+     * @default ''
+     */
+    @Property('')
+    public content: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of DropDownButton.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Defines the CSS class for the icons to be shown in the DropDownButton.
+     *
+     * @default ''
+     */
+    @Property('')
+    public iconCss: string;
+
+    /**
+     * Defines the list of items for the DropDownButton popup.
+     *
+     * @default []
+     */
+    @Collection<ItemModel>([], Item)
+    public items: ItemModel[];
+
+    /**
+     * Specifies the selector for the element to be shown in the DropDownButton popup.
+     *
+     * @default ''
+     * @aspType string
+     */
+    @Property('')
+    public target: string | HTMLElement;
+
+    /**
+     * Specifies whether to create popup element on open.
+     *
+     * @default false
+     */
+    @Property(false)
+    public createPopupOnClick: boolean;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the DropDownButton.
+     *
+     * @default {}
+     */
+    @Property({})
+    public htmlAttributes: { [key: string]: string };
+
+    /**
+     * Triggers before closing the DropDownButton popup.
+     *
+     * @event beforeClose
+     */
+    @Event()
+    public beforeClose: EmitType<BeforeOpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while rendering each Popup item of DropDownButton.
+     *
+     * @event beforeItemRender
+     */
+    @Event()
+    public beforeItemRender: EmitType<MenuEventArgs>;
+
+    /**
+     * Triggers before opening the DropDownButton popup.
+     *
+     * @event beforeOpen
+     */
+    @Event()
+    public beforeOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while closing the DropDownButton popup.
+     *
+     * @event close
+     */
+    @Event()
+    public close: EmitType<OpenCloseMenuEventArgs>;
+
+    /**
+     * Event triggers once the DropDownButton is created.
+     *
+     * @event created
+     */
+    @Event()
+    public created: EmitType<Event>;
+
+    /**
+     * Triggers while opening the DropDownButton popup.
+     *
+     * @event open
+     */
+    @Event()
+    public open: EmitType<OpenCloseMenuEventArgs>;
+
+    /**
+     * Triggers while selecting an action item in DropDownButton popup.
+     *
+     * @event select
+     */
+    @Event()
+    public select: EmitType<MenuEventArgs>;
+
+    /**
+     * @param {Object} prop - Gets the property of DropDown.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    public setProperties(prop: Object, muteOnChange: boolean): void {
+        super.setProperties(prop, muteOnChange);
+    }
+}

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

@@ -0,0 +1,123 @@
+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 ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    itemTemplate?: string | Function;
+
+    /**
+     * Specifies the custom content for the file menu popup.
+     *
+     * @default ''
+     * @angularType string | HTMLElement
+     * @reactType string | HTMLElement | JSX.Element
+     * @vueType string | HTMLElement
+     * @aspType string
+     */
+    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>;
+
+    /**
+     * Specifies the keytip content.
+     *
+     * @default ''
+     */
+    keyTip?: string;
+
+}

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

@@ -0,0 +1,173 @@
+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 ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    itemTemplate: string | Function;
+    /**
+     * Specifies the custom content for the file menu popup.
+     *
+     * @default ''
+     * @angularType string | HTMLElement
+     * @reactType string | HTMLElement | JSX.Element
+     * @vueType string | HTMLElement
+     * @aspType string
+     */
+    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>;
+    /**
+     * Specifies the keytip content.
+     *
+     * @default ''
+     */
+    keyTip: string;
+    /**
+     * @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/dist/ts/ribbon/models/ribbon-file-menu-settings.ts

@@ -0,0 +1,220 @@
+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';
+
+/**
+ * Defines the ribbon file menu settings.
+ */
+export class FileMenuSettings extends ChildProperty<FileMenuSettings>  {
+
+    /**
+     * Defines the text content of file menu button.
+     *
+     * @default 'File'
+     */
+    @Property('File')
+    public text: string;
+
+    /**
+     * Defines whether to show the file menu button.
+     *
+     * @default false
+     */
+    @Property(false)
+    public visible: boolean;
+
+    /**
+     * Defines the list of menu items for the file menu.
+     *
+     * @default []
+     */
+    @Collection<MenuItemModel>([], MenuItem)
+    public 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
+     */
+    @Property(false)
+    public showItemOnClick: boolean;
+
+    /**
+     * Specifies the animation settings for the sub menu open/close.
+     *
+     * @default ''
+     */
+    @Complex<MenuAnimationSettingsModel>({}, MenuAnimationSettings)
+    public animationSettings: MenuAnimationSettingsModel;
+
+    /**
+     * Specifies the template for file menu item.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property('')
+    public itemTemplate: string | Function;
+
+    /**
+     * Specifies the custom content for the file menu popup.
+     *
+     * @default ''
+     * @angularType string | HTMLElement
+     * @reactType string | HTMLElement | JSX.Element
+     * @vueType string | HTMLElement
+     * @aspType string
+     */
+    @Property('')
+    public popupTemplate: string | HTMLElement;
+
+    /**
+     * Specifies the tooltip settings for the file menu button.
+     *
+     * @default {}
+     */
+    @Complex<RibbonTooltipModel>({}, RibbonTooltip)
+    public ribbonTooltipSettings: RibbonTooltipModel;
+
+    /**
+     * Event triggers before closing the file menu popup.
+     *
+     * @event beforeClose
+     */
+    @Event()
+    public beforeClose: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers before opening the file menu popup.
+     *
+     * @event beforeOpen
+     */
+    @Event()
+    public beforeOpen: EmitType<FileMenuBeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while rendering each ribbon file menu item.
+     *
+     * @event beforeItemRender
+     */
+    @Event()
+    public beforeItemRender: EmitType<FileMenuEventArgs>;
+
+    /**
+     * Event triggers when file menu popup is closed.
+     *
+     * @event close
+     */
+    @Event()
+    public close: EmitType<FileMenuOpenCloseEventArgs>;
+
+    /**
+     * Event triggers when file menu popup is opened.
+     *
+     * @event open
+     */
+    @Event()
+    public open: EmitType<FileMenuOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while selecting an item in ribbon file menu.
+     *
+     * @event select
+     */
+    @Event()
+    public select: EmitType<FileMenuEventArgs>;
+
+    /**
+     * Specifies the keytip content.
+     *
+     * @default ''
+     */
+    @Property('')
+    public keyTip: string;
+
+    /**
+     * @param {Object} prop - Gets the property of FileMenu.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    public setProperties(prop: Object, muteOnChange: boolean): void {
+        super.setProperties(prop, muteOnChange);
+    }
+}
+
+/**
+ * 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/dist/ts/ribbon/models/ribbon-gallery-group-model.d.ts

@@ -0,0 +1,44 @@
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';import { RibbonGalleryItemModel } from './ribbon-gallery-item-model';import { RibbonGalleryItem } from './ribbon-gallery-item';
+
+/**
+ * Interface for a class RibbonGalleryGroup
+ */
+export interface RibbonGalleryGroupModel {
+
+    /**
+     * Defines the properties for collection of gallery items in Ribbon.
+     *
+     * @default []
+     * @aspType List<RibbonGalleryItem>
+     */
+    items?: RibbonGalleryItemModel[];
+
+    /**
+     * Defines the header for the group items present in Ribbon Gallery popup.
+     *
+     * @default ''
+     */
+    header?: string;
+
+    /**
+     * Defines the width of the gallery items.
+     *
+     * @default 'auto'
+     */
+    itemWidth?: string;
+
+    /**
+     * Defines the height of the gallery item.
+     *
+     * @default 'auto'
+     */
+    itemHeight?: string;
+
+    /**
+     * Defines the CSS class to customize the gallery groups.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+}