Summary

Add utilities for confirmation dialogs and error dialogs.

Review Request #14651 — Created Oct. 24, 2025 and submitted Nov. 25, 2025, 6:07 p.m.

Information

Owner

chipx86

Repository

Ink

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

This introduces two new utility functions for easily constructing and

processing common types of message dialogs:


Ink.showConfirmDialog: Shows a confirmation dialog (a replacement

  for window.confirm().


Ink.showErrorDialog: Shows an error dialog (a replacement

  for window.alert().


These are designed as utility functions that take a minimal set of

options (but can be fairly customized). They return a Promise, which is

resolved only once a choice has been made, allowing an async function to

await on the result and process it before continuing.
If the user confirmed, they'll get a truthy object that contains further

information that may be useful for processing. If they cancel, they'll

get a null result instead.
The confirmation dialog can also take an async onConfirm handler,

which will keep the dialog open and the buttons in a busy state until

completed. That may return false, which will abort the dialog the same

way as if the user hit Cancel. This is intended for error reporting

during an operation.
Confirmation dialogs can also be suppressed, using the new functionality

in DialogView. This is off by default, but can be opted into. It's up

to the caller to handle all confirmation logic.

Testing Done

Tested the dialogs in all supported conditions.

Commits

Summary	ID
Add utilities for confirmation dialogs and error dialogs. This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. That may return `false`, which will abort the dialog the same way as if the user hit Cancel. This is intended for error reporting during an operation. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.	90b81552313febe82ba07a92a18cddbc62c2ec1c

Summary

Add utilities for confirmation dialogs and error dialogs.

This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. That may return `false`, which will abort the dialog the same way as if the user hit Cancel. This is intended for error reporting during an operation. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.

90b81552313febe82ba07a92a18cddbc62c2ec1c

Files

Issues

Description	From	Last Updated
Do we want some kind of error icon? I feel like that can help trigger people to actually read the …	david	Nov. 25, 2025, 12:56 p.m.
There's an extra period here.	maubin	Nov. 6, 2025, 3:27 a.m.
The annotation here has ShowConfirmDialogResult as a parameter name. This should be: onConfirm?: ((result: ShowConfirmDialogResult) => Promise<boolean \| void>);	david	Nov. 25, 2025, 12:56 p.m.
The docs for this parameter in ShowConfirmDialogOptions say the default is "Confirm" Also, do we want to extract this out …	david	Nov. 25, 2025, 12:58 p.m.
Do we want to extract this out into a constant somewhere and/or localize it somehow?	david	Nov. 25, 2025, 12:58 p.m.
The documentation in ShowErrorDialogOptions says the default for the title is "Error". Also, do we want to extract this out …	david	Nov. 25, 2025, 12:58 p.m.
This is calling done(null) but the promise is a Promise<void>. This should probably be changed to done()	david	Nov. 25, 2025, 12:59 p.m.
Do we want to extract this out into a constant somewhere and/or localize it somehow?	david	Nov. 25, 2025, 1 p.m.
Can we have this check if rawBody is iterable and have a separate else clause that logs an error?	david	Nov. 25, 2025, 1:03 p.m.
According to the type of MessageDialogBody this shouldn't be reachable, so this should probably be an error case.	david	Nov. 25, 2025, 1:12 p.m.
if rawBody is falsy, body is never initialized and we end up returning undefined	david	Nov. 25, 2025, 1:13 p.m.

flake8 passed.

JSHint passed.

Ship it!

src/ink/js/components/utils/dialogUtils.ts (Diff revision 1)
The issue has been resolved. Show all issues
```
There's an extra period here.
```

Change Summary:


onConfirm handlers can now force a cancellation result, useful when an operation fails and an error will be shown.
Fixed a typo in a version in a doc comment.

Description:

		This introduces two new utility functions for easily constructing and
		processing common types of message dialogs:

		`Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`.
		`Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`.

		These are designed as utility functions that take a minimal set of
		options (but can be fairly customized). They return a Promise, which is
		resolved only once a choice has been made, allowing an async function to
		await on the result and process it before continuing.

		If the user confirmed, they'll get a truthy object that contains further
		information that may be useful for processing. If they cancel, they'll
		get a `null` result instead.

		The confirmation dialog can also take an async `onConfirm` handler,
		which will keep the dialog open and the buttons in a busy state until
~		completed.
	~	completed. That may return `false`, which will abort the dialog the same
	+	way as if the user hit Cancel. This is intended for error reporting
	+	during an operation.

		Confirmation dialogs can also be suppressed, using the new functionality
		in `DialogView`. This is off by default, but can be opted into. It's up
		to the caller to handle all confirmation logic.

Commits:

	Summary	ID
	Add utilities for confirmation dialogs and error dialogs. This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.	e2796cf9cd3e3f8be6ea063afb9cda556d6fec69
	Add utilities for confirmation dialogs and error dialogs. This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. That may return `false`, which will abort the dialog the same way as if the user hit Cancel. This is intended for error reporting during an operation. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.	0e0003060dc1b36530bac209c88c9d508eefa12a

Diff:

Revision 2 (+1158)

Show changes

	src/ink/js/components/index.ts
	src/ink/js/components/utils/dialogUtils.ts
	src/ink/js/components/utils/index.ts
	src/stories/components/showConfirmDialog.stories.ts
	src/stories/components/showErrorDialog.stories.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Error Dialog (Revision 1)

The issue has been dropped. Show all issues

Do we want some kind of error icon? I feel like that can help trigger people to actually read the text.

chipx86 Nov. 25, 2025, 1:14 p.m.

Went back and forth on this. Probably worth doing, but I'm not doing it as part of this work. That'd be more support within the dialog component, and I'm down several rabbit holes as it is.

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

The annotation here has ShowConfirmDialogResult as a parameter name.
This should be:

onConfirm?: ((result: ShowConfirmDialogResult) => Promise<boolean | void>);

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

The docs for this parameter in ShowConfirmDialogOptions say the default is "Confirm"

Also, do we want to extract this out into a constant somewhere and/or localize it somehow?

chipx86 Nov. 25, 2025, 1:14 p.m.

Localization is a whole bag of worms. I want to figure that out but we don't exactly have Django's gettext API here.

I don't think there's a lot of value in a constant for these until/if we do localize.

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)
The issue has been dropped. Show all issues
```
Do we want to extract this out into a constant somewhere and/or localize it somehow?
```

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

The documentation in ShowErrorDialogOptions says the default for the title is "Error".

Also, do we want to extract this out into a constant somewhere and/or localize it somehow?

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

This is calling done(null) but the promise is a Promise<void>. This should probably be changed to done()

chipx86 Nov. 25, 2025, 1:14 p.m.

Copy/paste from the Confirm dialog. Fixing.

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been dropped. Show all issues

Do we want to extract this out into a constant somewhere and/or localize it somehow?

chipx86 Nov. 25, 2025, 1:14 p.m.

Same as above. For now I don't see value in that since it's used in one place only and we're nowhere near set up for localization.

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

Can we have this check if rawBody is iterable and have a separate else clause that logs an error?

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)

