23 | Monkeys love the Modal Dialog from Bootstrap, but they're getting angry because they have to write this stuff: 24 |
25 |<div class="modal fade">27 |
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h4 class="modal-title">Modal title</h4>
</div>
<div class="modal-body">
<p>One fine body…</p>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
<button type="button" class="btn btn-primary">Save changes</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div><!-- /.modal --> 26 |
28 | What they want is more like this: 29 |
30 |35 | Like it? See Available Options or try more Examples below. 36 |
37 | 38 | 39 | 40 |Provide only the message to show, and keep all other things default.
45 |
109 | There are some workarounds for loading remote page into BootstrapDialog as message, one of those workarounds is as below.
110 | Check out the remote.html.
111 |
122 | Another solution of loading remote page into BootstrapDialog.
123 | This one is more flexible and customizable, but it's also a bit more complicated to use.
124 |
178 | Buttons that created by BootstrapDialog have some extra functions available:
179 | $button.toggleEnable(true|false);
180 | $button.enable(); // Equals to $button.toggleEnable(true);
181 | $button.disable(); // Equals to $button.toggleEnable(false);
182 | $button.toggleSpin(true|false);
183 | $button.spin(); // Equals to $button.toggleSpin(true);
184 | $button.stopSpin(); // Equals to $button.toggleSpin(false);
185 |
218 | Try to press the keys that have been associated with buttons below.
219 | The last button is disabled so nothing is going to happen when pressing its hotkey.
220 | Please note that if there are some components that require keyboard operations in your dialog, conflicts may occur, you can try next example.
221 |
Try to avoid doing similar in your code.
256 |A good looking stacked dialogs. Please also note the second and the third dialog are draggable.
276 |BootstrapDialog.show(...) is just a shortcut method, if you need dialog instances, use 'new'.
306 |In fact BootstrapDialog.show(...) will also return the created dialog instance.
331 |This example demonstrates opening and closing a batch of dialogs at one time.
Dialog that created by BootstrapDialog will be in a container BootstrapDialog.dialogs before it's closed and destroyed, iterate BootstrapDialog.dialogs to find all dialogs that havn't been destroyed.
444 | By default, the dialog size is 'size-normal' or BootstrapDialog.SIZE_NORMAL, but you can have a larger dialog by setting option 'size' to 'size-large' or BootstrapDialog.SIZE_LARGE. 445 |
446 |476 | Please note that specifying BootstrapDialog.SIZE_WIDE is equal to using css class 'modal-lg' on Bootstrap Modal. 477 |
478 |BootstrapDialog supports displaying rich content, so you can even use a video clip as your message in the dialog.
514 |540 | If option 'closable' is set to false, the default closing behaviors will be disabled, but you can still close the dialog by using dialog.close(). 541 |
542 |
572 | By default, when option 'closable' is set to true, dialog can be closed by these ways: clicking outside the dialog, pressing ESC key, clicking the close icon on the right of dialog header.
573 | If you want your dialog closes only when the close icon in dialog header was clicked, try setting both of the options 'closeByBackdrop' and 'closeByKeyboard' to false.
574 |
596 | Setting option 'animate' to false to disable animation for the opening dialog.
597 | If you want to disable animation globally, try to do this:
598 | BootstrapDialog.configDefaultOptions({
599 | animate: false
600 | });
601 |
619 | Lazy guys must love this. 620 |
621 |
651 | When option 'draggable' is set to true, your dialog can be moved by dragging on its header.
652 | If you would like to change the cursor shape of hovering on dialog header, you can try the following css lines:
653 |
This is useful for applying effects to specific dialogs.
696 | For example if you would like to give your 'login-dialog' a smaller size, you can do this way:
This adds an 'aria-describedby' attribute to your dialog, which provides a description of the dialog for screen readers.
725 |763 | Please note that if you're going to use setters to configure event handlers, use dialog.onShow(function) and dialog.onHide(function). 764 |
765 |
788 | Option 'onhide' gives you an opportunity to stop closing the dialog according to some conditions, making your 'onhide' callback returns false to stop closing the dialog.
789 | In the following example, the dialog closes only when your most favorite fruit is 'banana' (Case insensitive).
790 |
All options shown below are optional.
833 |To provide local messages for you needed, reset those messages below before using BootstrapDialog.
898 |
917 | Please note that all options described below are optional, but you will have a weird dialog if you don't even give it a message to display.
918 |
919 | Most options can be set via init options or property setters.
920 |
| 925 | Option 926 | | 927 |928 | Possible values 929 | | 930 |931 | Description 932 | | 933 |
|---|---|---|
| type | 938 |
939 | BootstrapDialog.TYPE_DEFAULT or 'type-default' 940 | BootstrapDialog.TYPE_INFO or 'type-info' 941 | BootstrapDialog.TYPE_PRIMARY or 'type-primary' (default) 942 | BootstrapDialog.TYPE_SUCCESS or 'type-success' 943 | BootstrapDialog.TYPE_WARNING or 'type-warning' 944 | BootstrapDialog.TYPE_DANGER or 'type-danger' 945 | |
946 | 947 | Give your dialog a specific look, color scheme can be seen on Bootstrap's Button. 948 | | 949 |
| size | 952 |
953 | BootstrapDialog.SIZE_NORMAL or 'size-normal' (default) 954 | BootstrapDialog.SIZE_WIDE or 'size-wide' 955 | BootstrapDialog.SIZE_LARGE or 'size-large' 956 | |
957 | 958 | - 959 | | 960 |
| cssClass | 963 |964 | - 965 | | 966 |967 | Additional css classes that will be added to your dialog. 968 | | 969 |
| title | 972 |973 | String or Object(html) 974 | | 975 |976 | - 977 | | 978 |
| message | 981 |982 | String or Object(html) 983 | | 984 |985 | - 986 | | 987 |
| buttons | 990 |991 | array 992 | | 993 |
994 | Examples:
995 |
996 | BootstrapDialog.show({
997 | title: 'Say-hello dialog',
998 | message: 'Hello world!',
999 | buttons: [{
1000 | id: 'btn-ok',
1001 | icon: 'glyphicon glyphicon-check',
1002 | label: 'OK',
1003 | cssClass: 'btn-primary',
1004 | data: {
1005 | js: 'btn-confirm',
1006 | 'user-id': '3'
1007 | },
1008 | autospin: false,
1009 | action: function(dialogRef){
1010 | dialogRef.close();
1011 | }
1012 | }]
1013 | });
1014 |
1015 | id: optional, if id is set, you can use dialogInstance.getButton(id) to get the button later. 1016 | icon: optional, if set, the specified icon will be added to the button. 1017 | cssClass: optional, additional css class to be added to the button. 1018 | data: optional, object containing data attributes to be added to the button. 1019 | autospin: optional, if it's true, after clicked the button a spinning icon appears. 1020 | action: optional, if provided, the callback will be invoked after the button is clicked, and the dialog instance will be passed to the callback function. 1021 | |
1022 |
| closable | 1025 |1026 | true | false 1027 | | 1028 |
1029 | When set to true, you can close the dialog by: 1030 |
|
1036 |
| spinicon | 1039 |
1040 | Icon class name, for example 'glyphicon glyphicon-check'. 1041 | Default value is 'glyphicon glyphicon-asterisk'. 1042 | |
1043 | 1044 | Specify what icon to be used as the spinning icon when button's 'autospin' is set to true. 1045 | | 1046 |
| data | 1049 |1050 | Key-value object. For example {'id' : '100'} 1051 | | 1052 |1053 | Data to be bound to the dialog. 1054 | | 1055 |
| onshow | 1058 |1059 | function 1060 | | 1061 |
1062 | If provided, it will be invoked when the dialog is popping up. 1063 | |
1064 |
| onshown | 1067 |1068 | function 1069 | | 1070 |
1071 | If provided, it will be invoked when the dialog is popped up. 1072 | |
1073 |
| onhide | 1076 |1077 | function 1078 | | 1079 |
1080 | If provided, it will be invoked when the dialog is popping down. 1081 | |
1082 |
| onhidden | 1085 |1086 | function 1087 | | 1088 |
1089 | If provided, it will be invoked when the dialog is popped down. 1090 | |
1091 |
| autodestroy | 1094 |1095 | true (default) | false 1096 | | 1097 |1098 | When it's true, all modal stuff will be removed from the DOM tree after the dialog is popped down, set it to false if you need your dialog (same instance) pups up and down again and again. 1099 | | 1100 |
| description | 1103 |1104 | String 1105 | | 1106 |1107 | If provided, 'aria-describedby' attribute will be added to the dialog with the description string as its value. This can improve accessibility, as the description can be read by screen readers. 1108 | | 1109 |
| nl2br | 1112 |1113 | true | false 1114 | | 1115 |1116 | Automatically convert line breaking character to <br /> if it's set to true, everything keeps original if it's false. 1117 | | 1118 |
| 1131 | Method 1132 | | 1133 |1134 | Description 1135 | | 1136 |
|---|---|
| open() | 1141 |Open the dialog. Usage: dialogInstance.open() | 1142 |
| close() | 1145 |Close the dialog. Usage: dialogInstance.close() | 1146 |
| getModal() | 1149 |Return the raw modal, equivalent to $('<div class='modal fade'...></div>') | 1150 |
| getModalDialog() | 1153 |Return the raw modal dialog. | 1154 |
| getModalContent() | 1157 |Return the raw modal content. | 1158 |
| getModalHeader() | 1161 |Return the raw modal header. | 1162 |
| getModalBody() | 1165 |Return the raw modal body. | 1166 |
| getModalFooter() | 1169 |Return the raw modal footer. | 1170 |
| getData(key) | 1173 |Get data entry according to the given key, returns null if no data entry found. | 1174 |
| setData(key, value) | 1177 |Bind data entry to dialog instance, value can be any types that javascript supports. | 1178 |
| enableButtons(boolean) | 1181 |Disable all buttons in dialog footer when it's false, enable all when it's true. | 1182 |
| setClosable(boolean) | 1185 |When set to true (default), dialog can be closed by clicking close icon in dialog header, or by clicking outside the dialog, or, ESC key is pressed. | 1186 |
| realize() | 1189 |Calling dialog.open() will automatically get this method called first, but if you want to do something on your dialog before it's shown, you can manually call dialog.realize() before calling dialog.open(). | 1190 |