@syncfusion/ej2-ribbon 30.1.42 → 31.1.17

package/dist/ts/ribbon/models/ribbon-gallery-group.d.ts

@@ -0,0 +1,38 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { RibbonGalleryItemModel } from './ribbon-gallery-item-model';
+/**
+ * Defines the ribbon gallery group.
+ */
+export declare class RibbonGalleryGroup extends ChildProperty<RibbonGalleryGroup> {
+    /**
+     * 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;
+}

package/dist/ts/ribbon/models/ribbon-gallery-group.ts

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

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

@@ -0,0 +1,43 @@
+import { ChildProperty, Property } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class RibbonGalleryItem
+ */
+export interface RibbonGalleryItemModel {
+
+    /**
+     * Defines the content for the gallery item.
+     *
+     * @default ''
+     */
+    content?: string;
+
+    /**
+     * Defines the image or icons for the gallery item.
+     *
+     * @default ''
+     */
+    iconCss?: string;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the Ribbon Gallery item.
+     *
+     * @default {}
+     */
+    htmlAttributes?: { [key: string]: string };
+
+    /**
+     * Defines the CSS class to customize the gallery items.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+
+}

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

@@ -0,0 +1,38 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Defines the ribbon gallery item.
+ */
+export declare class RibbonGalleryItem extends ChildProperty<RibbonGalleryItem> {
+    /**
+     * Defines the content for the gallery item.
+     *
+     * @default ''
+     */
+    content: string;
+    /**
+     * Defines the image or icons for the gallery item.
+     *
+     * @default ''
+     */
+    iconCss: string;
+    /**
+     * Specifies additional HTML attributes to be applied to the Ribbon Gallery item.
+     *
+     * @default {}
+     */
+    htmlAttributes: {
+        [key: string]: string;
+    };
+    /**
+     * Defines the CSS class to customize the gallery items.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    disabled: boolean;
+}

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

@@ -0,0 +1,47 @@
+import { ChildProperty, Property } from '@syncfusion/ej2-base';
+
+/**
+ * Defines the ribbon gallery item.
+ */
+export class RibbonGalleryItem extends ChildProperty<RibbonGalleryItem>  {
+
+    /**
+     * Defines the content for the gallery item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public content: string;
+
+    /**
+     * Defines the image or icons for the gallery item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public iconCss: string;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the Ribbon Gallery item.
+     *
+     * @default {}
+     */
+    @Property({})
+    public htmlAttributes: { [key: string]: string };
+
+    /**
+     * Defines the CSS class to customize the gallery items.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Defines whether the item is disabled or not.
+     *
+     * @default false
+     */
+    @Property(false)
+    public disabled: boolean;
+}

package/dist/ts/ribbon/models/ribbon-gallery-settings-model.d.ts

@@ -0,0 +1,108 @@
+import { ChildProperty, Collection, EmitType, Property, Event } from '@syncfusion/ej2-base';import { RibbonGalleryGroupModel } from './ribbon-gallery-group-model';import { RibbonGalleryGroup } from './ribbon-gallery-group';import { GalleryHoverEventArgs, GalleryItemEventArgs, GalleryPopupEventArgs, GallerySelectEventArgs, GalleryBeforeSelectEventArgs } from '../base/interface';
+
+/**
+ * Interface for a class RibbonGallerySettings
+ */
+export interface RibbonGallerySettingsModel {
+
+    /**
+     * Defines the properties for collection of gallery items in the Ribbon.
+     *
+     * @default []
+     * @aspType List<RibbonGalleryGroup>
+     */
+    groups?: RibbonGalleryGroupModel[];
+
+    /**
+     * Defines the number of items to be displayed in the Ribbon Gallery.
+     *
+     * @default 3
+     */
+    itemCount?: number;
+
+    /**
+     * Defines the index of current selected gallery item.
+     *
+     * @default null
+     */
+    selectedItemIndex?: number;
+
+    /**
+     * Defines the height of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    popupHeight?: string;
+
+    /**
+     * Defines the width of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    popupWidth?: string;
+
+    /**
+     * Defines the template for gallery items contents. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template?: string | Function;
+
+    /**
+     * Defines the template for gallery items in popup. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    popupTemplate?: string | Function;
+
+    /**
+     * Event triggers when the gallery popup opens.
+     *
+     * @event popupOpen
+     */
+    popupOpen?: EmitType<GalleryPopupEventArgs>;
+
+    /**
+     * Event triggers when the gallery popup closes.
+     *
+     * @event popupClose
+     */
+    popupClose?: EmitType<GalleryPopupEventArgs>;
+
+    /**
+     * Event triggers when a user hovers over a gallery item.
+     *
+     * @event itemHover
+     */
+    itemHover?: EmitType<GalleryHoverEventArgs>;
+
+    /**
+     * Event triggers before rendering each gallery item.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender?: EmitType<GalleryItemEventArgs>;
+
+    /**
+     * Event triggers before the gallery items selects.
+     *
+     * @event beforeSelect
+     */
+    beforeSelect?: EmitType<GalleryBeforeSelectEventArgs>;
+
+    /**
+     * Event triggers when the gallery items selects.
+     *
+     * @event select
+     */
+    select?: EmitType<GallerySelectEventArgs>;
+
+}

package/dist/ts/ribbon/models/ribbon-gallery-settings.d.ts

@@ -0,0 +1,95 @@
+import { ChildProperty, EmitType } from '@syncfusion/ej2-base';
+import { RibbonGalleryGroupModel } from './ribbon-gallery-group-model';
+import { GalleryHoverEventArgs, GalleryItemEventArgs, GalleryPopupEventArgs, GallerySelectEventArgs, GalleryBeforeSelectEventArgs } from '../base/interface';
+/**
+ * Defines the ribbon gallery settings.
+ */
+export declare class RibbonGallerySettings extends ChildProperty<RibbonGallerySettings> {
+    /**
+     * Defines the properties for collection of gallery items in the Ribbon.
+     *
+     * @default []
+     * @aspType List<RibbonGalleryGroup>
+     */
+    groups: RibbonGalleryGroupModel[];
+    /**
+     * Defines the number of items to be displayed in the Ribbon Gallery.
+     *
+     * @default 3
+     */
+    itemCount: number;
+    /**
+     * Defines the index of current selected gallery item.
+     *
+     * @default null
+     */
+    selectedItemIndex: number;
+    /**
+     * Defines the height of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    popupHeight: string;
+    /**
+     * Defines the width of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    popupWidth: string;
+    /**
+     * Defines the template for gallery items contents. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template: string | Function;
+    /**
+     * Defines the template for gallery items in popup. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    popupTemplate: string | Function;
+    /**
+     * Event triggers when the gallery popup opens.
+     *
+     * @event popupOpen
+     */
+    popupOpen: EmitType<GalleryPopupEventArgs>;
+    /**
+     * Event triggers when the gallery popup closes.
+     *
+     * @event popupClose
+     */
+    popupClose: EmitType<GalleryPopupEventArgs>;
+    /**
+     * Event triggers when a user hovers over a gallery item.
+     *
+     * @event itemHover
+     */
+    itemHover: EmitType<GalleryHoverEventArgs>;
+    /**
+     * Event triggers before rendering each gallery item.
+     *
+     * @event beforeItemRender
+     */
+    beforeItemRender: EmitType<GalleryItemEventArgs>;
+    /**
+     * Event triggers before the gallery items selects.
+     *
+     * @event beforeSelect
+     */
+    beforeSelect: EmitType<GalleryBeforeSelectEventArgs>;
+    /**
+     * Event triggers when the gallery items selects.
+     *
+     * @event select
+     */
+    select: EmitType<GallerySelectEventArgs>;
+}

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

@@ -0,0 +1,123 @@
+import { ChildProperty, Collection, EmitType, Property, Event } from '@syncfusion/ej2-base';
+import { RibbonGalleryGroupModel } from './ribbon-gallery-group-model';
+import { RibbonGalleryGroup } from './ribbon-gallery-group';
+import { GalleryHoverEventArgs, GalleryItemEventArgs, GalleryPopupEventArgs, GallerySelectEventArgs, GalleryBeforeSelectEventArgs } from '../base/interface';
+
+/**
+ * Defines the ribbon gallery settings.
+ */
+export class RibbonGallerySettings extends ChildProperty<RibbonGallerySettings>  {
+
+    /**
+     * Defines the properties for collection of gallery items in the Ribbon.
+     *
+     * @default []
+     * @aspType List<RibbonGalleryGroup>
+     */
+    @Collection<RibbonGalleryGroupModel>([], RibbonGalleryGroup)
+    public groups: RibbonGalleryGroupModel[];
+
+    /**
+     * Defines the number of items to be displayed in the Ribbon Gallery.
+     *
+     * @default 3
+     */
+    @Property(3)
+    public itemCount: number;
+
+    /**
+     * Defines the index of current selected gallery item.
+     *
+     * @default null
+     */
+    @Property(null)
+    public selectedItemIndex: number;
+
+    /**
+     * Defines the height of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    @Property('auto')
+    public popupHeight: string;
+
+    /**
+     * Defines the width of the ribbon gallery popup.
+     *
+     * @default 'auto'
+     */
+    @Property('auto')
+    public popupWidth: string;
+
+    /**
+     * Defines the template for gallery items contents. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property('')
+    public template: string | Function;
+
+    /**
+     * Defines the template for gallery items in popup. The current gallery item model passed as context to build the content.
+     *
+     * @default ''
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property('')
+    public popupTemplate: string | Function;
+
+    /**
+     * Event triggers when the gallery popup opens.
+     *
+     * @event popupOpen
+     */
+    @Event()
+    public popupOpen: EmitType<GalleryPopupEventArgs>;
+
+    /**
+     * Event triggers when the gallery popup closes.
+     *
+     * @event popupClose
+     */
+    @Event()
+    public popupClose: EmitType<GalleryPopupEventArgs>;
+
+    /**
+     * Event triggers when a user hovers over a gallery item.
+     *
+     * @event itemHover
+     */
+    @Event()
+    public itemHover: EmitType<GalleryHoverEventArgs>;
+
+    /**
+     * Event triggers before rendering each gallery item.
+     *
+     * @event beforeItemRender
+     */
+    @Event()
+    public beforeItemRender: EmitType<GalleryItemEventArgs>;
+
+    /**
+     * Event triggers before the gallery items selects.
+     *
+     * @event beforeSelect
+     */
+    @Event()
+    public beforeSelect: EmitType<GalleryBeforeSelectEventArgs>;
+
+    /**
+     * Event triggers when the gallery items selects.
+     *
+     * @event select
+     */
+    @Event()
+    public select: EmitType<GallerySelectEventArgs>;
+}

package/dist/ts/ribbon/models/ribbon-group-button-item-model.d.ts

@@ -0,0 +1,64 @@
+import { ChildProperty, Event, EmitType, Property, Complex } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class RibbonGroupButtonItem
+ */
+export interface RibbonGroupButtonItemModel {
+
+    /**
+     * Defines the content for the button.
+     *
+     * @default ''
+     */
+    content?: string;
+
+    /**
+     * Defines the CSS class for the icons to be shown in button.
+     *
+     * @default ''
+     */
+    iconCss?: string;
+
+    /**
+     * Specifies the keytip content.
+     *
+     * @default ''
+     */
+    keyTip?: string;
+
+    /**
+     * Specifies the tooltip settings for the group button items.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings?: RibbonTooltipModel;
+
+    /**
+     * Defines whether the button is selected or not.
+     *
+     * @default false
+     */
+    selected?: boolean;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the group button item.
+     *
+     * @default {}
+     */
+    htmlAttributes?: { [key: string]: string };
+
+    /**
+     * Triggers before clicking the button from group button.
+     *
+     * @event beforeClick
+     */
+    beforeClick?: EmitType<BeforeClickGroupButtonEventArgs>;
+
+    /**
+     * Triggers after clicking the button from group button.
+     *
+     * @event click
+     */
+    click?: EmitType<ClickGroupButtonEventArgs>;
+
+}

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

@@ -0,0 +1,65 @@
+import { ChildProperty, EmitType } from '@syncfusion/ej2-base';
+import { BeforeClickGroupButtonEventArgs, ClickGroupButtonEventArgs } from '../base/interface';
+import { RibbonTooltipModel } from './ribbon-tooltip-model';
+/**
+ * Defines the ribbon group button settings.
+ */
+export declare class RibbonGroupButtonItem extends ChildProperty<RibbonGroupButtonItem> {
+    /**
+     * Defines the content for the button.
+     *
+     * @default ''
+     */
+    content: string;
+    /**
+     * Defines the CSS class for the icons to be shown in button.
+     *
+     * @default ''
+     */
+    iconCss: string;
+    /**
+     * Specifies the keytip content.
+     *
+     * @default ''
+     */
+    keyTip: string;
+    /**
+     * Specifies the tooltip settings for the group button items.
+     *
+     * @default {}
+     */
+    ribbonTooltipSettings: RibbonTooltipModel;
+    /**
+     * Defines whether the button is selected or not.
+     *
+     * @default false
+     */
+    selected: boolean;
+    /**
+     * Specifies additional HTML attributes to be applied to the group button item.
+     *
+     * @default {}
+     */
+    htmlAttributes: {
+        [key: string]: string;
+    };
+    /**
+     * Triggers before clicking the button from group button.
+     *
+     * @event beforeClick
+     */
+    beforeClick: EmitType<BeforeClickGroupButtonEventArgs>;
+    /**
+     * Triggers after clicking the button from group button.
+     *
+     * @event click
+     */
+    click: EmitType<ClickGroupButtonEventArgs>;
+    /**
+     * @param {Object} prop - Gets the property of group button.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}