Skip to content

ConfirmDialogProps — @gj-kit/expo-ui

A public interface from @gj-kit/expo-ui. The signature below is taken directly from the 0.8.1 release declaration.

import { ConfirmDialogProps } from '@gj-kit/expo-ui';
interface ConfirmDialogProps extends Omit<CommonProps, 'unstyled'> {
/** The caller owns visibility; this component only requests dismissal. */
visible: boolean;
/** The visible title also names the underlying modal. */
title: string;
description?: string | undefined;
/** Runs the affirmative action. It never closes the dialog automatically. */
onConfirm: () => void;
/** Receives every user-initiated close request, including the cancel action. */
onDismiss: (details: ConfirmDialogDismissDetails) => void;
/** Defaults to strings.cancel. */
cancelLabel?: string | undefined;
/** Defaults to strings.confirm. */
confirmLabel?: string | undefined;
/** Defaults to primary. The narrow set keeps the affirmative action semantic. */
confirmVariant?: Extract<ButtonVariant, 'primary' | 'destructive'> | undefined;
/** Disables only the affirmative action; cancel and ordinary dismissal stay available. */
confirmDisabled?: boolean | undefined;
/** Blocks every action and dismissal while the caller's confirmation work is pending. */
loading?: boolean | undefined;
/** Defaults to true. It affects only backdrop presses, like Dialog. */
dismissOnBackdrop?: boolean | undefined;
/**
* Passed through to Dialog. Defaults to Dialog's 'fade'; Dialog animates
* only once the platform has affirmatively reported that reduced motion is
* off, and presents with 'none' otherwise (unresolved or reduced).
*/
animationType?: NonNullable<ModalProps['animationType']> | undefined;
/** Best-effort focus restoration after the modal exits. */
finalFocusRef?: DialogFocusRef | undefined;
overlayId?: string | undefined;
/** testID of the cancel button. Defaults to `${testID}-cancel`. */
cancelTestID?: string | undefined;
/** testID of the confirm button. Defaults to `${testID}-confirm`. */
confirmTestID?: string | undefined;
unstyled?: never;
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/expo-ui
  • Version: 0.8.1
  • Public entry: .
  • Source: GitHub