up

Author: bmarkov

accordion/accordion.d.ts

@@ -27,123 +27,123 @@ export declare class Accordion extends React.Component<React.HTMLAttributes<Elem
  private nativeElement;
  private componentRef;
  get id(): string;
- /** Sets or gets the animation mode. Animation is disabled when the property is set to 'none'
+ /** Configures or retrieves the current animation mode. When set to 'none', all animations are disabled, resulting in instant transitions without animated effects. Setting this property to other supported values enables different animation behaviors.
  *	Property type: Animation | string
  */
  get animation(): Animation | string;
  set animation(value: Animation | string);
- /** Determines the data source that will be loaded to the Accordion.
+ /** Specifies the data source to be loaded and displayed within the Accordion component. This property defines the collection of items or structured data that populates each section or panel of the Accordion, enabling dynamic rendering of its contents. The data source can typically be provided as an array of objects, JSON data, or via a remote endpoint depending on configuration.
  *	Property type: any
  */
  get dataSource(): any;
  set dataSource(value: any);
- /** Enables or disables the accordion. Disabled elements can not be interacted with.
+ /** Controls whether the accordion component is enabled or disabled. When set to disabled, all interactive functionality is turned off—users cannot expand, collapse, or interact with any accordion sections. Disabled accordions appear visually inactive to indicate their non-interactive state.
  *	Property type: boolean
  */
  get disabled(): boolean;
  set disabled(value: boolean);
- /** Sets or gets the expanded item indexes. Using this property items can be expanded by passing in their indexes. The number of expanded items is limited by the expandMode.
+ /** Sets or retrieves the indexes of currently expanded items. By assigning an array of item indexes to this property, you can programmatically expand those specific items. The maximum number of items that can be expanded at once depends on the value specified in the expandMode property (for example, single or multiple expansion modes). When getting this property, it returns an array of the indexes of all expanded items.
  *	Property type: number[]
  */
  get expandedIndexes(): number[];
  set expandedIndexes(value: number[]);
- /** Sets or gets the expand mode. Expand mode determines how the items will expand or collapse.
+ /** Sets or retrieves the current expand mode. The expand mode specifies how list or group items behave when expanding or collapsing—such as allowing multiple items to expand simultaneously or restricting expansion to a single item at a time.
  *	Property type: AccordionExpandMode | string
  */
  get expandMode(): AccordionExpandMode | string;
  set expandMode(value: AccordionExpandMode | string);
- /** Sets or gets the unlockKey which unlocks the product.
+ /** Retrieves or assigns the 'unlockKey' property, which serves as the access credential required to unlock and activate the product's full features.
  *	Property type: string
  */
  get unlockKey(): string;
  set unlockKey(value: string);
- /** Sets or gets the language. Used in conjunction with the property messages.
+ /** Sets or retrieves the current language code (e.g., "en", "fr") for the component. This property works together with the messages property to determine which language-specific messages or translations are displayed. Use this to localize your application content based on user preference or locale.
  *	Property type: string
  */
  get locale(): string;
  set locale(value: string);
- /** Callback used to customize the format of the messages that are returned from the Localization Module.
+ /** A callback function that allows you to customize the formatting of messages returned by the Localization Module. Use this to modify or enhance localized message output—such as applying dynamic content, adjusting text structure, or handling language-specific variations—before the messages are delivered to the client application.
  *	Property type: any
  */
  get localizeFormatFunction(): any;
  set localizeFormatFunction(value: any);
- /** Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
+ /** Specifies or retrieves an object containing the localized strings used throughout the widget interface. This allows you to define custom translations for various UI elements in different languages. Used together with the locale property to enable localization and internationalization support within the widget.
  *	Property type: any
  */
  get messages(): any;
  set messages(value: any);
- /** Determines if the element is readonly or not. If the element true, users cannot interact with it.
+ /** Indicates whether the element is read-only. When set to true, the element cannot be modified or interacted with by users; its value is fixed and user input is disabled. If false, the element remains editable and interactive.
  *	Property type: boolean
  */
  get readonly(): boolean;
  set readonly(value: boolean);
- /** Enables or disables accordion reordering.
+ /** Controls whether users can reorder accordion items by dragging and dropping them. When enabled, items within the accordion component can be rearranged interactively; when disabled, the order of items remains fixed.
  *	Property type: boolean
  */
  get reorder(): boolean;
  set reorder(value: boolean);
- /** Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
+ /** Specifies or retrieves a value that determines whether the element is aligned to accommodate right-to-left (RTL) languages and scripts, such as Arabic or Hebrew. This property ensures the element’s layout and text direction are properly adjusted to support RTL localization.
  *	Property type: boolean
  */
  get rightToLeft(): boolean;
  set rightToLeft(value: boolean);
- /** Determines the theme. Theme defines the look of the element
+ /** Specifies the theme to be applied, which controls the overall appearance and visual style of the element, including aspects such as colors, fonts, and background.
  *	Property type: string
  */
  get theme(): string;
  set theme(value: string);
- /** Determines whether the element can be focused or not.
+ /** Specifies whether the element is capable of receiving keyboard focus, allowing users to navigate to it using the keyboard (such as the Tab key) and interact with it through assistive technologies.
  *	Property type: boolean
  */
  get unfocusable(): boolean;
  set unfocusable(value: boolean);
  get properties(): string[];
- /** This event is triggered when an item is collapsed.
+ /** Triggered when an item has completed its collapse animation and is no longer expanded or visible. This event occurs only after the item is fully collapsed, ensuring that any associated transitions or content hiding have finished.
  * @param event. The custom event.	Custom event was created with: event.detail(	content,	index,	label)
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item
+ * content - The collapsed item's content.
+ * index - The index of the collapsed item.
+ * label - The label of the collapsed item.
  */
  onCollapse?: ((event?: Event) => void) | undefined;
