Skip to content

Commit a21dc42

Browse files
committed
[doc] added doc for showErrorMessage
1 parent 8bc7b61 commit a21dc42

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/apis/showErrorMessage.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
/**
2+
* Displays the custom error message
3+
* @method WebViewer#showErrorMessage
4+
* @param {string} message An error message
5+
* @example // 5.1 and after
6+
WebViewer(...)
7+
.then(function(instance) {
8+
instance.showErrorMessage('My error message');
9+
});
10+
* @example // 4.0 ~ 5.0
11+
var viewerElement = document.getElementById('viewer');
12+
var viewer = new PDFTron.WebViewer(...);
13+
14+
viewerElement.addEventListener('ready', function() {
15+
var instance = viewer.getInstance();
16+
instance.showErrorMessage('My error message');
17+
});
18+
*/
19+
120
import actions from 'actions';
221

322
export default store => message => {

0 commit comments

Comments
 (0)