primevue-mirror/components/confirmpopup/ConfirmPopup.d.ts

60 lines
1.5 KiB
TypeScript
Raw Normal View History

2023-03-01 10:18:17 +00:00
/**
*
* ConfirmPopup displays a confirmation overlay displayed relatively to its target.
*
* [Live Demo](https://www.primevue.org/confirmpopup)
*
* @module confirmpopup
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
import { ConfirmationOptions } from '../confirmationoptions';
2023-03-01 10:18:17 +00:00
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
2023-03-01 10:18:17 +00:00
/**
* Defines valid properties in ConfirmPopup component.
*/
2022-09-06 12:03:37 +00:00
export interface ConfirmPopupProps {
/**
* Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.
*/
group?: string;
}
2023-03-01 10:18:17 +00:00
/**
* Defines valid slots in ConfirmPopup component.
*/
2022-09-06 12:03:37 +00:00
export interface ConfirmPopupSlots {
/**
* Custom message template.
* @param {Object} scope - message slot's params.
*/
2023-03-01 10:18:17 +00:00
message(scope: { message: ConfirmationOptions }): VNode[];
2022-09-06 12:03:37 +00:00
}
2023-03-01 10:18:17 +00:00
/**
* Defines valid emits in ConfirmPopup component.
*/
export interface ConfirmPopupEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 10:18:17 +00:00
/**
* **PrimeVue - ConfirmPopup**
*
* _ConfirmPopup displays a confirmation overlay displayed relatively to its target._
*
* [Live Demo](https://www.primevue.org/confirmpopup/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
2023-03-01 14:48:23 +00:00
declare class ConfirmPopup extends ClassComponent<ConfirmPopupProps, ConfirmPopupSlots, ConfirmPopupEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
ConfirmPopup: GlobalComponentConstructor<ConfirmPopup>;
2022-09-06 12:03:37 +00:00
}
}
export default ConfirmPopup;