Minor mistakes in the documentation of the plugin API

uwohlfeil · 11 May 2023 12:44

Hello ONLYOFFICE Team,

i found a smaller mistake in your plugin API documentation.

In some Event examples, the example missing the event_ prefix:

onBlurContentControl → event_onBlurContentControl
onChangeContentControl → event_onChangeContentControl
onFocusContentControl → event_onFocusContentControl

Code:

ONLYOFFICE/sdkjs/blob/3f4055fae21c9caf614ca8cc5b212f5905a11427/common/plugins/plugin_base.js#LL739C11-L739C18

    
      
          				case "onEvent":

In my case, I have to define this methods without the prefix in my config.json.
https://api.onlyoffice.com/plugin/config#events

The is also a wrong/outdated example:

github.com

ONLYOFFICE/onlyoffice.github.io/blob/4bc962d2e2ef87a42e208500dd5fd8764d4d8a40/sdkjs-plugins/content/zoom/scripts/zoom.js#L63

    
      
          			e.preventDefault();
          		if (e.stopPropagation)
          			e.stopPropagation();
          		return false;
              };
          
          
    function showLoader(elements, bShow) {
                 switchClass(elements.loader, displayNoneClass, !bShow);
              };
              
              window.Asc.plugin.onFocusContentControl = function() {
                  console.log('1111');
              }
          
          
    function switchClass(el, className, add) {
                  if (add) {
                      el.classList.add(className);
                  } else {
                      el.classList.remove(className);
                  }
              };

Best regards
Uli

Constantine · 12 May 2023 10:27

Hello @uwohlfeil

We are aware of this situation and we are already working on it.
Thank you for sharing the details.