oc · docs
docs / documentation

@orangecheck/design


@orangecheck/design / PromptOptions

Interface: PromptOptions

Defined in: primitives/prompt-dialog.tsx:18

Promise-based replacement for window.prompt, in the house design language. Call prompt({...}); mount one <PromptHost /> at the app root (alongside <ConfirmHost />). Supports a masked secret input, a matching confirmField ("choose a passphrase, twice"), and a validate hook.

Properties

PropertyTypeDescriptionDefined in
<a id="property-cancellabel"></a> cancelLabel?string-primitives/prompt-dialog.tsx:25
<a id="property-confirmfield"></a> confirmField?booleanShow a second input that must match the first. Implies validation.primitives/prompt-dialog.tsx:29
<a id="property-confirmlabel"></a> confirmLabel?string-primitives/prompt-dialog.tsx:24
<a id="property-defaultvalue"></a> defaultValue?string-primitives/prompt-dialog.tsx:23
<a id="property-label"></a> label?string-primitives/prompt-dialog.tsx:21
<a id="property-message"></a> message?string-primitives/prompt-dialog.tsx:20
<a id="property-minlength"></a> minLength?numberMinimum accepted length.primitives/prompt-dialog.tsx:31
<a id="property-placeholder"></a> placeholder?string-primitives/prompt-dialog.tsx:22
<a id="property-secret"></a> secret?booleanMask the input.primitives/prompt-dialog.tsx:27
<a id="property-title"></a> titlestring-primitives/prompt-dialog.tsx:19
<a id="property-validate"></a> validate?(value: string) => string | nullReturn an error string to block submission, or null to allow it.primitives/prompt-dialog.tsx:33