## MessageBox A set of modal boxes simulating system message box, mainly for message prompt, success tips, error messages and query information. ### Alert Alert interrupts user operation until the user confirms. :::demo Open an alert by calling the `$alert` method. It simulates the system's `alert`, and cannot be closed by pressing ESC or clicking outside the box. In this example, two parameters `message` and `title` are received. It is worth mentioning that when the box is closed, it returns a `Promise` object for further processing. If you are not sure if your target browsers support `Promise`, you should import a third party polyfill or use callbacks instead like this example. ```html ``` ::: ### Confirm Confirm is used to ask users' confirmation. :::demo Call `$confirm` method to open a confirm, and it simulates the system's `confirm`. We can also highly customize Message Box by passing a third attribute `options` which is a literal object. The attribute `type` indicates the message type, and it's value can be `success`, `error`, `info` and `warning`. Note that the second attribute `title` must be a `string`, and if it is an `object`, it will be handled as the attribute `options`. Here we use `Promise` to handle further processing. ```html ``` ::: ### Prompt Prompt is used when user input is required. :::demo Call `$prompt` method to open a prompt, and it simulates the system's `prompt`. You can use `inputPattern` parameter to specify your own RegExp pattern. Use `inputValidator` to specify validation method, and it should return `Boolean` or `String`. Returning `false` or `String` means the validation has failed, and the string returned will be used as the `inputErrorMessage`. In addition, you can customize the placeholder of the input box with `inputPlaceholder` parameter. ```html ``` ::: ### Customization Can be customized to show various content. :::demo The three methods mentioned above are repackagings of the `$msgbox` method. This example calls `$msgbox` method directly using the `showCancelButton` attribute, which is used to indicate if a cancel button is displayed. Besides we can use `cancelButtonClass` to add a custom style and `cancelButtonText` to customize the button text. The confirm button also has these fields. A complete list of fields can be found at the end of this documentation. ```html ``` ::: ### Global method Element has added the following global methods for Vue.prototype: `$msgbox`, `$alert`, `$confirm` and `$prompt`. So in a vue instance you can call `MessageBox` like what we did in this page. ### Local import Import `MessageBox`: ```javascript import { MessageBox } from 'element-ui'; ``` The corresponding methods are: `MessageBox`, `MessageBox.alert`, `MessageBox.confirm` and `MessageBox.prompt`. ### Options | Attribute | Description | Type | Accepted Values | Default | |---------- |-------------- |---------- |-------------------------------- |-------- | | title | title of the MessageBox | string | — | — | | message | content of the MessageBox | string | — | — | | type | message type, used for icon display | string | success/info/
warning/error | — | | lockScroll | whether to lock body scroll when MessageBox prompts | boolean | — | true | | showCancelButton | whether to show a cancel button | boolean | — | false (true when called with confirm and prompt) | | showConfirmButton | whether to show a confirm button | boolean | — | true | | cancelButtonText | text content of cancel button | string | — | Cancel | | confirmButtonText | text content of confirm button | string | — | OK | | cancelButtonClass | custom class name of cancel button | string | — | — | | confirmButtonClass | custom class name of confirm button | string | — | — | | closeOnClickModal | whether MessageBox can be closed by clicking the mask | boolean | — | true (false when called with alert) | | closeOnPressEscape | whether MessageBox can be closed by pressing the ESC | boolean | — | false | | showInput | whether to show an input | boolean | — | false (true when called with prompt) | | inputPlaceholder | placeholder of input | string | — | — | | inputPattern | regexp for the input | regexp | — | — | | inputValidator | validation function for the input. Should returns a boolean or string. If a string is returned, it will be assigned to inputErrorMessage | function | — | — | | inputErrorMessage | error message when validation fails | string | — | Illegal input |