smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
111 lines (110 loc) • 6.28 kB
TypeScript
import { Breadcrumb } from './../index';
import { Animation } 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, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { Breadcrumb } from './../index';
export declare class BreadcrumbComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
constructor(ref: ElementRef<Breadcrumb>);
private eventHandlers;
nativeElement: Breadcrumb;
/** @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 Enables or disables the "Add new item" (+) button. */
get addNewItem(): boolean;
set addNewItem(value: boolean);
/** @description Enables or disables the dragging of breadcrumb items. */
get allowDrag(): boolean;
set allowDrag(value: boolean);
/** @description Enables or disables the dropping of dragged breadcrumb items. */
get allowDrop(): boolean;
set allowDrop(value: boolean);
/** @description Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Show/Hide the close button of breadcrumb items. */
get closeButtons(): boolean;
set closeButtons(value: boolean);
/** @description Determines the data source to load breadcrumb items from. The Array should contain objects. Each object defines a single breadcrumb item. */
get dataSource(): {
label: string;
value: string;
}[];
set dataSource(value: {
label: string;
value: string;
}[]);
/** @description Enables or disables the Breadcrumb. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Sets or gets the template of breadcrumb items. The value of this property can be the id of an HTMLTemplateElement or the HTMLTemplateElement itself. If set to null, no template is applied. */
get itemTemplate(): any;
set itemTemplate(value: any);
/** @description Sets or gets the license which unlocks the product. */
get license(): string;
set license(value: string);
/** @description Sets or gets the language. Used in conjunction with the property messages. */
get locale(): string;
set locale(value: string);
/** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. */
get messages(): any;
set messages(value: any);
/** @description Determines the minimum width of the Breadcrumb at which it will switch from normal to minimized mode. If set to null, the Breadcrumb does not minimize automatically. */
get minimizeWidth(): number;
set minimizeWidth(value: number);
/** @description If is set to true, the element cannot be focused. */
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** @description This event is triggered when a Breadcrumb item is closed.
* @param event. The custom event. Custom event was created with: event.detail( item)
* item - The item that has been closed.
*/
onClose: EventEmitter<CustomEvent>;
/** @description This event is triggered when a Breadcrumb item is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function.
* @param event. The custom event. Custom event was created with: event.detail( item)
* item - The item that is going to be closed.
*/
onClosing: EventEmitter<CustomEvent>;
/** @description This event is triggered when a Breadcrumb item is dropped.
* @param event. The custom event. */
onDragEnd: EventEmitter<CustomEvent>;
/** @description This event is triggered when a Breadcrumb item is being dragged.
* @param event. The custom event. Custom event was created with: event.detail( item, originalEvent, target)
* item - The item that is being dragged.
* originalEvent - The original event that initiates the dragging operation.
* target - The original target.
*/
onDragging: EventEmitter<CustomEvent>;
/** @description This event is triggered when the "Add new item" (+) button is clicked.
* @param event. The custom event. */
onAddNewItem: EventEmitter<CustomEvent>;
/** @description Adds an item.
* @param {any} itemDetails. An Object with the fields "index", "label", and "value".
*/
addItem(itemDetails: any): void;
/** @description Restores the Breadcrumb from minimized state back to normal.
*/
maximize(): void;
/** @description Minimizes the Breadcrumb.
*/
minimize(): void;
/** @description Removes an item.
* @param {HTMLElement} item. The item to remove.
*/
removeItem(item: HTMLElement): 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<BreadcrumbComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<BreadcrumbComponent, "smart-breadcrumb, [smart-breadcrumb]", ["smart-breadcrumb"], { "addNewItem": "addNewItem"; "allowDrag": "allowDrag"; "allowDrop": "allowDrop"; "animation": "animation"; "closeButtons": "closeButtons"; "dataSource": "dataSource"; "disabled": "disabled"; "itemTemplate": "itemTemplate"; "license": "license"; "locale": "locale"; "messages": "messages"; "minimizeWidth": "minimizeWidth"; "unfocusable": "unfocusable"; }, { "onClose": "onClose"; "onClosing": "onClosing"; "onDragEnd": "onDragEnd"; "onDragging": "onDragging"; "onAddNewItem": "onAddNewItem"; }, never>;
}