ConfirmDialog onHide type definition doesn't match runtime behavior

[reponemec]

ConfirmDialog onHide type definition doesn't match runtime behavior

The type definition for ConfirmDialog's onHide callback doesn't match its runtime behavior.

According to confirmdialog.d.ts, onHide is defined as:

onHide: (result: string) => void

However, at runtime, the callback receives an array containing an object with a result property:

[{ result: 'cancel' | 'accept' | 'reject' }]

This causes TypeScript errors when trying to properly type the onHide callback handler.

To reproduce:

interface ConfirmDialogHideEvent {
    result: 'cancel' | 'accept' | 'reject';
}

confirmDialog({
    onHide: (event: ConfirmDialogHideEvent[]) => {  // TypeScript error here
        if (event[0]?.result === 'cancel') {
            // handle dialog close
        }
    }
});

Current workaround:

// @ts-ignore - PrimeReact ConfirmDialog has incorrect type definition - onHide returns [{result: 'cancel' | 'accept' | 'reject'}] instead of string
onHide: (event: ConfirmDialogHideEvent[]) => {
    if (event[0]?.result === 'cancel') {
        // handle dialog close
    }
}

Expected behavior:
The type definition should match the actual runtime behavior.

Environment:
"primereact": "^10.8.3"
"react": "^18.3.1"
"typescript": "^5.2.2"

[melloware]

@reponemec i submitted a PR to fix it so it actually returns the type matching the Typescript it should just be a single string "accept" or "reject". It should not be an ARRAY.

[reponemec]

After updating to PrimeReact version 10.9.2, I've observed that the type of the result parameter in the onHide handler of the ConfirmDialog component varies depending on how the dialog is closed:

• "YES" button: [{ result: "accept" }]
• "NO" button: [{ result: "reject" }]
• "Esc" key: [{ result: KeyboardEvent }]
• "X" button: [{ result: SyntheticBaseEvent }]

Is this behavior intentional and final?

[melloware]

No that is not intentional it should be a single string of either 'cancel' | 'accept' | 'reject' let me make sure ESC and X button both are handled correctly.

[melloware]

@reponemec thanks for the report just submitted PR to fix ESC/Close to report 'cancel'