The issue has been resolved. Show all issues

According to the type of MessageDialogBody this shouldn't be reachable, so this should probably be an error case.

src/ink/js/components/utils/dialogUtils.ts (Diff revision 2)
The issue has been resolved. Show all issues
```
if rawBody is falsy, body is never initialized and we end up returning undefined
```

Change Summary:


Fixed some outdated docs.
Removed message body codepaths that should no longer be reachable.
Updated for the isSuppressChecked() change.
Removed an unnecessary value to the error dialog's done handler.
Fixed some types and results.

Commits:

	Summary	ID
	Add utilities for confirmation dialogs and error dialogs. This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. That may return `false`, which will abort the dialog the same way as if the user hit Cancel. This is intended for error reporting during an operation. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.	0e0003060dc1b36530bac209c88c9d508eefa12a
	Add utilities for confirmation dialogs and error dialogs. This introduces two new utility functions for easily constructing and processing common types of message dialogs: * `Ink.showConfirmDialog`: Shows a confirmation dialog (a replacement for `window.confirm()`. * `Ink.showErrorDialog`: Shows an error dialog (a replacement for `window.alert()`. These are designed as utility functions that take a minimal set of options (but can be fairly customized). They return a Promise, which is resolved only once a choice has been made, allowing an async function to await on the result and process it before continuing. If the user confirmed, they'll get a truthy object that contains further information that may be useful for processing. If they cancel, they'll get a `null` result instead. The confirmation dialog can also take an async `onConfirm` handler, which will keep the dialog open and the buttons in a busy state until completed. That may return `false`, which will abort the dialog the same way as if the user hit Cancel. This is intended for error reporting during an operation. Confirmation dialogs can also be suppressed, using the new functionality in `DialogView`. This is off by default, but can be opted into. It's up to the caller to handle all confirmation logic.	90b81552313febe82ba07a92a18cddbc62c2ec1c

Diff:

Revision 3 (+1158)

Show changes

	src/ink/js/components/index.ts
	src/ink/js/components/utils/dialogUtils.ts
	src/ink/js/components/utils/index.ts
	src/stories/components/showConfirmDialog.stories.ts
	src/stories/components/showErrorDialog.stories.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (9483c69)