primevue-mirror/components/lib/inlinemessage/InlineMessage.d.ts

65 lines
1.7 KiB
TypeScript
Raw Normal View History

2023-03-01 12:59:47 +00:00
/**
*
* InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message.
*
* [Live Demo](https://www.primevue.org/inlinemessage/)
*
* @module inlinemessage
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-03-01 12:59:47 +00:00
/**
* Defines valid properties in InlineMessage component.
*/
2022-09-06 12:03:37 +00:00
export interface InlineMessageProps {
/**
* 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-27 08:09:36 +00:00
severity?: 'success' | 'info' | 'warn' | 'error' | string | undefined;
/**
* Display a custom icon for the message.
* @deprecated since v3.27.0. Use 'icon' slot.
*/
icon?: string | undefined;
2022-09-06 12:03:37 +00:00
}
2023-03-01 12:59:47 +00:00
/**
* Defines valid slots in InlineMessage slots.
*/
2022-09-06 12:03:37 +00:00
export interface InlineMessageSlots {
/**
* Default custom slot.
*/
2023-03-01 12:59:47 +00:00
default(): VNode[];
/**
* Custom message icon template.
*/
icon(): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-03-01 12:59:47 +00:00
export interface InlineMessageEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 12:59:47 +00:00
/**
* **PrimeVue - InlineMessage**
*
* _InlineMessage component is useful in cases where a single message needs to be displayed related to an element such as forms. It has one property, severity of the message._
*
* [Live Demo](https://www.primevue.org/inlinemessage/)
* --- ---
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 InlineMessage extends ClassComponent<InlineMessageProps, InlineMessageSlots, InlineMessageEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
InlineMessage: GlobalComponentConstructor<InlineMessage>;
2022-09-06 12:03:37 +00:00
}
}
export default InlineMessage;