@syncfusion/ej2-ribbon 30.2.4 → 31.1.17

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

@@ -0,0 +1,74 @@
+import { ChildProperty, Event, EmitType, Property } from '@syncfusion/ej2-base';
+import { LabelPosition, ChangeEventArgs } from '@syncfusion/ej2-buttons';
+
+/**
+ * Defines the ribbon checkbox item.
+ */
+export class RibbonCheckBoxSettings extends ChildProperty<RibbonCheckBoxSettings>  {
+
+    /**
+     * Defines the whether the checkbox is checked or not.
+     *
+     * @default false
+     */
+    @Property(false)
+    public checked: boolean;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of checkbox.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Defines the label for the checkbox.
+     *
+     * @default ''
+     */
+    @Property('')
+    public label: string;
+
+    /**
+     * Defines whether the label is position `After` or `Before` the checkbox.
+     *
+     * @default 'After'
+     */
+    @Property('After')
+    public labelPosition: LabelPosition;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the checkbox.
+     *
+     * @default {}
+     */
+    @Property({})
+    public htmlAttributes: { [key: string]: string };
+
+    /**
+     * Event triggers once the checkbox is created.
+     *
+     * @event created
+     */
+    @Event()
+    public created: EmitType<Event>;
+
+    /**
+     * Event triggers when the checkbox state is changed.
+     *
+     * @event change
+     */
+    @Event()
+    public change: EmitType<ChangeEventArgs>;
+
+    /**
+     * @param {Object} prop - Gets the property of checkbox.
+     * @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-collection-model.d.ts

@@ -0,0 +1,30 @@
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';import { RibbonItem } from './ribbon-item';import { RibbonItemModel } from './ribbon-item-model';
+
+/**
+ * Interface for a class RibbonCollection
+ */
+export interface RibbonCollectionModel {
+
+    /**
+     * Defines a unique identifier for the collection.
+     *
+     * @default ''
+     */
+    id?: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of collection.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Defines the list of ribbon items.
+     *
+     * @default []
+     * @aspType List<RibbonItem>
+     */
+    items?: RibbonItemModel[];
+
+}

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

@@ -0,0 +1,33 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { RibbonItemModel } from './ribbon-item-model';
+/**
+ * Defines the items of Ribbon.
+ */
+export declare class RibbonCollection extends ChildProperty<RibbonCollection> {
+    /**
+     * Defines a unique identifier for the collection.
+     *
+     * @default ''
+     */
+    id: string;
+    /**
+     * Defines one or more CSS classes to customize the appearance of collection.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Defines the list of ribbon items.
+     *
+     * @default []
+     * @aspType List<RibbonItem>
+     */
+    items: RibbonItemModel[];
+    /**
+     * @param {Object} prop - Gets the property of collection.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}

package/dist/ts/ribbon/models/ribbon-collection.ts

@@ -0,0 +1,45 @@
+import { ChildProperty, Collection, Property } from '@syncfusion/ej2-base';
+import { RibbonItem } from './ribbon-item';
+import { RibbonItemModel } from './ribbon-item-model';
+
+/**
+ * Defines the items of Ribbon.
+ */
+export class RibbonCollection extends ChildProperty<RibbonCollection>  {
+
+    /**
+     * Defines a unique identifier for the collection.
+     *
+     * @default ''
+     */
+    @Property('')
+    public id: string;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of collection.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Defines the list of ribbon items.
+     *
+     * @default []
+     * @aspType List<RibbonItem>
+     */
+    @Collection<RibbonItemModel>([], RibbonItem)
+    public items: RibbonItemModel[];
+
+    /**
+     * @param {Object} prop - Gets the property of collection.
+     * @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-colorpicker-settings-model.d.ts

@@ -0,0 +1,137 @@
+import { ChildProperty, Event, EmitType, Property } from '@syncfusion/ej2-base';import { ColorPickerMode, ChangeEventArgs, OpenEventArgs, PaletteTileEventArgs, BeforeOpenCloseEventArgs, ColorPickerEventArgs } from '@syncfusion/ej2-inputs';
+
+/**
+ * Interface for a class RibbonColorPickerSettings
+ */
+export interface RibbonColorPickerSettingsModel {
+
+    /**
+     * Defines the number of columns to be rendered in the color picker palette.
+     *
+     * @default 10
+     */
+    columns?: number;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of the color picker.
+     *
+     * @default ''
+     */
+    cssClass?: string;
+
+    /**
+     * Specifies the label text for the overflow item.
+     *
+     * @default ''
+     */
+    label?: string;
+
+    /**
+     * Defines whether to enable the opacity option in the color picker.
+     *
+     * @default true
+     */
+    enableOpacity?: boolean;
+
+    /**
+     * Defines the rendering mode of the color picker.
+     *
+     * @default 'Palette'
+     */
+    mode?: ColorPickerMode;
+
+    /**
+     * Defines whether to show / hide the mode switcher button in the color picker.
+     *
+     * @default true
+     */
+    modeSwitcher?: boolean;
+
+    /**
+     * Defines whether to enable / disable the palette section in the color picker.
+     *
+     * @default false
+     */
+    noColor?: boolean;
+
+    /**
+     * Defines the custom colors to load in the color picker palette.
+     *
+     * @default null
+     */
+    presetColors?: { [key: string]: string[] };
+
+    /**
+     * Defines whether to show / hide the control buttons (apply / cancel) in the color picker.
+     *
+     * @default true
+     */
+    showButtons?: boolean;
+
+    /**
+     * Specifies the value of the color picker.
+     * The value should be a valid hex color code.
+     *
+     * @default '#008000ff'
+     */
+    value?: string;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the color picker.
+     *
+     * @default {}
+     */
+    htmlAttributes?: { [key: string]: string };
+
+    /**
+     * Event triggers before closing the ColorPicker popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose?: EmitType<BeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers before opening the ColorPicker popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen?: EmitType<BeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while rendering each palette tile.
+     *
+     * @event beforeTileRender
+     */
+    beforeTileRender?: EmitType<PaletteTileEventArgs>;
+
+    /**
+     * Event triggers once the color picker is created.
+     *
+     * @event created
+     */
+    created?: EmitType<Event>;
+
+    /**
+     * Event triggers while changing the colors. It will be triggered based on the showButtons property.
+     * If the property is false, the event will be triggered while selecting the colors.
+     * If the property is true, the event will be triggered while apply the selected color.
+     *
+     * @event change
+     */
+    change?: EmitType<ChangeEventArgs>;
+
+    /**
+     * Event triggers while opening the ColorPicker popup.
+     *
+     * @event open
+     */
+    open?: EmitType<OpenEventArgs>;
+
+    /**
+     * Event triggers while selecting the color in picker / palette, when showButtons property is enabled.
+     *
+     * @event select
+     */
+    select?: EmitType<ColorPickerEventArgs>;
+
+}

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

@@ -0,0 +1,129 @@
+import { ChildProperty, EmitType } from '@syncfusion/ej2-base';
+import { ColorPickerMode, ChangeEventArgs, OpenEventArgs, PaletteTileEventArgs, BeforeOpenCloseEventArgs, ColorPickerEventArgs } from '@syncfusion/ej2-inputs';
+/**
+ * Defines the ribbon color picker.
+ */
+export declare class RibbonColorPickerSettings extends ChildProperty<RibbonColorPickerSettings> {
+    /**
+     * Defines the number of columns to be rendered in the color picker palette.
+     *
+     * @default 10
+     */
+    columns: number;
+    /**
+     * Defines one or more CSS classes to customize the appearance of the color picker.
+     *
+     * @default ''
+     */
+    cssClass: string;
+    /**
+     * Specifies the label text for the overflow item.
+     *
+     * @default ''
+     */
+    label: string;
+    /**
+     * Defines whether to enable the opacity option in the color picker.
+     *
+     * @default true
+     */
+    enableOpacity: boolean;
+    /**
+     * Defines the rendering mode of the color picker.
+     *
+     * @default 'Palette'
+     */
+    mode: ColorPickerMode;
+    /**
+     * Defines whether to show / hide the mode switcher button in the color picker.
+     *
+     * @default true
+     */
+    modeSwitcher: boolean;
+    /**
+     * Defines whether to enable / disable the palette section in the color picker.
+     *
+     * @default false
+     */
+    noColor: boolean;
+    /**
+     * Defines the custom colors to load in the color picker palette.
+     *
+     * @default null
+     */
+    presetColors: {
+        [key: string]: string[];
+    };
+    /**
+     * Defines whether to show / hide the control buttons (apply / cancel) in the color picker.
+     *
+     * @default true
+     */
+    showButtons: boolean;
+    /**
+     * Specifies the value of the color picker.
+     * The value should be a valid hex color code.
+     *
+     * @default '#008000ff'
+     */
+    value: string;
+    /**
+     * Specifies additional HTML attributes to be applied to the color picker.
+     *
+     * @default {}
+     */
+    htmlAttributes: {
+        [key: string]: string;
+    };
+    /**
+     * Event triggers before closing the ColorPicker popup.
+     *
+     * @event beforeClose
+     */
+    beforeClose: EmitType<BeforeOpenCloseEventArgs>;
+    /**
+     * Event triggers before opening the ColorPicker popup.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen: EmitType<BeforeOpenCloseEventArgs>;
+    /**
+     * Event triggers while rendering each palette tile.
+     *
+     * @event beforeTileRender
+     */
+    beforeTileRender: EmitType<PaletteTileEventArgs>;
+    /**
+     * Event triggers once the color picker is created.
+     *
+     * @event created
+     */
+    created: EmitType<Event>;
+    /**
+     * Event triggers while changing the colors. It will be triggered based on the showButtons property.
+     * If the property is false, the event will be triggered while selecting the colors.
+     * If the property is true, the event will be triggered while apply the selected color.
+     *
+     * @event change
+     */
+    change: EmitType<ChangeEventArgs>;
+    /**
+     * Event triggers while opening the ColorPicker popup.
+     *
+     * @event open
+     */
+    open: EmitType<OpenEventArgs>;
+    /**
+     * Event triggers while selecting the color in picker / palette, when showButtons property is enabled.
+     *
+     * @event select
+     */
+    select: EmitType<ColorPickerEventArgs>;
+    /**
+     * @param {Object} prop - Gets the property of colorpicker.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    setProperties(prop: Object, muteOnChange: boolean): void;
+}

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

@@ -0,0 +1,165 @@
+import { ChildProperty, Event, EmitType, Property } from '@syncfusion/ej2-base';
+import { ColorPickerMode, ChangeEventArgs, OpenEventArgs, PaletteTileEventArgs, BeforeOpenCloseEventArgs, ColorPickerEventArgs } from '@syncfusion/ej2-inputs';
+
+/**
+ * Defines the ribbon color picker.
+ */
+export class RibbonColorPickerSettings extends ChildProperty<RibbonColorPickerSettings>  {
+
+    /**
+     * Defines the number of columns to be rendered in the color picker palette.
+     *
+     * @default 10
+     */
+    @Property(10)
+    public columns: number;
+
+    /**
+     * Defines one or more CSS classes to customize the appearance of the color picker.
+     *
+     * @default ''
+     */
+    @Property('')
+    public cssClass: string;
+
+    /**
+     * Specifies the label text for the overflow item.
+     *
+     * @default ''
+     */
+    @Property('')
+    public label: string;
+
+    /**
+     * Defines whether to enable the opacity option in the color picker.
+     *
+     * @default true
+     */
+    @Property(true)
+    public enableOpacity: boolean;
+
+    /**
+     * Defines the rendering mode of the color picker.
+     *
+     * @default 'Palette'
+     */
+    @Property('Palette')
+    public mode: ColorPickerMode;
+
+    /**
+     * Defines whether to show / hide the mode switcher button in the color picker.
+     *
+     * @default true
+     */
+    @Property(true)
+    public modeSwitcher: boolean;
+
+    /**
+     * Defines whether to enable / disable the palette section in the color picker.
+     *
+     * @default false
+     */
+    @Property(false)
+    public noColor: boolean;
+
+    /**
+     * Defines the custom colors to load in the color picker palette.
+     *
+     * @default null
+     */
+    @Property(null)
+    public presetColors: { [key: string]: string[] };
+
+    /**
+     * Defines whether to show / hide the control buttons (apply / cancel) in the color picker.
+     *
+     * @default true
+     */
+    @Property(true)
+    public showButtons: boolean;
+
+    /**
+     * Specifies the value of the color picker.
+     * The value should be a valid hex color code.
+     *
+     * @default '#008000ff'
+     */
+    @Property('#008000ff')
+    public value: string;
+
+    /**
+     * Specifies additional HTML attributes to be applied to the color picker.
+     *
+     * @default {}
+     */
+    @Property({})
+    public htmlAttributes: { [key: string]: string };
+
+    /**
+     * Event triggers before closing the ColorPicker popup.
+     *
+     * @event beforeClose
+     */
+    @Event()
+    public beforeClose: EmitType<BeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers before opening the ColorPicker popup.
+     *
+     * @event beforeOpen
+     */
+    @Event()
+    public beforeOpen: EmitType<BeforeOpenCloseEventArgs>;
+
+    /**
+     * Event triggers while rendering each palette tile.
+     *
+     * @event beforeTileRender
+     */
+    @Event()
+    public beforeTileRender: EmitType<PaletteTileEventArgs>;
+
+    /**
+     * Event triggers once the color picker is created.
+     *
+     * @event created
+     */
+    @Event()
+    public created: EmitType<Event>;
+
+    /**
+     * Event triggers while changing the colors. It will be triggered based on the showButtons property.
+     * If the property is false, the event will be triggered while selecting the colors.
+     * If the property is true, the event will be triggered while apply the selected color.
+     *
+     * @event change
+     */
+    @Event()
+    public change: EmitType<ChangeEventArgs>;
+
+    /**
+     * Event triggers while opening the ColorPicker popup.
+     *
+     * @event open
+     */
+    @Event()
+    public open: EmitType<OpenEventArgs>;
+
+    /**
+     * Event triggers while selecting the color in picker / palette, when showButtons property is enabled.
+     *
+     * @event select
+     */
+    @Event()
+    public select: EmitType<ColorPickerEventArgs>;
+
+    /**
+     * @param {Object} prop - Gets the property of colorpicker.
+     * @param {boolean} muteOnChange - Gets the boolean value of muteOnChange.
+     * @returns {void}
+     * @private
+     */
+    public setProperties(prop: Object, muteOnChange: boolean): void {
+        super.setProperties(prop, muteOnChange);
+    }
+}