primevue-mirror/components/toastservice/ToastService.d.ts

35 lines
837 B
TypeScript
Raw Normal View History

2022-09-06 12:03:37 +00:00
import { Plugin } from 'vue';
import { ToastMessageOptions } from '../toast';
declare const plugin: Plugin;
export default plugin;
export interface ToastServiceMethods {
/**
* Displays the message in a suitable Toast component.
* @param {ToastMessageOptions} message - Message instance.
*/
add: (message: ToastMessageOptions) => void;
/**
* Clears the messages that belongs to the group.
* @param {string} group - Name of the message group.
*/
removeGroup: (group: string) => void;
/**
* Clears all the messages.
*/
removeAllGroups: () => void;
}
declare module 'vue/types/vue' {
interface Vue {
$toast: ToastServiceMethods;
}
}
declare module '@vue/runtime-core' {
interface ComponentCustomProperties {
$toast: ToastServiceMethods;
}
}