Skip to content

Commit

Permalink
DOC-2358: bump api-version for TinyMCE 7.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
FarzadHayat committed Apr 10, 2024
1 parent f52cfca commit c57012d
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .api-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.0.0
7.0.1
21 changes: 11 additions & 10 deletions modules/ROOT/pages/apis/tinymce.editor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,12 @@ manipulation functions.|`xref:apis/tinymce.editor.adoc[Editor]`
that could leak memory. This method will be called automatically when the page is unloaded
but you can also call it directly if you know what you are doing.|`xref:apis/tinymce.editor.adoc[Editor]`
|xref:#dispatch[dispatch()]|Dispatches the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`

link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#execCommand[execCommand()]|Executes a registered command on the current instance. A list of available commands can be found in
the tinymce command identifiers documentation.|`xref:apis/tinymce.editor.adoc[Editor]`
|xref:#fire[fire()]|Fires the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.
__Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#focus[focus()]|Focuses/activates the editor. This will set this editor as the activeEditor in the tinymce collection
it will also place DOM focus inside the editor.|`xref:apis/tinymce.editor.adoc[Editor]`
Expand Down Expand Up @@ -121,11 +122,11 @@ so all events etc that method has will get dispatched as well.|`xref:apis/tinymc
|xref:#nodeChanged[nodeChanged()]|Dispatches out a onNodeChange event to all observers. This method should be called when you
need to update the UI states or element path etc.|`xref:apis/tinymce.editor.adoc[Editor]`
|xref:#off[off()]|Unbinds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#on[on()]|Binds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#once[once()]|Bind the event callback and once it fires the callback is removed. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#queryCommandState[queryCommandState()]|Returns a command specific state, for example if bold is enabled or not.|`xref:apis/tinymce.editor.adoc[Editor]`
|xref:#queryCommandSupported[queryCommandSupported()]|Returns true/false if the command is supported or not.|`xref:apis/tinymce.editor.adoc[Editor]`
|xref:#queryCommandValue[queryCommandValue()]|Returns a command specific value, for example the current font size.|`xref:apis/tinymce.editor.adoc[Editor]`
Expand Down Expand Up @@ -336,7 +337,7 @@ but you can also call it directly if you know what you are doing.
dispatch(name: String, args: Object?, bubble: Boolean?): Object
----
Dispatches the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand Down Expand Up @@ -385,7 +386,7 @@ the tinymce command identifiers documentation.
fire(name: String, args: Object?, bubble: Boolean?): Object
----
Fires the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.
__Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__

==== Examples
Expand Down Expand Up @@ -751,7 +752,7 @@ need to update the UI states or element path etc.
off(name: String?, callback: Function?): Object
----
Unbinds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand Down Expand Up @@ -784,7 +785,7 @@ instance.off();
on(name: String, callback: Function, prepend: Boolean): Object
----
Binds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand Down Expand Up @@ -813,7 +814,7 @@ instance.on('event', (e) => {
once(name: String, callback: Function): Object
----
Bind the event callback and once it fires the callback is removed. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Parameters

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/apis/tinymce.editor.ui.registry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ UI Components - Context Menu].|`xref:apis/tinymce.editor.ui.registry.adoc[Regist
|xref:#addContextToolbar[addContextToolbar()]|Registers a new context toolbar that only appears when a content predicate is matched for example
the cursor is on an image element.
For information on creating context toolbars, see:
link:https://www.tiny.cloud/docs/tinymce/6/contexttoolbar/[
link:https://www.tiny.cloud/docs/tinymce/7/contexttoolbar/[
UI Components - Context Toolbar].|`xref:apis/tinymce.editor.ui.registry.adoc[Registry]`
|xref:#addGroupToolbarButton[addGroupToolbarButton()]|Registers a new group toolbar button for the toolbar. Renders a toolbar button that opens a floating toolbar when
clicked.
Expand Down Expand Up @@ -201,7 +201,7 @@ addContextToolbar(name: String, obj: Toolbar.ContextToolbarSpec)
Registers a new context toolbar that only appears when a content predicate is matched for example
the cursor is on an image element.
For information on creating context toolbars, see:
link:https://www.tiny.cloud/docs/tinymce/6/contexttoolbar/[
link:https://www.tiny.cloud/docs/tinymce/7/contexttoolbar/[
UI Components - Context Toolbar].

==== Parameters
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/apis/tinymce.notificationmanager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,6 @@ Opens a new notification.

* `args (Object)` - A `name: value` collection containing settings such as: `timeout`, `type`, and message (`text`).

