modalbox

calls a modalbox

HTMLElement modalbox(ModalBoxConfig config);

config

ModalBoxConfig

the modal box's configuration

HTMLElement

the div container of the modalbox

let box = gantt.modalbox({
    title: "Close",
    type: "alert-warning"
});

Details

The configuration object uses the following properties:

id? - (number | string) - optional, the ID of the modal box
text - (number | string) - the text of the modal box's body
title? - (number | string) - optional, the text of the header
position? - (string) - optional, the position of the modal box for now supports only one value - "top", any other value will result in "center-align"
buttons - (string[] | number[] | ModalboxButton[]) - the array of buttons
width? - (string) - optional, the width of the modal box (set as CSS <length> or <percentage> values, e.g. "100px", "50%")
height? - (string) - optional, the height of the modal box (set as CSS <length> or <percentage> values, e.g. "100px", "50%")
callback? (result): void - optional, the function called on button click. Takes true or false as a parameter (subject to the clicked button)
- result - (string | number | boolean) - The result of the callback function will be equal to the stringified index of a pressed button from the array ("0", "1", "2",...)

The ModalboxButton has the following types:

label - (string | number) - the text of the button
value? - (string | number | boolean) - optional, the value that is returned in the result argument of the callback function.
css? - (string | number) - optional, a custom class name for the button, prefixed with the "gantt_" string.

For additional details about supported configuration options of a modalbox, see the Popup Messages and Modal Boxes article.