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

245 lines
6.4 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
*
*/
2023-08-02 14:07:22 +00:00
import { TransitionProps, VNode } from 'vue';
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
2023-05-02 08:01:27 +00:00
import { ButtonPassThroughOptions } from '../button';
2022-09-06 12:03:37 +00:00
import { ConfirmationOptions } from '../confirmationoptions';
2023-09-05 08:50:46 +00:00
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
export declare type ConfirmPopupPassThroughOptionType = ConfirmPopupPassThroughAttributes | ((options: ConfirmPopupPassThroughMethodOptions) => ConfirmPopupPassThroughAttributes | string) | string | null | undefined;
2023-04-24 11:22:01 +00:00
2023-08-02 14:07:22 +00:00
export declare type ConfirmPopupPassThroughTransitionType = TransitionProps | ((options: ConfirmPopupPassThroughMethodOptions) => TransitionProps) | undefined;
2023-04-24 11:22:01 +00:00
/**
* Custom passthrough(pt) option method.
*/
export interface ConfirmPopupPassThroughMethodOptions {
/**
* Defines instance.
*/
2023-07-06 12:01:33 +00:00
instance: any;
/**
* Defines valid properties.
*/
2023-04-24 11:22:01 +00:00
props: ConfirmPopupProps;
/**
* Defines current inline state.
*/
2023-04-24 11:22:01 +00:00
state: ConfirmPopupState;
/**
* Defines valid attributes.
*/
attrs: any;
/**
* Defines parent options.
*/
parent: any;
2023-09-05 08:50:46 +00:00
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
2023-04-24 11:22:01 +00:00
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface ConfirmPopupSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: ConfirmPopupProps;
/**
* Defines current inline state.
*/
state: ConfirmPopupState;
}
2023-04-24 11:22:01 +00:00
/**
* Custom passthrough(pt) options.
* @see {@link ConfirmPopupProps.pt}
*/
export interface ConfirmPopupPassThroughOptions {
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the root's DOM element.
2023-04-24 11:22:01 +00:00
*/
root?: ConfirmPopupPassThroughOptionType;
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the content's DOM element.
2023-04-24 11:22:01 +00:00
*/
content?: ConfirmPopupPassThroughOptionType;
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the icon's DOM element.
2023-04-24 11:22:01 +00:00
*/
icon?: ConfirmPopupPassThroughOptionType;
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the message's DOM element.
2023-04-24 11:22:01 +00:00
*/
message?: ConfirmPopupPassThroughOptionType;
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the footer's DOM element.
2023-04-24 11:22:01 +00:00
*/
footer?: ConfirmPopupPassThroughOptionType;
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the Button component.
2023-05-02 08:01:27 +00:00
* @see {@link ButtonPassThroughOptions}
2023-04-24 11:22:01 +00:00
*/
rejectButton?: ButtonPassThroughOptions<ConfirmPopupSharedPassThroughMethodOptions>;
2023-04-24 11:22:01 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the Button component.
2023-05-02 08:01:27 +00:00
* @see {@link ButtonPassThroughOptions}
2023-04-24 11:22:01 +00:00
*/
acceptButton?: ButtonPassThroughOptions<ConfirmPopupSharedPassThroughMethodOptions>;
2023-07-06 11:09:01 +00:00
/**
2023-11-07 06:16:39 +00:00
* Used to manage all lifecycle hooks.
2023-07-06 11:09:01 +00:00
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-08-02 12:00:18 +00:00
/**
* Used to control Vue Transition API.
*/
2023-08-02 14:07:22 +00:00
transition?: ConfirmPopupPassThroughTransitionType;
2023-04-24 11:22:01 +00:00
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface ConfirmPopupPassThroughAttributes {
[key: string]: any;
}
/**
* Defines current inline state in ConfirmPopup component.
*/
export interface ConfirmPopupState {
/**
* Current visible state as a boolean.
* @defaultValue false
*/
visible: boolean;
/**
* Current confirmation message.
*/
confirmation: ConfirmationOptions;
}
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-04-24 11:22:01 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to DOM elements inside the component.
2023-04-24 11:22:01 +00:00
* @type {ConfirmPopupPassThroughOptions}
*/
pt?: PassThrough<ConfirmPopupPassThroughOptions>;
2023-09-05 08:50:46 +00:00
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
2023-05-29 18:41:50 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
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.
*/
message(scope: {
/**
* Message of the component
*/
message: ConfirmationOptions;
}): VNode[];
/**
* Custom icon template.
2023-08-17 07:16:25 +00:00
* @param {Object} scope - icon slot's params.
*/
icon(scope: {
/**
* Style class of the icon template
*/
class: any;
}): VNode[];
/**
* Custom icon template.
*/
accepticon(): VNode[];
/**
* Custom icon template.
*/
rejecticon(): VNode[];
2023-09-19 11:14:41 +00:00
/**
* Custom container slot.
* @param {Object} scope - container slot's params.
*/
container(scope: {
/**
* Message of the component
*/
message: any;
/**
* Accept function of the component
* @deprecated since v3.39.0. Use 'acceptCallback' property instead.
2023-09-19 11:14:41 +00:00
*/
onAccept: () => void;
/**
* Reject function of the component
* @deprecated since v3.39.0. Use 'rejectCallback' property instead.
2023-09-19 11:14:41 +00:00
*/
onReject: () => void;
/**
* Accept function of the component
*/
acceptCallback: () => void;
/**
* Reject function of the component
*/
rejectCallback: () => void;
2023-09-19 11:14:41 +00:00
}): 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;