Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Docs: Improved Editor#ready's documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Jan 9, 2018
1 parent 3bb8f0b commit 7798bc3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/editor/editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,12 @@ mix( Editor, ObservableMixin );
* Fired when {@link #event:pluginsReady plugins}, {@link #event:uiReady UI} and {@link #event:dataReady data} and all additional
* editor components are ready.
*
* Note: This event is most useful for plugin developers. When integrating the editor with your website or
* application you do not have to listen to `editor#ready` because when the promise returned by the static
* {@link #create `Editor.create()`} event is resolved, the editor is already ready. In fact, since the first moment
* when the editor instance is available to you is inside `then()`'s callback, you cannot even add a listener to
* the `editor#ready` event.
*
* @event ready
*/

Expand Down

0 comments on commit 7798bc3

Please sign in to comment.