smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
76 lines (75 loc) • 7.63 kB
TypeScript
import { Sortable } from './../index';
import { Animation, SortableDragMode, SortableHandlePosition, SortableHandleVisibility, Orientation } from './../index';
import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core';
import { BaseElement } from './smart.element';
import * as i0 from "@angular/core";
export { Animation, SortableDragMode, SortableHandlePosition, SortableHandleVisibility, Orientation, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { Sortable } from './../index';
export declare class SortableComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
constructor(ref: ElementRef<Sortable>);
private eventHandlers;
nativeElement: Sortable;
/** @description Creates the component on demand.
* @param properties An optional object of properties, which will be added to the template binded ones.
*/
createComponent(properties?: {}): any;
/** @description Defines or retrieves the current animation mode. When this property is set to 'none', all animations are disabled and elements will transition instantly without any animated effects. Use this property to enable, disable, or customize the animation behavior of components. */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Controls whether items can be sorted. When enabled, users can rearrange items by sorting them; when disabled, sorting functionality is not available. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Determines how a sortable item can be dragged within the list. When set to 'item', users can drag the entire item itself to reorder it. When set to 'handle', a specific drag handle is displayed next to each item, and only dragging this handle will reorder the item. This property can be both retrieved (get) and modified (set) to control the user’s drag interaction method. */
get dragMode(): SortableDragMode | string;
set dragMode(value: SortableDragMode | string);
/** @description Sets or retrieves the position of the drag handle in relation to its associated sortable item. This property is only applicable when the dragMode option is set to 'handle', meaning that the user can initiate dragging only by interacting with the specified handle within the sortable item. Use this option to define where the handle appears (e.g., 'left', 'right', 'top', or 'bottom') relative to the item, allowing for precise customization of the drag-and-drop interface. */
get handlePosition(): SortableHandlePosition | string;
set handlePosition(value: SortableHandlePosition | string);
/** @description Determines whether the drag handle of a sortable item is always visible or only appears when the item is hovered over. This property is applicable only if dragMode is set to 'handle'. Use this setting to control the visibility of the item’s drag handle for user interaction. */
get handleVisibility(): SortableHandleVisibility | string;
set handleVisibility(value: SortableHandleVisibility | string);
/** @description Specifies or retrieves a CSS selector used to identify which elements within the container are sortable items. By default, all direct child elements of the 'smart-sortable' custom element are considered sortable. You can customize this selector to restrict sortable functionality to specific child elements based on their class, tag, or other attributes. */
get items(): string | null;
set items(value: string | null);
/** @description Sets or retrieves the unlockKey, a unique value required to activate or grant access to the product's features. This property enables locking and unlocking the product based on its assigned key. */
get unlockKey(): string;
set unlockKey(value: string);
/** @description Specifies or retrieves the current language code (e.g., 'en', 'fr', 'es'). This property determines which set of localized messages from the messages property will be used for displaying text or content. It ensures the correct language is applied throughout the application's interface. */
get locale(): string;
set locale(value: string);
/** @description Callback function associated with the localization module, typically used to handle language or region-specific content updates or responses within the application. */
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** @description Defines or retrieves an object containing the localized strings that are displayed in the widget's user interface. This property allows you to customize all text elements for different languages and regions. It should be used together with the locale property to ensure the widget presents the appropriate translations based on the selected locale. */
get messages(): any;
set messages(value: any);
/** @description Sets or retrieves the orientation (horizontal or vertical) in which sortable items are arranged and can be reordered by dragging. This determines whether items are stacked in a row or a column when using the sortable functionality. */
get mode(): Orientation | string;
set mode(value: Orientation | string);
/** @description Gets or sets a value that specifies whether the element's text direction is set to right-to-left (RTL), enabling proper alignment and layout for languages and locales that use right-to-left scripts, such as Arabic or Hebrew. */
get rightToLeft(): boolean;
set rightToLeft(value: boolean);
/** @description This event is triggered whenever the order of items in a sortable list changes, indicating that one or more items have been repositioned within the list by the user. The event provides details about the updated order, allowing you to respond to changes, such as saving the new arrangement or updating the user interface.
* @param event. The custom event. */
onDragEnd: EventEmitter<CustomEvent>;
/** @description Relocates a sortable item within a list from its current index to a specified target index, updating the order of items accordingly.
* @param {number} fromIndex?. The original index of the item.
* @param {number} toIndex?. The index to move the item to.
*/
move(fromIndex?: number, toIndex?: number): void;
/** @description Recalculates the list of sortable items within the custom element. This method should be called whenever items are dynamically added or removed to ensure that all current items are properly recognized and can be sorted as expected.
*/
updateItems(): void;
get isRendered(): boolean;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
/** @description Add event listeners. */
private listen;
/** @description Remove event listeners. */
private unlisten;
static ɵfac: i0.ɵɵFactoryDeclaration<SortableComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<SortableComponent, "smart-sortable, [smart-sortable]", ["smart-sortable"], { "animation": "animation"; "disabled": "disabled"; "dragMode": "dragMode"; "handlePosition": "handlePosition"; "handleVisibility": "handleVisibility"; "items": "items"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "mode": "mode"; "rightToLeft": "rightToLeft"; }, { "onDragEnd": "onDragEnd"; }, never>;
}