Skip to main content

ConfirmProps

Hierarchy

  • Omit<PromptProps<boolean>, validate>
    • ConfirmProps

Index

Properties

Properties

optionalinvalidError

invalidError?: string

Error message to display when an invalid character is pressed. Defaults to a custom message.

label

label: NonNullable<ReactNode>

Label to display before or above the prompt itself.

optionalno

no?: string

Character that triggers a falsy state when pressed. Defaults to "N".

onSubmit

onSubmit: (value: boolean) => void

Callback triggered when the value is submitted.

optionalprefix

prefix?: string

Single character symbol to display before the label. Defaults to "?"".

optionalyes

yes?: string

Character that triggers a truthy state when pressed. Defaults to "y".