@syncfusion/ej2-navigations 30.2.7 → 31.1.17

package/dist/global/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 *  filename: index.d.ts
-*  version : 30.2.7
+*  version : 31.1.17
 *  Copyright Syncfusion Inc. 2001 - 2024. All rights reserved.
 *  Use of this code is subject to the terms of our license.
 *  A copy of the current license can be obtained at any time by e-mailing

package/dist/ts/accordion/accordion-model.d.ts

@@ -0,0 +1,285 @@
+import { Component, EventHandler, Property, Event, EmitType, AnimationModel, KeyboardEvents, rippleEffect, animationMode } from '@syncfusion/ej2-base';import { KeyboardEventArgs, BaseEventArgs, Effect, getUniqueID, compile as templateCompiler } from '@syncfusion/ej2-base';import { isVisible, closest, attributes, detach, select, addClass, removeClass, append } from '@syncfusion/ej2-base';import { INotifyPropertyChanged, NotifyPropertyChanges, ChildProperty, Collection, Animation } from '@syncfusion/ej2-base';import { setStyleAttribute as setStyle, Complex } from '@syncfusion/ej2-base';import { isNullOrUndefined as isNOU, formatUnit, selectAll, SanitizeHtmlHelper, isRippleEnabled } from '@syncfusion/ej2-base';
+import {ExpandMode,AccordionClickArgs,ExpandEventArgs,ExpandedEventArgs} from "./accordion";
+import {ComponentModel} from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class AccordionActionSettings
+ */
+export interface AccordionActionSettingsModel {
+
+    /**
+     * Specifies the type of animation.
+     *
+     * @default 'SlideDown'
+     * @aspType string
+     */
+    effect?: 'None' | Effect;
+
+    /**
+     * Specifies the duration to animate.
+     *
+     * @default 400
+     */
+    duration?: number;
+
+    /**
+     * Specifies the animation timing function.
+     *
+     * @default 'linear'
+     */
+    easing?: string;
+
+}
+
+/**
+ * Interface for a class AccordionAnimationSettings
+ */
+export interface AccordionAnimationSettingsModel {
+
+    /**
+     * Specifies the animation to appear while collapsing the Accordion item.
+     *
+     * @default { effect: 'SlideDown', duration: 400, easing: 'linear' }
+     */
+    collapse?: AccordionActionSettingsModel;
+
+    /**
+     * Specifies the animation to appear while expanding the Accordion item.
+     *
+     * @default { effect: 'SlideDown', duration: 400, easing: 'linear' }
+     */
+    expand?: AccordionActionSettingsModel;
+
+}
+
+/**
+ * Interface for a class AccordionItem
+ */
+export interface AccordionItemModel {
+
+    /**
+     * Sets the text content to be displayed for the Accordion item.
+     * You can set the content of the Accordion item using `content` property.
+     * It also supports to include the title as `HTML element`, `string`, or `query selector`.
+     * ```typescript
+     *   let accordionObj: Accordion = new Accordion( {
+     *        items: [
+     *          { header: 'Accordion Header', content: 'Accordion Content' },
+     *          { header: '<div>Accordion Header</div>', content: '<div>Accordion Content</div>' },
+     *          { header: '#headerContent', content: '#panelContent' }]
+     *        });
+     *   accordionObj.appendTo('#accordion');
+     * ```
+     *
+     * @default null
+     */
+    content?: string;
+
+    /**
+     * Sets the header text to be displayed for the Accordion item.
+     * You can set the title of the Accordion item using `header` property.
+     * It also supports to include the title as `HTML element`, `string`, or `query selector`.
+     * ```typescript
+     *   let accordionObj: Accordion = new Accordion( {
+     *        items: [
+     *          { header: 'Accordion Header', content: 'Accordion Content' },
+     *          { header: '<div>Accordion Header</div>', content: '<div>Accordion Content</div>' },
+     *          { header: '#headerContent', content: '#panelContent' }]
+     *        });
+     *   accordionObj.appendTo('#accordion');
+     * ```
+     *
+     * @default null
+     */
+    header?: string;
+
+    /**
+     * Defines single/multiple classes (separated by a space) are to be used for Accordion item customization.
+     *
+     * @default null
+     */
+    cssClass?: string;
+
+    /**
+     * Defines an icon with the given custom CSS class that is to be rendered before the header text.
+     * Add the css classes to the `iconCss` property and write the css styles to the defined class to set images/icons.
+     * Adding icon is applicable only to the header.
+     * ```typescript
+     *   let accordionObj: Accordion = new Accordion( {
+     *        items: [
+     *          { header: 'Accordion Header', iconCss: 'e-app-icon' }]
+     *        });
+     *   accordionObj.appendTo('#accordion');
+     * ```
+     * ```css
+     * .e-app-icon::before {
+     *   content: "\e710";
+     * }
+     * ```
+     *
+     * @default null
+     */
+    iconCss?: string;
+
+    /**
+     * Sets the expand (true) or collapse (false) state of the Accordion item. By default, all the items are in a collapsed state.
+     *
+     * @default false
+     */
+    expanded?: boolean;
+
+    /**
+     * Sets false to hide an accordion item.
+     *
+     * @default true
+     */
+    visible?: boolean;
+
+    /**
+     * Sets true to disable an accordion item.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+
+    /**
+     * Sets unique ID to accordion item.
+     *
+     * @default null
+     */
+    id?: string;
+
+}
+
+/**
+ * Interface for a class Accordion
+ */
+export interface AccordionModel extends ComponentModel{
+
+    /**
+     * An array of item that is used to specify Accordion items.
+     * ```typescript
+     *   let accordionObj: Accordion = new Accordion( {
+     *        items: [
+     *          { header: 'Accordion Header', content: 'Accordion Content' }]
+     *        });
+     *   accordionObj.appendTo('#accordion');
+     * ```
+     *
+     * @default []
+     */
+    items?: AccordionItemModel[];
+
+    /**
+     * Specifies the datasource for the accordion items.
+     *
+     * @isdatamanager false
+     * @default []
+     */
+    dataSource?: Object[];
+
+    /**
+     * Specifies the template option for accordion items.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    itemTemplate?: string | Function;
+
+    /**
+     * Specifies the header title template option for accordion items.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    headerTemplate?: string | Function;
+
+    /**
+     * Specifies the width of the Accordion in pixels/number/percentage. Number value is considered as pixels.
+     *
+     * @default '100%'
+     */
+    width?: string | number;
+
+    /**
+     * Specifies the height of the Accordion in pixels/number/percentage. Number value is considered as pixels.
+     *
+     * @default 'auto'
+     */
+    height?: string | number;
+
+    /**
+     * Specifies the expanded items at initial load.
+     *
+     * @default []
+     */
+    expandedIndices?: number[];
+
+    /**
+     * Specifies the options to expand single or multiple panel at a time.
+     * The possible values are:
+     * * `Single`: Sets to expand only one Accordion item at a time.
+     * * `Multiple`: Sets to expand more than one Accordion item at a time.
+     *
+     * @default 'Multiple'
+     */
+    expandMode?: ExpandMode;
+
+    /**
+     * Specifies whether to enable the rendering of untrusted HTML values in the Accordion component.
+     * When this property is enabled, the component will sanitize any suspected untrusted strings and scripts before rendering them.
+     *
+     * @default true
+     */
+    enableHtmlSanitizer?: boolean;
+
+    /**
+     * Specifies the animation configuration settings for expanding and collapsing the panel.
+     *
+     * @default { expand: { effect: 'SlideDown', duration: 400, easing: 'linear' },
+     * collapse: { effect: 'SlideUp', duration: 400, easing: 'linear' }}
+     */
+    animation?: AccordionAnimationSettingsModel;
+
+    /**
+     * The event will be fired while clicking anywhere within the Accordion.
+     *
+     * @event clicked
+     */
+    clicked?: EmitType<AccordionClickArgs>;
+
+    /**
+     * The event will be fired before the item gets collapsed/expanded.
+     *
+     * @event expanding
+     */
+    expanding?: EmitType<ExpandEventArgs>;
+
+    /**
+     * The event will be fired after the item gets collapsed/expanded.
+     *
+     * @event expanded
+     */
+    expanded?: EmitType<ExpandedEventArgs>;
+
+    /**
+     * The event will be fired once the control rendering is completed.
+     *
+     * @event created
+     */
+    created?: EmitType<Event>;
+
+    /**
+     * The event will be fired when the control gets destroyed.
+     *
+     * @event destroyed
+     */
+    destroyed?: EmitType<Event>;
+
+}