@syncfusion/ej2-navigations 27.2.4 → 28.1.33-686179

package/src/toolbar/toolbar-model.d.ts

@@ -1,4 +1,4 @@
-import { Component, EventHandler, Property, Event, EmitType, BaseEventArgs } from '@syncfusion/ej2-base';import { addClass, removeClass, isVisible, closest, attributes, detach, classList, KeyboardEvents } from '@syncfusion/ej2-base';import { selectAll, setStyleAttribute as setStyle, KeyboardEventArgs, select } from '@syncfusion/ej2-base';import { isNullOrUndefined as isNOU, getUniqueID, formatUnit, Collection, compile as templateCompiler } from '@syncfusion/ej2-base';import { INotifyPropertyChanged, NotifyPropertyChanges, ChildProperty, Browser, SanitizeHtmlHelper } from '@syncfusion/ej2-base';import { Popup } from '@syncfusion/ej2-popups';import { calculatePosition } from '@syncfusion/ej2-popups';import { Button, IconPosition } from '@syncfusion/ej2-buttons';import { HScroll } from '../common/h-scroll';import { VScroll } from '../common/v-scroll';
+import { Component, EventHandler, Property, Event, EmitType, BaseEventArgs } from '@syncfusion/ej2-base';
 import {OverflowOption,ItemType,DisplayMode,ItemAlign,ClickEventArgs,OverflowMode,BeforeCreateArgs} from "./toolbar";
 import {ComponentModel} from '@syncfusion/ej2-base';
 
