primeng/types/primeng-types-message.d.ts

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

import { TemplateRef } from '@angular/core';
import { MotionOptions } from '@primeuix/motion';
import { PassThrough, PassThroughOption } from 'primeng/api';

/**
 * Message severity type.
 * @group Types
 */
type MessageSeverity = 'success' | 'info' | 'warn' | 'error' | 'secondary' | 'contrast';
/**
 * Message variant type.
 * @group Types
 */
type MessageVariant = 'outlined' | 'text' | 'simple';
/**
 * Message size type.
 * @group Types
 */
type MessageSize = 'large' | 'small';
/**
 * Message close event.
 * @group Interface
 */
interface MessageCloseEvent {
    /**
     * Browser event.
     */
    originalEvent: Event;
}
/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Message.pt}
 * @group Interface
 */
interface MessagePassThroughOptions<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 content's DOM element.
     */
    content?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the content's DOM element.
     */
    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the icon's DOM element.
     */
    icon?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the text's DOM element.
     */
    text?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the close button's DOM element.
     */
    closeButton?: PassThroughOption<HTMLButtonElement, I>;
    /**
     * Used to pass attributes to the close icon's DOM element.
     */
    closeIcon?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass options to the motion component/directive.
     */
    motion?: MotionOptions;
}
/**
 * Defines valid pass-through options in Message.
 * @see {@link MessagePassThroughOptions}
 *
 * @template I Type of instance.
 */
type MessagePassThrough<I = unknown> = PassThrough<I, MessagePassThroughOptions<I>>;
/**
 * Custom container template context.
 * @group Interface
 */
interface MessageContainerTemplateContext {
    /**
     * Callback to close the message.
     */
    closeCallback: (event: Event) => void;
}
/**
 * Defines valid templates in Message.
 * @group Templates
 */
interface MessageTemplates {
    /**
     * Custom container template.
     * @param {Object} context - container context.
     */
    container(context: MessageContainerTemplateContext): TemplateRef<MessageContainerTemplateContext>;
    /**
     * Custom icon template.
     */
    icon(): TemplateRef<void>;
    /**
     * Custom close icon template.
     */
    closeicon(): TemplateRef<void>;
}

export type { MessageCloseEvent, MessageContainerTemplateContext, MessagePassThrough, MessagePassThroughOptions, MessageSeverity, MessageSize, MessageTemplates, MessageVariant };