primevue-mirror/components/message/Message.d.ts

94 lines
2.2 KiB
TypeScript
Raw Normal View History

2023-03-01 12:59:47 +00:00
/**
*
* Message groups a collection of contents in tabs.
*
* [Live Demo](https://www.primevue.org/message/)
*
* @module message
*
*/
2022-12-08 11:04:25 +00:00
import { ButtonHTMLAttributes, VNode } from 'vue';
2022-09-06 12:03:37 +00:00
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-03-01 12:59:47 +00:00
/**
* Defines valid properties in Message component.
*/
2022-09-06 12:03:37 +00:00
export interface MessageProps {
/**
* Severity level of the message.
2023-03-08 10:51:52 +00:00
* @defaultValue info
2022-09-06 12:03:37 +00:00
*/
2023-03-01 12:59:47 +00:00
severity?: 'success' | 'info' | 'warn' | 'error' | undefined;
2022-09-06 12:03:37 +00:00
/**
* Whether the message can be closed manually using the close icon.
2023-03-01 12:59:47 +00:00
* @defaultValue true
2022-09-06 12:03:37 +00:00
*/
closable?: boolean | undefined;
/**
* When enabled, message is not removed automatically.
2023-03-01 12:59:47 +00:00
* @defaultValue true
2022-09-06 12:03:37 +00:00
*/
sticky?: boolean | undefined;
/**
* Delay in milliseconds to close the message automatically.
2023-03-01 12:59:47 +00:00
* @defaultValue 3000
2022-09-06 12:03:37 +00:00
*/
life?: number | undefined;
/**
* Display a custom icon for the message.
*/
icon?: string | undefined;
2022-12-08 11:04:25 +00:00
/**
* Icon to display in the message close button.
2023-03-08 10:51:52 +00:00
* @defaultValue pi pi-times
2022-12-08 11:04:25 +00:00
*/
closeIcon?: string | undefined;
/**
* Uses to pass all properties of the HTMLButtonElement to the close button.
*/
closeButtonProps?: ButtonHTMLAttributes | undefined;
2022-09-06 12:03:37 +00:00
}
2023-03-01 12:59:47 +00:00
/**
* Defines valid slots in Message slots.
*/
2022-09-06 12:03:37 +00:00
export interface MessageSlots {
/**
* Default custom slot.
*/
2023-03-01 12:59:47 +00:00
default(): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-03-01 12:59:47 +00:00
/**
* Defines valid emits in Message component.
*/
export interface MessageEmits {
2022-09-06 12:03:37 +00:00
/**
* Callback to invoke when a message is closed.
* @param {Event} event - Browser event.
*/
2023-03-01 12:59:47 +00:00
close(event: Event): void;
}
2022-09-06 12:03:37 +00:00
2023-03-01 12:59:47 +00:00
/**
* **PrimeVue - Message**
*
* _Messages is used to display inline messages with various severities._
*
* [Live Demo](https://www.primevue.org/message/)
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-03-01 12:59:47 +00:00
*
* @group Component
*
*/
2022-09-14 11:26:01 +00:00
declare class Message extends ClassComponent<MessageProps, MessageSlots, MessageEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
Message: GlobalComponentConstructor<Message>;
2022-09-06 12:03:37 +00:00
}
}
export default Message;