@@ -8,175 +8,175 @@ import {ComponentModel} from '@syncfusion/ej2-base';
 export interface ItemModel {
 
     /**
-     * Specifies the unique ID to be used with button or input element of Toolbar items.
-     *
-     * @default ""
-     */
-    id?: string;
+     * Specifies the unique ID to be used with button or input element of Toolbar items.
+     *
+     * @default ""
+     */
+    id?: string;
 
     /**
-     * Specifies the text to be displayed on the Toolbar button.
-     *
-     * @default ""
-     */
-    text?: string;
+     * Specifies the text to be displayed on the Toolbar button.
+     *
+     * @default ""
+     */
+    text?: string;
 
     /**
-     * Specifies the width of the Toolbar button commands.
-     *
-     * @default 'auto'
-     */
-    width?: number | string;
+     * Specifies the width of the Toolbar button commands.
+     *
+     * @default 'auto'
+     */
+    width?: number | string;
 
     /**
-     * Defines single/multiple classes (separated by space) to be used for customization of commands.
-     *
-     * @default ""
-     */
-    cssClass?: string;
+     * Defines single/multiple classes (separated by space) to be used for customization of commands.
+     *
+     * @default ""
+     */
+    cssClass?: string;
 
     /**
-     * Defines the priority of items to display it in popup always.
-     * It allows to maintain toolbar item on popup always but it does not work for toolbar priority items.
-     *
-     * @default false
-     */
-    showAlwaysInPopup?: boolean;
+     * Defines the priority of items to display it in popup always.
+     * It allows to maintain toolbar item on popup always but it does not work for toolbar priority items.
+     *
+     * @default false
+     */
+    showAlwaysInPopup?: boolean;
 
     /**
-     * Specifies whether an item should be disabled or not.
-     *
-     * @default false
-     */
-    disabled?: boolean;
+     * Specifies whether an item should be disabled or not.
+     *
+     * @default false
+     */
+    disabled?: boolean;
 
     /**
-     * Defines single/multiple classes separated by space used to specify an icon for the button.
-     * The icon will be positioned before the text content if text is available, otherwise the icon alone will be rendered.
-     *
-     * @default ""
-     */
-    prefixIcon?: string;
+     * Defines single/multiple classes separated by space used to specify an icon for the button.
+     * The icon will be positioned before the text content if text is available, otherwise the icon alone will be rendered.
+     *
+     * @default ""
+     */
+    prefixIcon?: string;
 
     /**
-     * Defines single/multiple classes separated by space used to specify an icon for the button.
-     * The icon will be positioned after the text content if text is available.
-     *
-     * @default ""
-     */
-    suffixIcon?: string;
+     * Defines single/multiple classes separated by space used to specify an icon for the button.
+     * The icon will be positioned after the text content if text is available.
+     *
+     * @default ""
+     */
+    suffixIcon?: string;
 
     /**
-     * Specifies whether an item should be hidden or not.
-     *
-     * @default true
-     */
-    visible?: boolean;
+     * Specifies whether an item should be hidden or not.
+     *
+     * @default true
+     */
+    visible?: boolean;
 
     /**
-     * Specifies the Toolbar command display area when an element's content is too large to fit available space.
-     * This is applicable only to `popup` mode. The possible values for this property as follows
-     * * `Show`:  Always shows the item as the primary priority on the *Toolbar*.
-     * * `Hide`: Always shows the item as the secondary priority on the *popup*.
-     * * `None`: No priority for display, and as per normal order moves to popup when content exceeds.
-     *
-     * @default 'None'
-     */
-    overflow?: OverflowOption;
+     * Specifies the Toolbar command display area when an element's content is too large to fit available space.
+     * This is applicable only to `popup` mode. The possible values for this property as follows
+     * * `Show`:  Always shows the item as the primary priority on the *Toolbar*.
+     * * `Hide`: Always shows the item as the secondary priority on the *popup*.
+     * * `None`: No priority for display, and as per normal order moves to popup when content exceeds.
+     *
+     * @default 'None'
+     */
+    overflow?: OverflowOption;
 
     /**
-     * Specifies the HTML element/element ID as a string that can be added as a Toolbar command.
-     * ```
-     * E.g - items: [{ template: '<input placeholder="Search"/>' },{ template: '#checkbox1' }]
-     * ```
-     *
-     * @default ""
-     * @angularType string | object
-     * @reactType string | function | JSX.Element
-     * @vueType string | function
-     * @aspType string
-     */
-    template?: string | Object | Function;
+     * Specifies the HTML element/element ID as a string that can be added as a Toolbar command.
+     * ```
+     * E.g - items: [{ template: '<input placeholder="Search"/>' },{ template: '#checkbox1' }]
+     * ```
+     *
+     * @default ""
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template?: string | Object | Function;
 
     /**
-     * Specifies the types of command to be rendered in the Toolbar.
-     * Supported types are:
-     * * `Button`: Creates the Button control with its given properties like text, prefixIcon, etc.
-     * * `Separator`: Adds a horizontal line that separates the Toolbar commands.
-     * * `Input`: Creates an input element that is applicable to template rendering with Syncfusion controls like DropDownList,
-     * AutoComplete, etc.
-     *
-     * @default 'Button'
-     */
-    type?: ItemType;
+     * Specifies the types of command to be rendered in the Toolbar.
+     * Supported types are:
+     * * `Button`: Creates the Button control with its given properties like text, prefixIcon, etc.
+     * * `Separator`: Adds a horizontal line that separates the Toolbar commands.
+     * * `Input`: Creates an input element that is applicable to template rendering with Syncfusion controls like DropDownList,
+     * AutoComplete, etc.
+     *
+     * @default 'Button'
+     */
+    type?: ItemType;
 
     /**
-     * Specifies where the button text will be displayed on *popup mode* of the Toolbar.
-     * The possible values for this property as follows
-     * * `Toolbar`:  Text will be displayed on *Toolbar* only.
-     * * `Overflow`: Text will be displayed only when content overflows to *popup*.
-     * * `Both`: Text will be displayed on *popup* and *Toolbar*.
-     *
-     * @default 'Both'
-     */
-    showTextOn?: DisplayMode;
+     * Specifies where the button text will be displayed on *popup mode* of the Toolbar.
+     * The possible values for this property as follows
+     * * `Toolbar`:  Text will be displayed on *Toolbar* only.
+     * * `Overflow`: Text will be displayed only when content overflows to *popup*.
+     * * `Both`: Text will be displayed on *popup* and *Toolbar*.
+     *
+     * @default 'Both'
+     */
+    showTextOn?: DisplayMode;
 
     /**
-     * Defines htmlAttributes used to add custom attributes to Toolbar command.
-     * Supports HTML attributes such as style, class, etc.
-     *
-     * @default null
-     */
-    htmlAttributes?: { [key: string]: string };
+     * Defines htmlAttributes used to add custom attributes to Toolbar command.
+     * Supports HTML attributes such as style, class, etc.
+     *
+     * @default null
+     */
+    htmlAttributes?: { [key: string]: string };
 
     /**
-     * Specifies the text to be displayed on hovering the Toolbar button.
-     *
-     * @default ""
-     */
-    tooltipText?: string;
+     * Specifies the text to be displayed on hovering the Toolbar button.
+     *
+     * @default ""
+     */
+    tooltipText?: string;
 
     /**
-     * Specifies the location for aligning Toolbar items on the Toolbar. Each command will be aligned according to the `align` property.
-     * The possible values for this property as follows
-     * * `Left`: To align commands to the left side of the Toolbar.
-     * * `Center`: To align commands at the center of the Toolbar.
-     * * `Right`: To align commands to the right side of the Toolbar.
-     * ```html
-     * <div id="element"> </div>
-     * ```
-     * ```typescript
-     * let toolbar: Toolbar = new Toolbar({
-     *     items: [
-     *         { text: "Home" },
-     *         { text: "My Home Page" , align: 'Center' },
-     *         { text: "Search", align: 'Right' }
-     *         { text: "Settings", align: 'Right' }
-     *     ]
-     * });
-     * toolbar.appendTo('#element');
-     * ```
-     *
-     * @default "Left"
-     * @aspPopulateDefaultValue
-     */
-    align?: ItemAlign;
+     * Specifies the location for aligning Toolbar items on the Toolbar. Each command will be aligned according to the `align` property.
+     * The possible values for this property as follows
+     * * `Left`: To align commands to the left side of the Toolbar.
+     * * `Center`: To align commands at the center of the Toolbar.
+     * * `Right`: To align commands to the right side of the Toolbar.
+     * ```html
+     * <div id="element"> </div>
+     * ```
+     * ```typescript
+     * let toolbar: Toolbar = new Toolbar({
+     *     items: [
+     *         { text: "Home" },
+     *         { text: "My Home Page" , align: 'Center' },
+     *         { text: "Search", align: 'Right' }
+     *         { text: "Settings", align: 'Right' }
+     *     ]
+     * });
+     * toolbar.appendTo('#element');
+     * ```
+     *
+     * @default "Left"
+     * @aspPopulateDefaultValue
+     */
+    align?: ItemAlign;
 
     /**
-     * Event triggers when `click` the toolbar item.
-     *
-     * @event click
-     */
-    click?: EmitType<ClickEventArgs>;
+     * Event triggers when `click` the toolbar item.
+     *
+     * @event click
+     */
+    click?: EmitType<ClickEventArgs>;
 
     /**
-     * Specifies the tab order of the Toolbar items. When positive values assigned, it allows to switch focus to the next/previous toolbar items with Tab/ShiftTab keys.
-     * By default, user can able to switch between items only via arrow keys.
-     * If the value is set to 0 for all tool bar items, then tab switches based on element order.
-     *
-     * @default -1
-     */
-    tabIndex?: number;
+     * Specifies the tab order of the Toolbar items. When positive values assigned, it allows to switch focus to the next/previous toolbar items with Tab/ShiftTab keys.
+     * By default, user can able to switch between items only via arrow keys.
+     * If the value is set to 0 for all tool bar items, then tab switches based on element order.
+     *
+     * @default -1
+     */
+    tabIndex?: number;
 
 }
 
