primeng/types/primeng-types-inputotp.d.ts

PrimeNG is an open source UI library for Angular featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeB

import { TemplateRef } from '@angular/core';
import { PassThroughOption, PassThrough } from 'primeng/api';
import { InputTextPassThrough } from 'primeng/types/inputtext';

/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link InputOtp.pt}
 * @group Interface
 */
interface InputOtpPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the host's DOM element.
     */
    host?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the InputText component.
     */
    pcInputText?: InputTextPassThrough;
}
/**
 * Custom passthrough attributes for each DOM elements
 * @group Interface
 */
type InputOtpPassThrough<I = unknown> = PassThrough<I, InputOtpPassThroughOptions<I>>;
/**
 * Input change event.
 * @group Events
 */
interface InputOtpChangeEvent {
    /**
     * Browser event.
     */
    originalEvent: Event;
    /**
     * Updated value.
     */
    value: any;
}
/**
 * Context interface for the input template events.
 * @group Interface
 */
interface InputOtpTemplateEvents {
    /**
     * Input event handler.
     */
    input: (event: Event, index: number) => void;
    /**
     * Keydown event handler.
     */
    keydown: (event: Event) => void;
    /**
     * Focus event handler.
     */
    focus: (event: Event) => void;
    /**
     * Blur event handler.
     */
    blur: (event: Event) => void;
    /**
     * Paste event handler.
     */
    paste: (event: Event) => void;
}
/**
 * Custom input template context.
 * @group Interface
 */
interface InputOtpInputTemplateContext {
    /**
     * Token value.
     */
    $implicit: number | string;
    /**
     * Browser events of the template.
     */
    events: InputOtpTemplateEvents;
    /**
     * Index of the token.
     */
    index: number;
}
/**
 * Defines valid templates in InputOtp.
 * @group Templates
 */
interface InputOtpTemplates {
    /**
     * Custom input template.
     * @param {Object} context - input context.
     */
    input(context: InputOtpInputTemplateContext): TemplateRef<InputOtpInputTemplateContext>;
}

export type { InputOtpChangeEvent, InputOtpInputTemplateContext, InputOtpPassThrough, InputOtpPassThroughOptions, InputOtpTemplateEvents, InputOtpTemplates };