diff --git a/src/components/confirmdialog/ConfirmDialog.d.ts b/src/components/confirmdialog/ConfirmDialog.d.ts index 590f0f2a8..391217e49 100644 --- a/src/components/confirmdialog/ConfirmDialog.d.ts +++ b/src/components/confirmdialog/ConfirmDialog.d.ts @@ -1,10 +1,62 @@ -interface ConfirmDialogProps { - group?: string; - breakpoints?: {[key: string]: string}; +import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; + +export interface ConfirmDialogBreakpoints { + /** + * Breakpoint for responsive mode. + * + * Example: + * + * + * + * Result: + * + * @media screen and (max-width: ${breakpoint[key]}) { + * .p-dialog[attributeSelector] { + * width: ${breakpoint[value]} !important; + * } + * } + */ + [key: string]: string; } -declare class ConfirmDialog { - $props: ConfirmDialogProps; +export interface ConfirmDialogProps { + /** + * Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance. + */ + group?: string | undefined; + /** + * Object literal to define widths per screen size. + * @see ConfirmDialogBreakpoints + */ + breakpoints?: ConfirmDialogBreakpoints; } +export interface ConfirmDialogSlots { +} + +export declare type ConfirmDialogEmits = { +} + +declare class ConfirmDialog extends ClassComponent { } + +declare module '@vue/runtime-core' { + interface GlobalComponents { + ConfirmDialog: GlobalComponentConstructor + } +} + +/** + * + * ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API. + * + * Helper API: + * + * - Confirmation API + * - ConfirmationService + * + * Demos: + * + * - [ConfirmDialog](https://www.primefaces.org/primevue/showcase/#/confirmdialog) + * + */ export default ConfirmDialog;