@@ -186,108 +186,102 @@ export interface ItemModel {
 export interface ToolbarModel extends ComponentModel{
 
     /**
-     * An array of items that is used to configure Toolbar commands.
-     *
-     * @default []
-     */
-    items?: ItemModel[];
+     * An array of items that is used to configure Toolbar commands.
+     *
+     * @default []
+     */
+    items?: ItemModel[];
 
     /**
-     * Specifies the width of the Toolbar in pixels/numbers/percentage. Number value is considered as pixels.
-     *
-     * @default 'auto'
-     */
-    width?: string | number;
+     * Specifies the width of the Toolbar in pixels/numbers/percentage. Number value is considered as pixels.
+     *
+     * @default 'auto'
+     */
+    width?: string | number;
 
     /**
-     * Specifies the height of the Toolbar in pixels/number/percentage. Number value is considered as pixels.
-     *
-     * @default 'auto'
-     */
-    height?: string | number;
+     * Specifies the height of the Toolbar in pixels/number/percentage. Number value is considered as pixels.
+     *
+     * @default 'auto'
+     */
+    height?: string | number;
 
     /**
-     * Sets the CSS classes to root element of the Tab that helps to customize component styles.
-     *
-     * @default ''
-     */
-    cssClass?: string;
+     * Sets the CSS classes to root element of the Tab that helps to customize component styles.
+     *
+     * @default ''
+     */
+    cssClass?: string;
 
     /**
-     * Specifies the Toolbar display mode when Toolbar content exceeds the viewing area.
-     * The possible values for this property as follows
-     * - Scrollable: All the elements are displayed in a single line with horizontal scrolling enabled.
-     * - Popup: Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the *popup*.
-     * - MultiRow: Displays the overflow toolbar items as an in-line of a toolbar.
-     * - Extended: Hide the overflowing toolbar items in the next row.  Show the overflowing toolbar items when you click the expand icons.
-     * If the popup content overflows the height of the page, the rest of the elements will be hidden.
-     *
-     * @default 'Scrollable'
-     */
-    overflowMode?: OverflowMode;
+     * Specifies the Toolbar display mode when Toolbar content exceeds the viewing area.
+     * The possible values for this property as follows
+     * - Scrollable: All the elements are displayed in a single line with horizontal scrolling enabled.
+     * - Popup: Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the *popup*.
+     * - MultiRow: Displays the overflow toolbar items as an in-line of a toolbar.
+     * - Extended: Hide the overflowing toolbar items in the next row.  Show the overflowing toolbar items when you click the expand icons.
+     * If the popup content overflows the height of the page, the rest of the elements will be hidden.
+     *
+     * @default 'Scrollable'
+     */
+    overflowMode?: OverflowMode;
 
     /**
-     * Specifies the scrolling distance in scroller.
-     * The possible values for this property as follows
-     * * Scrollable - All the elements are displayed in a single line with horizontal scrolling enabled.
-     * * Popup - Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the *popup*.
-     * * MultiRow - Displays the overflow toolbar items as an in-line of a toolbar.
-     * * Extended - Hide the overflowing toolbar items in the next row.  Show the overflowing toolbar items when you click the expand icons.
-     * * If the popup content overflows the height of the page, the rest of the elements will be hidden.
-     *
-     * {% codeBlock src='toolbar/scrollStep/index.md' %}{% endcodeBlock %}
-     *
-     * @default null
-     */
-    scrollStep?: number;
+     * Specifies the scrolling distance in scroller.
+     *
+     * {% codeBlock src='toolbar/scrollStep/index.md' %}{% endcodeBlock %}
+     *
+     * @default null
+     */
+    scrollStep?: number;
 
     /**
-     * Enable or disable the popup collision.
-     *
-     * @default true
-     */
-    enableCollision?: boolean;
+     * Enable or disable the popup collision.
+     *
+     * @default true
+     */
+    enableCollision?: boolean;
 
     /**
-     * Defines whether to allow the cross-scripting site or not.
-     *
-     * @default true
-     */
-    enableHtmlSanitizer?: boolean;
+     * Defines whether to allow the cross-scripting site or not.
+     *
+     * @default true
+     */
+    enableHtmlSanitizer?: boolean;
 
     /**
-     * When this property is set to true, it allows the keyboard interaction in toolbar.
-     *
-     * @default true
-     */
-    allowKeyboard?: boolean;
+     * When this property is set to true, it allows the keyboard interaction in toolbar.
+     *
+     * @default true
+     */
+    allowKeyboard?: boolean;
 
     /**
-     * The event will be fired on clicking the Toolbar elements.
-     *
-     * @event clicked
-     */
-    clicked?: EmitType<ClickEventArgs>;
+     * The event will be fired on clicking the Toolbar elements.
+     *
+     * @event clicked
+     */
+    clicked?: EmitType<ClickEventArgs>;
 
     /**
-     * The event will be fired when the control is rendered.
-     *
-     * @event created
-     */
-    created?: EmitType<Event>;
+     * The event will be fired when the control is rendered.
+     *
+     * @event created
+     */
+    created?: EmitType<Event>;
 
     /**
-     * The event will be fired when the control gets destroyed.
-     *
-     * @event destroyed
-     */
-    destroyed?: EmitType<Event>;
+     * The event will be fired when the control gets destroyed.
+     *
+     * @event destroyed
+     */
+    destroyed?: EmitType<Event>;
 
     /**
-     * The event will be fired before the control is rendered on a page.
-     *
-     * @event beforeCreate
-     */
-    beforeCreate?: EmitType<BeforeCreateArgs>;
+     * The event will be fired before the control is rendered on a page.
+     *
+     * @event beforeCreate
+     */
+    beforeCreate?: EmitType<BeforeCreateArgs>;
 
 }

package/src/toolbar/toolbar.d.ts

@@ -299,12 +299,6 @@ export declare class Toolbar extends Component<HTMLElement> implements INotifyPr
     overflowMode: OverflowMode;
     /**
      * Specifies the scrolling distance in scroller.
-     * The possible values for this property as follows
-     * * Scrollable - All the elements are displayed in a single line with horizontal scrolling enabled.
-     * * Popup - Prioritized elements are displayed on the Toolbar and the rest of elements are moved to the *popup*.
-     * * MultiRow - Displays the overflow toolbar items as an in-line of a toolbar.
-     * * Extended - Hide the overflowing toolbar items in the next row.  Show the overflowing toolbar items when you click the expand icons.
-     * * If the popup content overflows the height of the page, the rest of the elements will be hidden.
      *
      * {% codeBlock src='toolbar/scrollStep/index.md' %}{% endcodeBlock %}
      *

package/src/toolbar/toolbar.js

@@ -1,22 +1,22 @@
-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;
-};
+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;
+};
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Component, EventHandler, Property, Event } from '@syncfusion/ej2-base';
 import { addClass, removeClass, isVisible, closest, attributes, detach, classList, KeyboardEvents } from '@syncfusion/ej2-base';