For information on the available settings, see: link:https://www.tiny.cloud/docs/tinymce/6/creating-custom-notifications/[Create custom notifications].
For information on the available settings, see: link:https://www.tiny.cloud/docs/tinymce/7/creating-custom-notifications/[Create custom notifications].

'''
4 changes: 2 additions & 2 deletions modules/ROOT/pages/apis/tinymce.root.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Checks if the input object `obj` has the property `prop`.|`xref:apis/tinymce.roo
|xref:#inArray[inArray()]|Returns an index of the item or -1 if item is not present in the array.|`xref:apis/tinymce.root.adoc[tinymce]`
|xref:#init[init()]|Initializes a set of editors. This method will create editors based on various settings.

For information on basic usage of `init`, see: link:https://www.tiny.cloud/docs/tinymce/6/basic-setup/[Basic setup].|`xref:apis/tinymce.root.adoc[tinymce]`
For information on basic usage of `init`, see: link:https://www.tiny.cloud/docs/tinymce/7/basic-setup/[Basic setup].|`xref:apis/tinymce.root.adoc[tinymce]`
|xref:#is[is()]|Checks if a object is of a specific type for example an array.|`xref:apis/tinymce.root.adoc[tinymce]`
|xref:#isArray[isArray()]|Returns true/false if the object is an array or not.|`xref:apis/tinymce.root.adoc[tinymce]`
|xref:#makeMap[makeMap()]|Makes a name/object map out of an array with names.|`xref:apis/tinymce.root.adoc[tinymce]`
Expand Down Expand Up @@ -315,7 +315,7 @@ init(options: Object): Promise
----
Initializes a set of editors. This method will create editors based on various settings.

For information on basic usage of `init`, see: link:https://www.tiny.cloud/docs/tinymce/6/basic-setup/[Basic setup].
For information on basic usage of `init`, see: link:https://www.tiny.cloud/docs/tinymce/7/basic-setup/[Basic setup].

==== Examples
[source, javascript]
Expand Down
20 changes: 10 additions & 10 deletions modules/ROOT/pages/apis/tinymce.util.observable.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ This mixin adds event binding logic to classes. Adapts the EventDispatcher class
|===
|Name|Summary|Defined by
|xref:#dispatch[dispatch()]|Dispatches the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#fire[fire()]|Fires the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.
__Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#hasEventListeners[hasEventListeners()]|Returns true/false if the object has a event of the specified name.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#off[off()]|Unbinds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#on[on()]|Binds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|xref:#once[once()]|Bind the event callback and once it fires the callback is removed. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.|`xref:apis/tinymce.util.observable.adoc[Observable]`
|===

[[methods]]
Expand All @@ -38,7 +38,7 @@ link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more det
dispatch(name: String, args: Object?, bubble: Boolean?): Object
----
Dispatches the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand All @@ -65,7 +65,7 @@ instance.dispatch('event', {...});
fire(name: String, args: Object?, bubble: Boolean?): Object
----
Fires the specified event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.
__Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.__

==== Examples
Expand Down Expand Up @@ -111,7 +111,7 @@ Returns true/false if the object has a event of the specified name.
off(name: String?, callback: Function?): Object
----
Unbinds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand Down Expand Up @@ -144,7 +144,7 @@ instance.off();
on(name: String, callback: Function, prepend: Boolean): Object
----
Binds an event listener to a specific event by name. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Examples
[source, javascript]
Expand Down Expand Up @@ -173,7 +173,7 @@ instance.on('event', (e) => {
once(name: String, callback: Function): Object
----
Bind the event callback and once it fires the callback is removed. Consult the
link:https://www.tiny.cloud/docs/tinymce/6/events/[event reference] for more details on each event.
link:https://www.tiny.cloud/docs/tinymce/7/events/[event reference] for more details on each event.

==== Parameters

Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/apis/tinymce.windowmanager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ Opens a new window.

==== Parameters

* `config (Object)` - For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/6/dialog-configuration/#options[Dialog - Configuration options].
* `params (Object)` - (Optional) For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/6/dialog-configuration/#configuration-parameters[Dialog - Configuration parameters].
* `config (Object)` - For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/7/dialog-configuration/#options[Dialog - Configuration options].
* `params (Object)` - (Optional) For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/7/dialog-configuration/#configuration-parameters[Dialog - Configuration parameters].

==== Return value

Expand All @@ -138,7 +138,7 @@ Opens a new window for the specified url.

==== Parameters

* `config (Object)` - For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/6/urldialog/#configuration[URL dialog - Configuration].
* `config (Object)` - For information on the available options, see: link:https://www.tiny.cloud/docs/tinymce/7/urldialog/#configuration[URL dialog - Configuration].

==== Return value

Expand Down

0 comments on commit c57012d

Please sign in to comment.