DialogPrompt class

A dialog with a text input field.

Displays a title, optional description, a text input, and submit/cancel via enter/esc.

Uses DialogThemeData for styling when available.

DialogPrompt.show(
  context,
  title: 'Rename Session',
  description: 'Enter a new name for this session.',
  placeholder: 'Session name',
  onSubmit: (value) => _rename(value),
);
Inheritance

Constructors

DialogPrompt({required String title, Widget? description, String? placeholder, String? initialValue, void onSubmit(String value)?, CmdCallback? onCancel, Key? key})

Properties

children List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough bool
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
description Widget?
Optional description shown below the title.
final
focusable bool
Whether this widget can receive keyboard focus.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
Unique identifier for this widget.
no setterinherited
initialValue String?
Initial value for the input field.
final
key Key?
Key for preserving widget identity.
finalinherited
onCancel CmdCallback?
Called when the user cancels (esc).
final
onSubmit → void Function(String value)?
Called when the user submits (enter). Receives the input text.
final
placeholder String?
Placeholder text for the input field.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
theme Theme
Access the current theme.
no setterinherited
title String
The dialog title (displayed bold).
final

Methods

buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
createState() State<StatefulWidget>
Creates the mutable State associated with this widget.
override
handleInit() Cmd?
Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?)
Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?)
Override this to handle messages specific to this widget.
inherited
init() Cmd?
Called once when the widget is first mounted.
inherited
invalidateCachedView() → void
Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?)
Handles messages by forwarding to children then calling handleUpdate.
inherited
view() Object
Renders the widget to a string or View.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

show(BuildContext context, {required String title, Widget? description, String? placeholder, String? initialValue, void onSubmit(String value)?}) → void
Show a text prompt dialog via DialogStack.