vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

ConfirmDialog d.ts updated

pull/3689/head
Tuğçe Küçükoğlu 2023-03-01 11:50:24 +03:00
parent 9580d434f6
commit d5cbedb80c
1 changed files with 36 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
components/confirmdialog/ConfirmDialog.d.ts vendored
View File

@ -1,7 +1,19 @@
/**
*
* ConfirmDialog uses a Dialog UI with confirmDialog method or <ConfirmDialog> tag.
*
* [Live Demo](https://www.primevue.org/confirmdialog)
*
* @module confirmdialog
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
import { ConfirmationOptions } from '../confirmationoptions'; import { ConfirmationOptions } from '../confirmationoptions';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Breakpoint metadata.
*/
export interface ConfirmDialogBreakpoints { export interface ConfirmDialogBreakpoints {
/** /**
* Breakpoint for responsive mode. * Breakpoint for responsive mode.
@ -21,6 +33,9 @@ export interface ConfirmDialogBreakpoints {
[key: string]: string; [key: string]: string;
} }
/**
* Defines valid properties in ConfirmDialog component.
*/
export interface ConfirmDialogProps { export interface ConfirmDialogProps {
/** /**
* Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance. * Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.
@ -33,17 +48,34 @@ export interface ConfirmDialogProps {
breakpoints?: ConfirmDialogBreakpoints; breakpoints?: ConfirmDialogBreakpoints;
} }
/**
* Defines valid slots in ConfirmDialog component.
*/
export interface ConfirmDialogSlots { export interface ConfirmDialogSlots {
/** /**
* Custom message template. * Custom message template.
* @param {Object} scope - message slot's params. * @param {Object} scope - message slot's params.
*/ */
message: (scope: { message: ConfirmationOptions }) => VNode[]; message(scope: { message: ConfirmationOptions }): VNode[];
} }
export declare type ConfirmDialogEmits = {}; /**
* Defines valid emits in ConfirmDialog component.
*/
export interface ConfirmDialogEmits {}
declare class ConfirmDialog extends ClassComponent<ConfirmDialogProps, ConfirmDialogSlots, ConfirmDialogEmits> {} /**
* **PrimeVue - ConfirmDialog**
*
* _ConfirmDialog uses a Dialog UI with confirmDialog method or <ConfirmDialog> tag._
*
* [Live Demo](https://www.primevue.org/confirmdialog/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
export declare class ConfirmDialog extends ClassComponent<ConfirmDialogProps, ConfirmDialogSlots, ConfirmDialogEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {
interface GlobalComponents { interface GlobalComponents {
@ -51,18 +83,4 @@ declare module '@vue/runtime-core' {
} }
} }
/**
*
* ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.
*
* Helper API:
*
* - Confirmation API
* - ConfirmationService
*
* Demos:
*
* - [ConfirmDialog](https://www.primefaces.org/primevue/confirmdialog)
*
*/
export default ConfirmDialog; export default ConfirmDialog;