148 lines
3.9 KiB
TypeScript
Executable File
148 lines
3.9 KiB
TypeScript
Executable File
/**
|
|
*
|
|
* 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
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ComponentHooks } from '../basecomponent';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
|
|
|
|
export declare type InlineMessagePassThroughOptionType = InlineMessagePassThroughAttributes | ((options: InlineMessagePassThroughMethodOptions) => InlineMessagePassThroughAttributes | string) | string | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface InlineMessagePassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: InlineMessageProps;
|
|
/**
|
|
* Defines current inline state.
|
|
*/
|
|
state: InlineMessageState;
|
|
/**
|
|
* Defines passthrough(pt) options in global config.
|
|
*/
|
|
global: object | undefined;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link InlineMessageProps.pt}
|
|
*/
|
|
export interface InlineMessagePassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: InlineMessagePassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the icon's DOM element.
|
|
*/
|
|
icon?: InlineMessagePassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the text's DOM element.
|
|
*/
|
|
text?: InlineMessagePassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface InlineMessagePassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines current inline state in InlineMessage component.
|
|
*/
|
|
export interface InlineMessageState {
|
|
/**
|
|
* Current visible state as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
visible: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in InlineMessage component.
|
|
*/
|
|
export interface InlineMessageProps {
|
|
/**
|
|
* Severity level of the message.
|
|
* @defaultValue info
|
|
*/
|
|
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;
|
|
/**
|
|
* Used to pass attributes to DOM elements inside the component.
|
|
* @type {InlineMessagePassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<InlineMessagePassThroughOptions>;
|
|
/**
|
|
* Used to configure passthrough(pt) options of the component.
|
|
* @type {PassThroughOptions}
|
|
*/
|
|
ptOptions?: PassThroughOptions;
|
|
/**
|
|
* When enabled, it removes component related styles in the core.
|
|
* @defaultValue false
|
|
*/
|
|
unstyled?: boolean;
|
|
}
|
|
/**
|
|
* Defines valid slots in InlineMessage slots.
|
|
*/
|
|
export interface InlineMessageSlots {
|
|
/**
|
|
* Default custom slot.
|
|
*/
|
|
default(): VNode[];
|
|
/**
|
|
* Custom message icon template.
|
|
*/
|
|
icon(): VNode[];
|
|
}
|
|
|
|
export interface InlineMessageEmits {}
|
|
|
|
/**
|
|
* **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/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class InlineMessage extends ClassComponent<InlineMessageProps, InlineMessageSlots, InlineMessageEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
InlineMessage: GlobalComponentConstructor<InlineMessage>;
|
|
}
|
|
}
|
|
|
|
export default InlineMessage;
|