Preparing search index...
The search index is not available
@shopify/cli-kit
@shopify/cli-kit
node/ui
RenderTextPromptOptions
Interface RenderTextPromptOptions
interface
RenderTextPromptOptions
{
abortSignal
?:
AbortSignal
;
allowEmpty
?:
boolean
;
defaultValue
?:
string
;
emptyDisplayedValue
?:
string
;
initialAnswer
?:
string
;
message
:
TokenItem
;
password
?:
boolean
;
preview
?:
(
(
value
)
=>
TokenItem
<
InlineToken
>
)
;
renderOptions
?:
RenderOptions
;
validate
?:
(
(
value
)
=>
undefined
|
string
)
;
}
Hierarchy
Omit
<
TextPromptProps
,
"onSubmit"
>
RenderTextPromptOptions
Index
Properties
abort
Signal?
allow
Empty?
default
Value?
empty
Displayed
Value?
initial
Answer?
message
password?
preview?
render
Options?
validate?
Properties
Optional
abort
Signal
abort
Signal
?:
AbortSignal
Optional
allow
Empty
allow
Empty
?:
boolean
Optional
default
Value
default
Value
?:
string
Optional
empty
Displayed
Value
empty
Displayed
Value
?:
string
Optional
initial
Answer
initial
Answer
?:
string
message
message
:
TokenItem
Optional
password
password
?:
boolean
Optional
preview
preview
?:
(
(
value
)
=>
TokenItem
<
InlineToken
>
)
Type declaration
(
value
)
:
TokenItem
<
InlineToken
>
Parameters
value
:
string
Returns
TokenItem
<
InlineToken
>
Optional
render
Options
render
Options
?:
RenderOptions
Optional
validate
validate
?:
(
(
value
)
=>
undefined
|
string
)
Type declaration
(
value
)
:
undefined
|
string
Parameters
value
:
string
Returns
undefined
|
string
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
abort
Signal
allow
Empty
default
Value
empty
Displayed
Value
initial
Answer
message
password
preview
render
Options
validate
@shopify/cli-kit
Loading...