Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2578: TinyMCE 7.6.0 Release Documentation and Community Changelog. #3513

Merged
merged 46 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 42 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
a941021
DOC-2578: TinyMCE 7.6.0 Release Documentation and Community Changelog.
kemister85 Nov 18, 2024
2937c69
DOC-2578: Pressing `Shift + Enter` in the comment textarea now select…
abhinavgandham Dec 2, 2024
dd6800a
DOC-2578: Changing the table row type when a `contentEditable="false"…
abhinavgandham Dec 2, 2024
ea8cec7
DOC-2578: Tooltip would not show for group toolbar button. (#3520)
abhinavgandham Dec 3, 2024
3635249
DOC-2578: Enhanced the accessibility checker color palette for better…
abhinavgandham Dec 4, 2024
ed53b54
DOC-2578: Scroll to show action buttons when replying/editing a comme…
abhinavgandham Dec 5, 2024
2bc796e
DOC-2586: New disabled option for disabling all user interactions (#3…
kemister85 Dec 5, 2024
f74fa23
DOC-2578: The mentions menu now expands freely to the available space…
abhinavgandham Dec 6, 2024
728e153
DOC-2578: After creating a conversation, the focus goes to the newly …
abhinavgandham Dec 6, 2024
b746993
DOC-2578: Removed title attribute from dialog tree elements as they a…
abhinavgandham Dec 6, 2024
e62a112
DOC-2578: Fixed CSS Bundling for Skin UI Content CSS. (#3537)
kemister85 Dec 9, 2024
e1d0a88
DOC-2578: Checklist items were unresponsive in center or right alignm…
kemister85 Dec 9, 2024
eafa19a
DOC-2578: Adjust `tinycomments` UI font size to match the editor UI f…
kemister85 Dec 9, 2024
c5f214b
DOC-2578: Enhanced accessibility checker UI to display affected conte…
abhinavgandham Dec 9, 2024
d69fdd5
DOC-2578: The `commentAuthor` property is now included in reply event…
kemister85 Dec 9, 2024
4167312
DOC-2578: Introduced a new live region for screen readers to improve …
kemister85 Dec 9, 2024
c09b605
DOC-2578: Reduced the amount of scrolling when changing between conve…
abhinavgandham Dec 9, 2024
5a98843
DOC-2578: Update changelog.adoc for TinyMCE 7.6.0.
kemister85 Dec 9, 2024
50e87a4
DOC-2578: Add Labels and Groups for Context Toolbar Buttons. (#3548)
kemister85 Dec 10, 2024
1e2665b
DOC-2578: Added placeholder support for context form input fields. (#…
kemister85 Dec 10, 2024
003fecb
DOC-2578: Fixed Caret Position when closing Comment Mentions dropdown…
FarzadHayat Dec 10, 2024
5b06d39
DOC-2578: Added tooltips to conversation and comment kebab menus. (#3…
abhinavgandham Dec 10, 2024
17285e3
DOC-2578: Spelling error in tooltip for toggle button (#3547)
abhinavgandham Dec 10, 2024
e96eb4f
DOC-2578: New `onSetup` function for context forms. (#3550)
kemister85 Dec 10, 2024
9dd1fb6
DOC-2578: General cleanup and structure formatting pre-release.
kemister85 Dec 10, 2024
f87b6f6
DOC-2578: New `back` function in `ContextFormApi` to go back to the p…
kemister85 Dec 10, 2024
4582189
New QuickbarInsertImage command that is executed by the quickimage bu…
kemister85 Dec 10, 2024
7a1b1b6
Image selection was removed when calling nodeChanged while having foc…
kemister85 Dec 10, 2024
6c7ba21
DOC-2578: Add known issue for missing translations.
kemister85 Dec 10, 2024
9056aa7
DOC-2578: Incorrect translation of `Cut Column` and `Copy Column` i…
abhinavgandham Dec 10, 2024
fa4ef66
DOC-2578: Add new entry for Image Optimizer new plugin announcment.
kemister85 Dec 11, 2024
0c929fc
DOC-2578: Add entry for new premium plugin Image Optimizer in release…
kemister85 Dec 11, 2024
71e5b9c
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
094c6be
Update modules/ROOT/pages/changelog.adoc
kemister85 Dec 11, 2024
1761cd2
DOC-2578: Comment out improvements for various last min discovered ti…
kemister85 Dec 11, 2024
edd36d7
DOC-2578: Comment out changelog title placeholders for post release f…
kemister85 Dec 11, 2024
bc8816a
Update modules/ROOT/pages/contexttoolbar.adoc
kemister85 Dec 11, 2024
adda543
Update modules/ROOT/pages/contextform.adoc
kemister85 Dec 11, 2024
b5032b1
Update modules/ROOT/pages/changelog.adoc
kemister85 Dec 11, 2024
f66d060
Update modules/ROOT/pages/changelog.adoc
kemister85 Dec 11, 2024
cc0c893
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
41c4ace
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
4350da9
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
4120f06
Update modules/ROOT/partials/configuration/tinycomments_reply.adoc
kemister85 Dec 11, 2024
6cc8dee
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
a6d02b9
Update modules/ROOT/pages/7.6.0-release-notes.adoc
kemister85 Dec 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ asciidoc:
# product variables
productname: TinyMCE
productmajorversion: 7
productminorversion: '7.5'
productminorversion: '7.6'
##### product name in codeblock
prodnamecode: tinymce
#### more names
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ const tinycomments_reply = (req, done, fail) => {
})
.then((req2) => {
const commentUid = req2.commentUid;
done({ commentUid });
done({
commentUid: replyUid,
author: currentUser.id,
authorName: currentUser.fullName
});
})
.catch((e) => {
fail(e);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<textarea id="context-toolbar-labels">
<p>Clicking on the example image below will show the newly configured context toolbar.</p>

{{logofordemoshtml}}

<p>Select a word in this sentence, to see the other newly configured context toolbar.</p>

<p>Clicking on text should not invoke the context toolbar</p>
</textarea>
34 changes: 34 additions & 0 deletions modules/ROOT/examples/live-demos/context-toolbar-labels/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
tinymce.init({
selector: 'textarea#context-toolbar-labels',
height: 350,
setup: (editor) => {
editor.ui.registry.addContextToolbar('imagealignment', {
predicate: (node) => node.nodeName.toLowerCase() === 'img',
position: 'node',
scope: 'node',
items: [
{
name: 'Formatting',
items: ['alignleft', 'aligncenter', 'alignright']
},
{
label: 'Copy',
items: ['copy', 'paste']
}
],
});

editor.ui.registry.addContextToolbar('textselection', {
predicate: (node) => !editor.selection.isCollapsed(),
position: 'selection',
scope: 'node',
items: [
{
name: 'Format',
items: ['bold', 'italic', 'underline']
},
],
});
},
content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }'
});
10 changes: 2 additions & 8 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -411,18 +411,12 @@
** xref:release-notes.adoc[Release notes for {productname}]
*** {productname} 7.6.0
**** xref:7.6.0-release-notes.adoc#overview[Overview]
**** xref:7.6.0-release-notes.adoc#new-premium-plugin<s>[New Premium plugin<s>]
**** xref:7.6.0-release-notes.adoc#new-open-source-plugin<s>[New Open Source plugin<s>]
**** xref:7.6.0-release-notes.adoc#new-premium-plugin[New Premium plugin]
**** xref:7.6.0-release-notes.adoc#accompanying-premium-plugin-changes[Accompanying Premium plugin changes]
**** xref:7.6.0-release-notes.adoc#accompanying-premium-plugin-end-of-life-announcement[Accompanying Premium plugin end-of-life announcement]
**** xref:7.6.0-release-notes.adoc#accompanying-open-source-plugin-end-of-life-announcement[Accompanying open source plugin end-of-life-announcement]
**** xref:7.6.0-release-notes.adoc#accompanying-enhanced-skins-and-icon-packs-changes[Accompanying Enhanced Skins & Icon Packs changes]
**** xref:7.6.0-release-notes.adoc#improvements[Improvements]
// **** xref:7.6.0-release-notes.adoc#improvements[Improvements]
kemister85 marked this conversation as resolved.
Show resolved Hide resolved
**** xref:7.6.0-release-notes.adoc#additions[Additions]
**** xref:7.6.0-release-notes.adoc#changes[Changes]
**** xref:7.6.0-release-notes.adoc#bug-fixes[Bug fixes]
**** xref:7.6.0-release-notes.adoc#security-fixes[Security fixes]
**** xref:7.6.0-release-notes.adoc#deprecated[Deprecated]
**** xref:7.6.0-release-notes.adoc#known-issues[Known issues]
*** {productname} 7.5.1
**** xref:7.5.1-release-notes.adoc#overview[Overview]
Expand Down
398 changes: 314 additions & 84 deletions modules/ROOT/pages/7.6.0-release-notes.adoc

Large diffs are not rendered by default.

40 changes: 38 additions & 2 deletions modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,45 @@

NOTE: This is the {productname} Community version changelog. For information about the latest {cloudname} or {enterpriseversion} Release, see: xref:release-notes.adoc[{productname} Release Notes].

== xref:7.6.0-release-notes.adoc[7.6.0 - 2024-12-04]
== xref:7.6.0-release-notes.adoc[7.6.0 - 2024-12-11]

//TODO
=== Added
* It is now possible to create labeled groups in context toolbars.
// #TINY-11095
// * New `contextsliderform` and `contextsizeinput` context form types.
// #TINY-11342
* New `back` function in `ContextFormApi` to go back to the previous toolbar.
// #TINY-11344
* New `QuickbarInsertImage` command that is executed by the `quickimage` button.
// #TINY-11399
* New `onSetup` function to the context form API.
// #TINY-11494
* New `placeholder` to the context form input field API.
// #TINY-11459
* New `disabled` option to restore the previous `readonly` mode behavior, allowing the editor to be displayed in a disabled state.
// #TINY-11488

// === Improved
// * Base64 data was not properly decoded due to unhandled URL-encoded characters.
// #TINY-9548
// * The `latin` list style type is now recognized as an alias for the `alpha` list style type.
// #TINY-11515

=== Fixed
* Image selection was removed when calling `+editor.nodeChanged()+` while having focus inside the editor UI.
// #TINY-11437
* Tooltip would not show for group toolbar button.
// #TINY-11391
* Changing the table row type when a `+contenteditable=false+` cell was selected would not work as expected.
// #TINY-11383
// * The `samp` format was being applied as a `block` level format, instead of an `inline` format.
// #TINY-11390
* Removed title attribute from dialog tree elements as they already have a tooltip.
// #TINY-11470
* Fixed CSS bundling for skin UI content CSS.
// #TINY-11558
* Fixed incorrect resource keys for CSS bundling JS files.
// #TINY-11558

== xref:7.5-release-notes.adoc[7.5.0 - 2024-11-06]

Expand Down
8 changes: 7 additions & 1 deletion modules/ROOT/pages/contextform.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ This relates to the form itself. The form specifications are:
|`+position+` |This controls where the context toolbar will appear with regards to the current cursor.
|`+scope+` |This controls whether the predicate (condition) is a `+node+`-based predicate, or an `+editor+`-based predicate. See context toolbar priority for more details.
|`+commands+` |This is a list of the items to show in the context form. They can be either `+contextformbutton+` or `+contextformtogglebutton+`.
|`+onSetup+`
a|
`+(ContextFormApi) => (ContextFormApi) => void+`

Optional default: `+() => () => {}+` - Function that's executed when the form is rendered. Once rendered, it returns a function that is executed when the context form is closed.
|===

include::partial$context/positioning.adoc[leveloffset=+1]
Expand Down Expand Up @@ -100,12 +105,13 @@ Where the `+toggleButtonApi+` is the same as a regular toolbar toggle button.

=== formApi

Both `+contextformbutton+` and `+contextformtogglebutton+` are passed `+formApi+` in their `+onAction+` callback. The `+formApi+` has two functions:
Both `+contextformbutton+` and `+contextformtogglebutton+` are passed `+formApi+` in their `+onAction+` callback. The `+formApi+` has three functions:

[cols="1,3",options="header"]
|===
|Functions |Description
|`+hide+` |This will hide the form. By default, no button hides the form. It is the responsibility of the developer to hide the form in the `+onAction+` handler of buttons that require that the context form close after the action.
|`+back+` |This will restore the previous toolbar. This is useful when you want to go back to the previous toolbar when you press back in the toolbar.
|`+getValue+` |This will retrieve the value current typed in the input field.
|===

Expand Down
35 changes: 35 additions & 0 deletions modules/ROOT/pages/contexttoolbar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,41 @@ This example shows how the quickbars plugin adds the standard selection context

liveDemo::context-toolbar[height="600", tab="js"]

[[add-labels-and-groups-for-context-toolbar-buttons]]
== Add labels and groups for context toolbar buttons

From {productname} 7.6.0 onward, registering a context toolbar allows specifying `items` as an object that supports grouping with optional names and labels. This improvement enhances toolbar usability by organizing buttons into titled or labeled groups.

The object structure takes two optional properties: `name` and `label`.

* `name`: property is used as the group's title for the group that contains the buttons.
* `label`: property is used as a label for each group of buttons.

[NOTE]
If neither `name` nor `label` are specified, the behavior defaults to ungrouped buttons.

The object structure for `items` is as follows:

.Example of a context toolbar configuration with groups and labels
[source,js]
----
items: [
{
name: 'Formatting', // Optional, used as the group's title
items: [ 'bold', 'italic' ] // Array of registered button names
},
{
label: 'History', // Optional, used as a label for the group
items: [ 'undo', 'redo' ] // Array of registered button names
},
{
items: [ 'undo', 'italic' ] // No name or label specified, default behavior applies
}
]
----

liveDemo::context-toolbar-labels[height="600", tab="js"]

== Launching a context toolbar programmatically

There is an `+editor+` event called `+contexttoolbar-show+` that can be fired to show a context toolbar at the current selection. The event takes a parameter `+toolbarKey+` which specifies the name of the registered context form or context toolbar to show.
Expand Down
4 changes: 4 additions & 0 deletions modules/ROOT/pages/editor-important-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ include::partial$configuration/external_plugins.adoc[leveloffset=+1]

include::partial$configuration/readonly.adoc[leveloffset=+1]

== Setting the editor in a disabled state

include::partial$configuration/disabled.adoc[leveloffset=+1]

== Executing custom functions while the editor starts (initializes)

include::partial$configuration/setup.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/events.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ The following events are provided by the {productname} editor.
|ObjectResized |`+{ target: HTMLElement, width: number, height: number, origin: string }+` |Fired when an object (such as an image) has finished being resized.
|ObjectResizeStart |`+{ target: HTMLElement, width: number, height: number, origin: string }+` |Fired when an object (such as an image) is about to be resized.
|SwitchMode |`+{ mode: string }+` |Fired when the editor mode is changed. The available modes are "design" and "readonly". Additional modes can be registered using {productname} API xref:apis/tinymce.editormode.adoc#register['tinymce.activeEditor.mode.register()'].
|DisabledStateChange |+{ state: boolean }+ |Fired when the editor disabled mode state changes.
|ScrollWindow |(Same data as the native https://developer.mozilla.org/en-US/docs/Web/API/Element/scroll_event[scroll event]) |Fired when the window has scrolled.
|ResizeWindow |(Same data as the native https://developer.mozilla.org/en-US/docs/Web/API/Window/resize_event[resize event]) |Fired when the window is resized.
|BeforeExecCommand |`+{ command: string, ui?: boolean, value?: any }+` |Fired before a command is executed.
Expand Down
23 changes: 23 additions & 0 deletions modules/ROOT/partials/configuration/disabled.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[[disabled]]

== `+disabled+`

Disables all user interactions with the editor (including cursor placement, content modifications, UI components). This option provides behavior similar to the changes made to {productname} in 7.4.0 readonly mode. When enabled, the editor becomes completely non-interactive.
kemister85 marked this conversation as resolved.
Show resolved Hide resolved
kemister85 marked this conversation as resolved.
Show resolved Hide resolved

To programmatically enable/disable the editor, use `+tinymce.activeEditor.options.set('disabled', false/true)+`.

*Type:* `+Boolean+`

*Default value:* `+false+`

*Possible values:* `+true+`, `+false+`

=== Example: using `+disabled+`

[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
disabled: true
});
----
10 changes: 8 additions & 2 deletions modules/ROOT/partials/configuration/tinycomments_reply.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ The `+done+` callback should accept the following object:
[source,js]
----
{
commentUid: string // the value of the new comment uid
commentUid: string, // the value of the new comment uid
kemister85 marked this conversation as resolved.
Show resolved Hide resolved
author: string, // the id of the current author
authorName: string // the name of the current author
}
----

Expand All @@ -42,7 +44,11 @@ const reply_comment = (ref, done, fail) => {
})
.then((ref2) => {
let commentUid = ref2.commentUid;
done({ commentUid: commentUid });
done({
commentUid: replyUid,
author: currentUser.id,
authorName: currentUser.fullName
});
})
.catch((e) => {
fail(e);
Expand Down
4 changes: 4 additions & 0 deletions modules/ROOT/partials/plugin-apis/comments-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ The `getEventLog` returns a log that contains information and timestamps of all
"conversationContent": "new comment (Edit comment)",
"conversationCreatedAt": "2024-10-01T03:07:53.771Z",
"commentContent": "reply to existing comment",
"commentAuthor": {
"author": "DEMO USER",
"authorName": "DEMO USER"
},
"conversationAuthor": {
"author": "DEMO USER",
"authorName": "DEMO USER"
Expand Down
Loading