@syncfusion/ej2-ribbon 30.2.4 → 31.1.17

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

@@ -0,0 +1,141 @@
+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';
+import { RibbonGroupButtonSettingsModel } from './ribbon-group-button-settings-model';
+import { RibbonGallerySettingsModel } from './ribbon-gallery-settings-model';
+/**
+ * Defines the ribbon item.
+ */
+export declare class RibbonItem extends ChildProperty<RibbonItem> {
+    /**
+     * Defines the key tip text to be accessed for specified Ribbon item.
+     *
+     * @default ''
+     */
+    keyTip: string;
+    /**
+     * 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 ''
+     * @angularType string | object | HTMLElement
+     * @reactType string | function | JSX.Element | HTMLElement
+     * @vueType string | function | HTMLElement
+     * @aspType string
+     */
+    itemTemplate: string | HTMLElement | Function;
+    /**
+     * 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;
+    /**
+     * Defines the properties for group button in Ribbon
+     *
+     * @default {}
+     */
+    groupButtonSettings: RibbonGroupButtonSettingsModel;
+    /**
+     * Defines the properties of the gallery view in Ribbon.
+     *
+     * @default {}
+     */
+    gallerySettings: RibbonGallerySettingsModel;
+    /**
+     * @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/dist/ts/ribbon/models/ribbon-item.ts

@@ -0,0 +1,190 @@
+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';
+import { RibbonGroupButtonSettingsModel } from './ribbon-group-button-settings-model';
+import { RibbonGroupButtonSettings } from './ribbon-group-button-settings';
+import { RibbonGallerySettingsModel } from './ribbon-gallery-settings-model';
+import { RibbonGallerySettings } from './ribbon-gallery-settings';
+
+/**
+ * Defines the ribbon item.
+ */
+export class RibbonItem extends ChildProperty<RibbonItem>  {
+
+    /**
+     * Defines the key tip text to be accessed for specified Ribbon item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public keyTip: string;
+
+    /**
+     * Defines the active size of the ribbon item.
+     *
+     * @default 'Medium'
+     * @aspNumberEnum
+     */
+    @Property(RibbonItemSize.Medium)
+    public activeSize : RibbonItemSize;
+
+    /**
+     * Defines the sizes that are allowed for the ribbon item on ribbon resize.
+     *
+     * @default null
+     * @aspNumberEnum
+     */
+    @Property(RibbonItemSize.Small | RibbonItemSize.Medium | RibbonItemSize.Large)
+    public allowedSizes: RibbonItemSize;
+
+    /**
+     * Defines a unique identifier for the item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public id: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    @Property(false)
+    public disabled: boolean;
+
+    /**
+     * Defines the template content for the ribbon item.
+     * `ActiveSize` property is passed as string in template context.
+     *
+     * @default ''
+     * @angularType string | object | HTMLElement
+     * @reactType string | function | JSX.Element | HTMLElement
+     * @vueType string | function | HTMLElement
+     * @aspType string
+     */
+    @Property('')
+    public itemTemplate: string | HTMLElement | Function;
+
+    /**
+     * Defines the type of control to be added as the Ribbon Item.
+     *
+     * @isenumeration true
+     * @default RibbonItemType.Button
+     * @asptype RibbonItemType
+     */
+    @Property('Button')
+    public type: RibbonItemType | string;
+
+    /**
+     * Defines the display options for the ribbon item.
+     *
+     * @default 'Auto'
+     * @aspNumberEnum
+     */
+    @Property(DisplayMode.Auto)
+    public displayOptions: DisplayMode;
+
+    /**
+     * Defines the settings for the tooltip of the item.
+     *
+     * @default {}
+     */
+    @Complex<RibbonTooltipModel>({}, RibbonTooltip)
+    public ribbonTooltipSettings: RibbonTooltipModel;
+
+    /**
+     * Defines the settings for the ribbon button.
+     *
+     * @default {}
+     */
+    @Complex<RibbonButtonSettingsModel>({}, RibbonButtonSettings)
+    public buttonSettings: RibbonButtonSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon dropdown button.
+     *
+     * @default {}
+     */
+    @Complex<RibbonDropDownSettingsModel>({}, RibbonDropDownSettings)
+    public dropDownSettings: RibbonDropDownSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon checkbox.
+     *
+     * @default {}
+     */
+    @Complex<RibbonCheckBoxSettingsModel>({}, RibbonCheckBoxSettings)
+    public checkBoxSettings: RibbonCheckBoxSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon color picker.
+     *
+     * @default {}
+     */
+    @Complex<RibbonColorPickerSettingsModel>({}, RibbonColorPickerSettings)
+    public colorPickerSettings: RibbonColorPickerSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon combobox.
+     *
+     * @default {}
+     */
+    @Complex<RibbonComboBoxSettingsModel>({}, RibbonComboBoxSettings)
+    public comboBoxSettings: RibbonComboBoxSettingsModel;
+
+    /**
+     * Defines the settings for the ribbon split button.
+     *
+     * @default {}
+     */
+    @Complex<RibbonSplitButtonSettingsModel>({}, RibbonSplitButtonSettings)
+    public splitButtonSettings: RibbonSplitButtonSettingsModel;
+
+    /**
+     * Defines the properties for group button in Ribbon
+     *
+     * @default {}
+     */
+    @Complex<RibbonGroupButtonSettingsModel>({}, RibbonGroupButtonSettings)
+    public groupButtonSettings: RibbonGroupButtonSettingsModel;
+
+    /**
+     * Defines the properties of the gallery view in Ribbon.
+     *
+     * @default {}
+     */
+    @Complex<RibbonGallerySettingsModel>({}, RibbonGallerySettings)
+    public gallerySettings: RibbonGallerySettingsModel;
+
+    /**
+     * @param {Object} prop - Gets the property of item.
+     * @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-splitbutton-settings-model.d.ts

@@ -0,0 +1,114 @@
+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;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the SplitButton.
+     *
+     * @default {}
+     */
+    htmlAttributes?: { [key: string]: string };
+
+    /**
+     * 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/dist/ts/ribbon/models/ribbon-splitbutton-settings.d.ts

@@ -0,0 +1,107 @@
+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;
+    /**
+     * Specifies additional HTML attributes to be applied to the SplitButton.
+     *
+     * @default {}
+     */
+    htmlAttributes: {
+        [key: string]: string;
+    };
+    /**
+     * 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/dist/ts/ribbon/models/ribbon-splitbutton-settings.ts

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