KanbanDialog API in Vue Kanban API component

Holds the configuration of edit dialog.

Properties

allowDragging

boolean

Specifies the value whether the dialog component can be dragged by the end-user. The dialog allows to drag by selecting the header and dragging it for re-position the dialog.

Defaults to false

animationSettings

AnimationSettingsModel

Specifies the animation settings of the dialog component. The animation effect can be applied on open and close the dialog with duration and delay.

Defaults to { effect: ‘Fade’, duration: 400, delay:0 }

closeOnEscape

boolean

Specifies the boolean value whether the dialog can be closed with the escape key that is used to control the dialog’s closing behavior.

Defaults to true

cssClass

string

Specifies the CSS class name that can be appended with root element of the dialog. One or more custom CSS classes can be added to a dialog.

Defaults to ”

enableResize

boolean

Specifies the value whether the dialog component can be resized by the end-user. If enableResize is true, the dialog component creates grip to resize it diagonal direction.

Defaults to false

height

string | number

Specifies the height of the dialog component.

Defaults to ‘auto’

isModal

boolean

Specifies the Boolean value whether the dialog can be displayed as modal or non-modal.

• Modal: It creates overlay that disable interaction with the parent application and user should respond with modal before continuing with other applications.
• Modeless: It does not prevent user interaction with parent application.

Defaults to true

minHeight

string | number

Specify the min-height of the dialog component.

Defaults to ”

position

PositionDataModel

Specifies the value where the dialog can be positioned within the document or target. The position can be represented with pre-configured positions or specific X and Y values.

• X value: left, center, right, or offset value.
• Y value: top, center, bottom, or offset value.

Defaults to { X:‘center’, Y:‘center’}

showCloseIcon

boolean

Specifies the value that represents whether the close icon is shown in the dialog component.

Defaults to true

target

HTMLElement | string

Specifies the target element in which to display the dialog. The default value is null, which refers the document.body element.

Defaults to null

width

string | number

Specifies the width of the dialog.

Defaults to 350

zIndex

number

Specifies the z-order for rendering that determines whether the dialog is displayed in front or behind of another component.

Defaults to 1000