- /** This event is triggered when an item is going to be collapsed.
+ /** Fires immediately before an item begins its collapse animation, allowing you to perform actions or prevent the collapse from occurring.
  * @param event. The custom event.	Custom event was created with: event.detail(	content,	index,	label)
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item
+ * content - The item content.
+ * index - The item's index.
+ * label - The item's label.
  */
  onCollapsing?: ((event?: Event) => void) | undefined;
- /** This event is triggered when a reordering operation is completed.
+ /** Triggered when a user completes a drag-and-drop action to reorder items, indicating that the new order has been finalized and can be processed (e.g., saved or updated in the UI or backend).
  * @param event. The custom event.	Custom event was created with: event.detail(	position,	target,	content,	index,	label)
- * position - The current top and left position of the item that was dragged.
- * target - The item that was dragged.
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item.
+ * position - Current top and left coordinates of the dragged item.
+ * target - The dragged item element.
+ * content - The dragged item's content.
+ * index - The dragged item's index.
+ * label - The dragged item's label.
  */
  onDragEnd?: ((event?: Event) => void) | undefined;
- /** This event is triggered when a reordering operation is started.
+ /** Fires when the user initiates a drag-and-drop reorder action, signaling the start of an item being moved within a sortable list or container. This event provides an opportunity to perform setup tasks, such as highlighting the item being dragged or preparing the UI for reordering.
  * @param event. The custom event.	Custom event was created with: event.detail(	position,	target,	content,	index,	label)
- * position - The current top and left position of the item that is about to be dragged.
- * target - The item that is about to be dragged.
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item.
+ * position - Initial top and left coordinates of the item being dragged.
+ * target - The item element being dragged.
+ * content - The dragged item's content.
+ * index - The dragged item's index.
+ * label - The dragged item's label.
  */
  onDragStart?: ((event?: Event) => void) | undefined;
- /** This event is triggered when an item is expanded.
+ /** Triggered when an item has completed its expansion and is fully visible to the user. This event occurs after any expansion animations or transitions have finished, ensuring that the item's contents are now accessible for interaction.
  * @param event. The custom event.	Custom event was created with: event.detail(	position,	target,	content,	index,	label)
- * position - The current top and left position of the item.
- * target - The item that was dragged.
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item.
+ * position - Current top and left coordinates of the expanded item.
+ * target - The expanded item element.
+ * content - The expanded item's content.
+ * index - The expanded item's index.
+ * label - The expanded item's label.
  */
  onExpand?: ((event?: Event) => void) | undefined;
- /** This event is triggered when an item is going to be expanded.
+ /** Fires immediately before an item begins its expansion process, allowing you to perform actions or modify data right before the expansion occurs. This event provides an opportunity to prevent the expansion or make adjustments as needed.
  * @param event. The custom event.	Custom event was created with: event.detail(	content,	index,	label)
- * content - The content of the item.
- * index - The index of the item.
- * label - The label of the item
+ * content - The content of the item being expanded.
+ * index - The index of the item being expanded.
+ * label - The label of the item being expanded.
  */
  onExpanding?: ((event?: Event) => void) | undefined;
  /** This event occurs, when the React component is created.
@@ -153,28 +153,33 @@ export declare class Accordion extends React.Component<React.HTMLAttributes<Elem
  * @param event. The custom event.	*/
  onReady?: ((event?: Event) => void) | undefined;
  get eventListeners(): string[];
- /** Collapses an item at a specified index.
- * @param {number} position. The index of the collapsed item.
+ /** Collapses the item located at the specified index, hiding its associated content or details from view. This action typically updates the user interface to indicate that the item is no longer expanded.
+ * @param {number} position. Index of the item to collapse.
  */
  collapse(position: number): void;
- /** Expands an item at a specified index.
- * @param {number} position. The index of the expanded item.
+ /** Expands the item located at the specified index in the collection, making its detailed content visible or accessible to the user.
+ * @param {number} position. Index of the item to expand.
  */
  expand(position: number): void;
- /** Inserts a new item at a specified index.
- * @param {number} index. The index where the item must be inserted.
- * @param {any} item. An object containing the values for the properties of the new item to be inserted.
+ /** Inserts a new item into the array at the specified index, shifting existing elements to the right to accommodate the new entry. If the specified index is out of range, the operation will either append the item to the end or return an error, depending on the implementation.
+ * @param {number} index. Index where the new item will be inserted.
+ * @param {any} item. Object representing the new item's properties.
  */
  insert(index: number, item: any): void;
- /** Removes an item at a specified index.
- * @param {number} position. The index of the item to be removed.
+ /** Removes the item located at the specified index from the array, shifting subsequent items one position to the left. The array's length is reduced by one, and the removed item is no longer accessible.
+ * @param {number} position. Index of the item to remove.
  */
  removeAt(position: number): void;
- /** Updates an item from the element.
- * @param {number} index. The index of the item to be updated.
- * @param {any} settings. An object containing the values for the properties of the item that will be updated.
+ /** Replaces the item at the given index in the collection with an updated version, incorporating the specified new property values while preserving any unchanged properties.
+ * @param {number} index. Index of the item to update.
+ * @param {any} settings. Object containing updated property values for the item.
  */
  update(index: number, settings: any): void;
+ /** Sets the locale of a component.
+ * @param {string} locale. The locale abbreviation. For example: 'de'.
+ * @param {any} messages?. Object containing the locale messages.
+ */
+ setLocale(locale: string, messages?: any): void;
  constructor(props: any);
  componentDidRender(initialize: boolean): void;
  componentDidMount(): void;