Home > @uniformdev/mesh-sdk > DialogOptions
DialogOptions interface
Signature:
Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
</td><td>
</td><td>
</td><td>
(Optional) Allows you to specify the height of the dialog content upon open. Note: the dialog itself will always be full height to match the Uniform dashboard UI. However, the content container within the dialog is, by default, auto-sized to the calculated height of the rendered content of the dialog. Setting the contentHeight option disables auto-sizing and allows you to specify your own height for the dialog content. contentHeight option can be specific lengths, e.g. 100vh, 500px, etc... as well as other standard CSS height options.
</td></tr> <tr><td>
</td><td>
</td><td>
boolean
</td><td>
(Optional) By default, dialogs will be closed when they set a value. You can disable this behavior by setting the disableCloseDialogOnSetValue property to true. You'll still be able to close a dialog via the closeDialog method that is returned from the openLocationDialog method.
</td></tr> <tr><td>
</td><td>
</td><td>
'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | 'full' | ArbitraryMaxWidth
</td><td>
(Optional) Options for setting the max width of the dialog.
Custom string can be used for specific custom width .e.g "clamp(300px, 50%, 600px)"
</td></tr> <tr><td>
</td><td>
</td><td>
TDialogParams
</td><td>
(Optional) Parameters to pass to the dialog, which will be available in the dialog via the metadata object for the dialog location, e.g. metadata.dialogParams. Parameters should be simple (serializable) types, not functions or DOM elements or similar non-serializable objects.
Best practice is to keep size of the params as small as possible.
</td></tr> <tr><td>
</td><td>
</td><td>
DialogSizes
</td><td>
(Optional) Options for setting the width of the dialog.
</td></tr> </tbody></table>