import { IEventEmitter } from '@breadstone/mosaik-elements'; import { IClearable } from '../../../Behaviors/Clearable'; import { type IInvalidable } from '../../../Behaviors/Invalidable'; import { ISlottable } from '../../../Behaviors/Slottable'; import type { IPasswordConcealedEventDetail, IPasswordRevealedEventDetail } from '../../../events'; import { TextAlignment } from '../../../Types/TextAlignment'; import { InputBaseElement } from '../Abstracts/InputBase'; import type { IPasswordBoxElementProps } from './IPasswordBoxElementProps'; declare const PasswordBoxElement_base: (abstract new (...args: Array) => import("../../../Behaviors/Themeable").IThemeableProps) & (abstract new (...args: Array) => import("../../../Behaviors/Slottable").ISlottableProps & ISlottable) & (abstract new (...args: Array) => import("../../../Behaviors/Clearable").IClearableProps & import("../../../Behaviors/Clearable").IClearableEvents & IClearable) & (abstract new (...args: Array) => import("../../../Behaviors/Disableable").IDisableableProps) & (abstract new (...args: Array) => IInvalidable & import("../../../Behaviors/Invalidable").IInvalidableProps) & (abstract new (...args: Array) => import("../../../Behaviors/Valueable").IValueableProps) & (abstract new (...args: Array) => import("../../../Behaviors/Variantable").IVariantableProps) & (abstract new (...args: Array) => import("../../../Behaviors/Labelable").ILabelableProps) & (abstract new (...args: Array) => import("../../../Behaviors/Appearanceable").IAppearanceableProps) & typeof InputBaseElement & import("../../../Behaviors/Themeable").IThemeableCtor; /** * Password Box - A secure input control designed for password entry with visibility toggle functionality. * * @description * The Password Box component provides a secure interface for entering passwords and sensitive information. * It masks input characters by default to maintain privacy and security, while offering a reveal/conceal toggle * that allows users to temporarily view their input for verification. Features include automatic password masking, * reveal/conceal button with appropriate icons, keyboard accessibility, form validation support, and events for * tracking visibility state changes. Essential for login forms, registration pages, and any interface requiring * secure text input. * * @name Password Box * @element mosaik-passwordbox * @category Inputs * * @slot prefix - Content placed before the input field. * @slot suffix - Content placed after the input field. * * @csspart focusRing - The focus ring indicator. * @csspart prefix - The prefix content container. * @csspart inner - The inner container wrapper. * @csspart label - The floating label element. * @csspart input - The password input field. * @csspart suffix - The suffix content container. * @csspart revealButton - The password reveal/conceal button. * * @cssprop {Color} --password-box-background-color - The background color. * @cssprop {Color} --password-box-border-color - The border color. * @cssprop {String} --password-box-border-radius - The border radius. * @cssprop {String} --password-box-border-style - The border style. * @cssprop {String} --password-box-border-width - The border width. * @cssprop {String} --password-box-font-family - The font family. * @cssprop {String} --password-box-font-size - The font size. * @cssprop {String} --password-box-font-weight - The font weight. * @cssprop {Color} --password-box-foreground-color - The foreground color. * @cssprop {String} --password-box-gap - The gap between elements. * @cssprop {String} --password-box-height - The height. * @cssprop {String} --password-box-padding-bottom - The padding bottom. * @cssprop {String} --password-box-padding-left - The padding left. * @cssprop {String} --password-box-padding-right - The padding right. * @cssprop {String} --password-box-padding-top - The padding top. * @cssprop {String} --password-box-shadow - The shadow. * @cssprop {String} --password-box-transition-duration - The transition duration. * @cssprop {String} --password-box-width - The width. * * @dependency mosaik-focus-ring - Used for focus indication. * @dependency mosaik-button - Used for the reveal/conceal button. * * @fires cleared {ClearedEvent} - Fired when the input value is cleared. * @fires passwordRevealed {PasswordRevealedEvent} - Fired when the password is shown. * @fires passwordConcealed {PasswordConcealedEvent} - Fired when the password is hidden. * * @example * ```html * * * ``` * * @public */ export declare class PasswordBoxElement extends PasswordBoxElement_base implements IPasswordBoxElementProps, IInvalidable, IClearable, ISlottable { private readonly _passwordRevealed; private readonly _passwordConcealed; private _inputElement; private _value; private _readonly; private _required; private _autofocus; private _name; private _pattern; private _placeholder; private _autocomplete; private _revealable; private _isReveal; private _textAlign; /** * @public */ constructor(); /** * Returns the `is` property. * The `is` property represents natural name of this element. * * @public * @static * @readonly */ static get is(): string; /** * Gets or sets the `value` property. * * @public * @override */ get value(): string; set value(value: string); /** * Gets or sets the `readonly` property. * * @public * @attr */ get readonly(): boolean; set readonly(value: boolean); /** * Gets or sets the `required` property. * * @public * @attr */ get required(): boolean; set required(value: boolean); /** * Gets or sets the `autofocus` property. * * @public * @override */ get autofocus(): boolean; set autofocus(value: boolean); /** * Gets or sets the `name` property. * * @public * @attr */ get name(): string; set name(value: string); /** * Gets or sets the `pattern` property. * * @public * @attr */ get pattern(): string; set pattern(value: string); /** * Gets or sets the `placeholder` property. * * @public * @attr */ get placeholder(): string; set placeholder(value: string); /** * Gets or sets the `autocomplete` property. * * @public * @attr */ get autocomplete(): boolean; set autocomplete(value: boolean); /** * Gets or sets the `revealable` property. * * @public * @attr */ get revealable(): boolean; set revealable(value: boolean); /** * Determines whether the element has a prefix or not. * The Prefix is a slot that is displayed before the input. * * @private * @readonly * @attr */ get hasPrefix(): boolean; /** * Determines whether the element has a suffix or not. * The Suffix is a slot that is displayed after the input. * * @private * @readonly * @attr */ get hasSuffix(): boolean; /** * Returns the `isReveal` property. * * @public * @attr */ get isReveal(): boolean; set isReveal(value: boolean); /** * Determines the text alignment of the component. * * @public * @attr */ get textAlign(): TextAlignment; set textAlign(value: TextAlignment); /** * Called when the password is shown. * Provides reference to `IPasswordRevealedEventDetail` as event detail. * * @public * @readonly * @eventProperty */ get passwordRevealed(): IEventEmitter; /** * Called when the password is hidden. * Provides reference to `IPasswordConcealedEventDetail` as event detail. * * @public * @readonly * @eventProperty */ get passwordConcealed(): IEventEmitter; /** * @public * @override */ focus(): void; /** * @public * @override */ blur(): void; /** * Clears the value of the element but not the validation. * * @public * @override */ clear(force?: boolean): boolean; /** * Resets the value, all kinds of validation and errors. * * @public * @override */ reset(): void; /** * Checks the validity of the element and returns `true` if it is valid; otherwise, `false`. * * @public * @override */ checkValidity(): boolean; /** * Shows the password. * * @public */ reveal(): void; /** * Hides the password. * * @public */ conceal(): void; /** * @template * @protected */ onChange(event: Event): void; /** * @template * @protected * @override */ onInput(event: InputEvent): void; /** * @template * @protected * @override */ onFocus(event: FocusEvent): void; /** * @template * @protected * @override */ onBlur(event: FocusEvent): void; /** * @protected * @override */ protected onApplyTemplate(): void; /** * Emits the `passwordRevealed` event. * * @protected */ protected onPasswordRevealed(args: IPasswordRevealedEventDetail): void; /** * Emits the `passwordConcealed` event. * * @protected */ protected onPasswordConcealed(args: IPasswordConcealedEventDetail): void; } /** * @public */ export declare namespace PasswordBoxElement { type Props = IPasswordBoxElementProps; } /** * @public */ declare global { interface HTMLElementTagNameMap { 'mosaik-passwordbox': PasswordBoxElement; } } export {}; //# sourceMappingURL=PasswordBoxElement.d.ts.map