Skip to content

Add docs for HTMLDialogElement.uxpShowModal #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yikuansun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for HTMLDialogElement.uxpShowModal #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/pages/uxp-api/reference-js/Global Members/HTML Elements/HTMLDialogElement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,31 @@ Show the modal dialog.
error.code will be one of the values from HTMLDialogElement.rejectionReasons.



<a name="htmldialogelement-uxpshowmodal" id="htmldialogelement-uxpshowmodal"></a>

## uxpShowModal([options])
Similar to [`showModal`](#showmodal), but with additional customization options.


| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | `object` | `{}` | Options for the show. |
| [options.title] | `string` | | Title of the modal window. |
| [options.resize] | `string` | `"none"` | Which dimensions of the modal window should be resizable. Can be `horizontal`, `vertical`, `both`, or `none`. |
| [options.size] | `object` | `{}` | Default dimensions of the modal window. |
| [options.size.width] | `number` | | Default width of the modal window. |
| [options.size.height] | `number` | | Default height of the modal window. |

**Returns**: `Promise` - A promise that resolves when the dialog is closed (**NSC**)
after calling the close() method or clicking the "submit" button.
The promise will be resolved with returnValue as a parameter.
The promise can be rejected if the dialog was closed for other reasons
e.g. the user hit escape or closed the window, or if the application
does not allow showing the dialog. The error parameter will give more details.
error.code will be one of the values from HTMLDialogElement.rejectionReasons.


<a name="htmldialogelement-close" id="htmldialogelement-close"></a>

## close([returnValue])
Expand Down Expand Up @@ -959,4 +984,4 @@ Checks if the element has pointer capture for the specified pointer.
| event | `*` |