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