smart-webcomponents-angular

import { SwitchButton } from './../index'; import { Animation, ClickMode, Orientation, SwitchButtonSwitchMode } from './../index'; import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core'; import { BaseElement } from './smart.element'; import { ControlValueAccessor } from '@angular/forms'; import * as i0 from "@angular/core"; export { Animation, ClickMode, Orientation, SwitchButtonSwitchMode, ElementRenderMode } from './../index'; export { Smart } from './smart.element'; export { SwitchButton } from './../index'; export declare class SwitchButtonComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges, ControlValueAccessor { constructor(ref: ElementRef<SwitchButton>); private eventHandlers; nativeElement: SwitchButton; /** @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 * The registered callback function called when a change event occurs on the form elements. */ _onChange: (value: any) => void; /** * @description * The registered callback function called when a blur event occurs on the form elements. */ _onTouched: () => any; /** @description Sets or retrieves the current animation mode. When this property is set to 'none', all animations are disabled. For other valid values, the corresponding animation effects will be enabled according to the specified mode. */ get animation(): Animation | string; set animation(value: Animation | string); /** @description Specifies how the switch button responds to user interaction when the switchMode is set to 'click'. This property determines the exact mouse action that triggers a change in the switch’s state: press – The switch state changes immediately when the mouse button is pressed down (mousedown event). release – The switch state changes only when the mouse button is released (mouseup event), after a complete click. pressAndRelease – The switch state changes on mousedown, and automatically reverts to the original state on mouseup.Note: This property is effective only when switchMode is set to 'click'. */ get clickMode(): ClickMode | string; set clickMode(value: ClickMode | string); /** @description Sets the check state to indicate whether the item is checked, unchecked, or indeterminate; or retrieves the current check state of the item. */ get checked(): boolean; set checked(value: boolean); /** @description Controls whether the ratio button is displayed and can be interacted with by the user. Set to true to show and enable the button, or false to hide or disable it. */ get disabled(): boolean; set disabled(value: boolean); /** @description Defines the text label or string that will be displayed when the checked property is set to false, representing the unchecked state of the component or element. */ get falseContent(): string; set falseContent(value: string); /** @description Defines a custom template that is displayed when the component is in the false state. This template allows you to specify the content or layout shown when the evaluated condition is false. */ get falseTemplate(): any; set falseTemplate(value: any); /** @description Controls whether the switch is in an indeterminate state or retrieves its current indeterminate status. When set to true, the switch appears visually distinct to indicate that its state is neither clearly on nor off. This is typically used to represent a partial or mixed selection. */ get indeterminate(): boolean; set indeterminate(value: boolean); /** @description Specifies the direction in which the switch toggles between states. If set to true, the positions of the switch states are inverted, meaning the ON and OFF positions are swapped. */ get inverted(): boolean; set inverted(value: boolean); /** @description Retrieves or assigns the unlockKey value, which serves as a credential to enable access to the product’s locked features or functionality. */ get unlockKey(): string; set unlockKey(value: string); /** @description Specifies or retrieves the current language code (e.g., 'en', 'fr', 'es'). This property determines which language is used for message localization when working with the messages property. Setting this value ensures the corresponding localized messages are displayed or accessed appropriately. */ get locale(): string; set locale(value: string); /** @description Callback function associated with the localization module. This callback is invoked whenever localization-related events occur, such as changes in language, region settings, or translation updates. It enables the module to respond dynamically to localization changes in the application. */ get localizeFormatFunction(): any; set localizeFormatFunction(value: any); /** @description Defines an object that maps password strength states (e.g., weak, medium, strong) to their corresponding string values or messages. This allows for customized labels or feedback to be displayed to users based on the evaluated password strength. */ get messages(): any; set messages(value: any); /** @description Retrieves the current name of the widget or assigns a new name to the widget. This property can be used to identify or reference the widget programmatically. */ get name(): string; set name(value: string); /** @description Specifies the layout direction of the switch component, determining whether it is displayed horizontally or vertically. Use this property to control how the switch and its label are arranged within the user interface. */ get orientation(): Orientation | string; set orientation(value: Orientation | string); /** @description When the custom element is set to readonly, users will not be able to modify its content or trigger any interactive behaviors such as editing, selecting, or submitting data through the element. However, the element remains visible and its value can still be programmatically accessed or updated by scripts. */ get readonly(): boolean; set readonly(value: boolean); /** @description Specifies the text label or value that will be displayed when the checked property is set to true. This text represents the state of the component when it is selected or activated. */ get trueContent(): string; set trueContent(value: string); /** @description Defines a custom template to display when the state is true, allowing you to specify how content should appear in this condition. */ get trueTemplate(): string; set trueTemplate(value: string); /** @description Configures how users can interact with the switch element to change its state. The switchMode property accepts the following options: default – The switch state can be toggled either by dragging the thumb (the movable part of the switch) or by clicking anywhere within the track (the switch’s background area). click – The switch state changes only when a user clicks inside the track. Dragging the thumb does not affect the state. drag – The switch state changes solely by dragging the thumb. Clicking on the track has no effect. none – The switch cannot be toggled by any user interaction. Its state can only be changed programmatically through the API. */ get switchMode(): SwitchButtonSwitchMode | string; set switchMode(value: SwitchButtonSwitchMode | string); /** @description Specifies the theme for the element, which controls its overall visual appearance—including colors, fonts, and style. Selecting a theme customizes how the element is presented to users, ensuring consistency with the application's design. */ get theme(): string; set theme(value: string); /** @description When set to true, this property prevents the element from receiving keyboard focus, making it impossible for users to select the element using the Tab key or other keyboard navigation methods. */ get unfocusable(): boolean; set unfocusable(value: boolean); /** @description Sets a new value for the widget or retrieves its current value. Use this to programmatically update what the widget displays or to access the user's input. */ get value(): string; set value(value: string); /** @description This event is triggered whenever the widget's state changes between checked and unchecked, such as when a user selects or deselects it. The event provides updated information about the new checked state of the widget. * @param event. The custom event. Custom event was created with: event.detail( value, oldValue, changeType) * value - A boolean value indicating the new state of the button ( checked or not ). * oldValue - A boolean value indicating the previous state of the button ( checked or not ). * changeType - A string flag indicating whether the change event was triggered via API or an event. */ onChange: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the widget transitions to a checked state, such as when a user selects, activates, or toggles the widget to indicate it is checked. It allows developers to execute custom logic in response to changes in the widget's checked status. * @param event. The custom event. Custom event was created with: event.detail( changeType) * changeType - A string flag indicating whether the change event was triggered via API or an event. */ onCheckValue: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the user unchecks the widget, indicating a change from a checked (selected) state to an unchecked (deselected) state. This allows you to execute custom logic in response to the widget being deselected. * @param event. The custom event. Custom event was created with: event.detail( changeType) * changeType - A string flag indicating whether the change event was triggered via API or an event. */ onUncheckValue: EventEmitter<CustomEvent>; get isRendered(): boolean; ngOnInit(): void; ngAfterViewInit(): void; ngOnDestroy(): void; _initialChange: boolean; get ngValue(): any; set ngValue(value: any); writeValue(value: any): void; registerOnChange(fn: any): void; registerOnTouched(fn: any): void; ngOnChanges(changes: SimpleChanges): void; /** @description Add event listeners. */ private listen; /** @description Remove event listeners. */ private unlisten; static ɵfac: i0.ɵɵFactoryDeclaration<SwitchButtonComponent, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<SwitchButtonComponent, "smart-switch-button, [smart-switch-button]", ["smart-switch-button"], { "animation": "animation"; "clickMode": "clickMode"; "checked": "checked"; "disabled": "disabled"; "falseContent": "falseContent"; "falseTemplate": "falseTemplate"; "indeterminate": "indeterminate"; "inverted": "inverted"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "name": "name"; "orientation": "orientation"; "readonly": "readonly"; "trueContent": "trueContent"; "trueTemplate": "trueTemplate"; "switchMode": "switchMode"; "theme": "theme"; "unfocusable": "unfocusable"; "value": "value"; }, { "onChange": "onChange"; "onCheckValue": "onCheckValue"; "onUncheckValue": "onUncheckValue"; }, never>; }