Skip to content

Commit 08dd16c

Browse files
kemister85lorenzo-pomilitiny-ben-tranTheSpyder
authored
DOC-3228: Cherry pick tinymce/7 latest changes into tinymce/8 >> release/8.0.0 branch. (#3754)
* TINY-11909: Add `readonly` prop to Svelte tech ref (#3738) * TINY-11909: Add `readonly` prop to Svelte tech ref * TINY-11909: typo * TINY-11906: Add readonly prop to React tech ref (#3736) * TINY-11907: Add new readonly prop to Angular integration. (#3741) * TINY-11911: Add disabled and readonly to the web component tech ref (#3739) * TINY-11908: Add new readonly prop to Vue integration. (#3740) * DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions. (#3755) * DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions for clarity. * Update modules/ROOT/partials/misc/admon-jwt-authentication-requirements.adoc * DOC-3227: Update JWT authentication requirements for trial period clarity, add ifeval condition. * DOC-3239: Update ai proxy. (#3782) * DOC-3240: Remove registry URL from Docker pull commands in installation guides for export-to-pdf and import-from-word components. * DOC-3244: Fix typo in JWT token claims description for On-Premises documentation (#3796) * DOC-3244: Fix typo in JWT token claims description for On-Premises documentation. * Update modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc Co-authored-by: Andrew Herron <[email protected]> --------- Co-authored-by: Andrew Herron <[email protected]> * DOC-3245:Update license link for Tiny Cloud users in understanding editor loads documentation. (#3797) --------- Co-authored-by: lorenzo-pomili <[email protected]> Co-authored-by: tiny-ben-tran <[email protected]> Co-authored-by: Andrew Herron <[email protected]>
1 parent e8e192d commit 08dd16c

14 files changed

+147
-25
lines changed

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ asciidoc:
1515
webcomponent_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-webcomponent/dist/tinymce-webcomponent.min.js
1616
jquery_url: https://cdn.jsdelivr.net/npm/@tinymce/tinymce-jquery@2/dist/tinymce-jquery.min.js
1717
openai_proxy_url: https://openai.ai-demo-proxy.tiny.cloud/v1/chat/completions
18-
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3NTEzMjgwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiJmOGFmY2EyNC1mN2FhLTQxMjktYTc2Yy02YThlZDU3YjAyZjYiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.Xu0apHCbxgmRQTeTqrTIDFFhh2CgKeARRXa3mCxSGoCwZqkoQaFRZBCzDo8Xz7DuUa5mW2XHl-HYcYiXJM9ly16d0oY7lJefHBeLlmJEBE1CSttHBkCRWZS8eFLCasL6
18+
openai_proxy_token: eyJhbGciOiJFUzM4NCJ9.eyJhdWQiOlsiaHR0cHM6Ly9vcGVuYWkuYWktZGVtby1wcm94eS50aW55LmNsb3VkLyJdLCJleHAiOjE3ODI4NjQwMDAsImh0dHBzOi8vb3BlbmFpLmFpLWRlbW8tcHJveHkudGlueS5jbG91ZC9yb2xlIjoicHVibGljLWRlbW8iLCJpc3MiOiJodHRwczovL2FpLWRlbW8tcHJveHkudGlueS5jbG91ZC8iLCJqdGkiOiIxZWY3NjJiNi1mZDYyLTQ3ZWQtOGRkNS0yOGRmMzBkZDU4YmMiLCJzdWIiOiJhaS1hc3Npc3RhbnQtZGVtbyJ9.WC8GIY19MgZneDVZoA-Ttt9E7gNkD0Yl-pcM_5c2RT3RdV_zE0i4bPOGBJpg_g6wu_4ki2ery6_JZtk2Q9gXEBHH7fIu7hXDFS8uIV9qe8MyxEqqRncGFVDjSTldVXGS
1919
default_meta_keywords: tinymce, documentation, docs, plugins, customizable skins, configuration, examples, html, php, java, javascript, image editor, inline editor, distraction-free editor, classic editor, wysiwyg
2020
# product docker variables
2121
dockerimageimportfromwordexporttoword: registry.containers.tiny.cloud/docx-converter-tiny

modules/ROOT/pages/exportpdf.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ tinymce.init({
2828
selector: 'textarea',
2929
plugins: 'exportpdf',
3030
toolbar: 'exportpdf',
31-
// Below option is only required when using the cloud-based Export to PDF plugin from Tiny.Cloud.
32-
// Avoid setting it up during the trial period.
31+
// Required for the cloud-based Export to PDF plugin with Tiny Cloud
32+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
3333
exportpdf_token_provider: () => {
3434
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
3535
method: 'POST',

modules/ROOT/pages/exportword.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ tinymce.init({
3535
selector: 'textarea',
3636
plugins: 'exportword',
3737
toolbar: 'exportword',
38-
// Below option is only required when using the cloud-based Export to Word plugin from Tiny.Cloud.
39-
// Avoid setting it up during the trial period.
38+
// Required for the cloud-based Export to Word plugin with Tiny Cloud
39+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
4040
exportword_token_provider: () => {
4141
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
4242
method: 'POST',

modules/ROOT/pages/importword.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
= {pluginname} plugin
32
:plugincode: importword
43
:pluginname: Import from Word
@@ -30,9 +29,9 @@ tinymce.init({
3029
selector: 'textarea',
3130
plugins: 'importword',
3231
toolbar: 'importword',
33-
// Below option is only required when using the cloud-based Import from Word plugin from Tiny.Cloud.
34-
// Avoid setting it up during the trial period.
35-
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
32+
// Required for the cloud-based Import from Word plugin with Tiny Cloud
33+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
34+
importword_token_provider: () => {
3635
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
3736
method: 'POST',
3837
headers: { 'Content-Type': 'application/json' },

modules/ROOT/pages/understanding-editor-loads.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
== Understanding editor loads for {productname}
77

88
[IMPORTANT]
9-
This information is only relevant to Tiny Cloud users. Users who self-host the open source version of {productname} are not subject to editor load restrictions, but must comply with the https://github.com/tinymce/tinymce/blob/master/LICENSE.TXT[open source license].
9+
This information is only relevant to Tiny Cloud users. Users who self-host the open source version of {productname} are not subject to editor load restrictions, but must comply with the link:https://github.com/tinymce/tinymce/blob/release/{productmajorversion}/LICENSE.md[open source license].
1010

1111
An editor load is the event that occurs each time {productname} is initialized in your application. The editor dispatches the 'init' event to indicate a successful load. For example, if 100 users load {productname} 10 times each, the result would be 1,000 editor loads.
1212

modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-installation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Pull the Docker image:
3232

3333
[source, sh, subs="attributes+"]
3434
----
35-
docker pull registry.containers.tiny.cloud/{dockerimageexporttopdf}:[version]
35+
docker pull {dockerimageexporttopdf}:[version]
3636
----
3737

3838
[TIP]

modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If the `SECRET_KEY` is not setup during the installation, then {pluginname} On-P
1717
* it is not issued in the future (e.i. the `iat` timestamp cannot be newer than the current time),
1818
* it has not expired yet.
1919

20-
Tokens for the {pluginname} On-Premises do not require any additional claims such as the environment ID (which is specific for Collaboration Server On-Premises), the token can be created with an empty payload.
20+
Tokens for the {pluginname} On-Premises do not require any additional claims such as the `aud` (which is specific to cloud-based document converters), so the token can be created with an empty payload.
2121

2222
If the specific use case involves sending requests from a backend server, then JWT tokens can be generated locally, as shown in the below request example.
2323

modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-installation-on-premises.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Pull the Docker image:
3232

3333
[source, sh, subs="attributes+"]
3434
----
35-
docker pull registry.containers.tiny.cloud/{dockerimageimportfromwordexporttoword}:[version]
35+
docker pull {dockerimageimportfromwordexporttoword}:[version]
3636
----
3737

3838
[TIP]

modules/ROOT/partials/integrations/angular-tech-ref.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:licensekey[`+licenseKey+`]
99
** xref:cloudchannel[`+cloudChannel+`]
1010
** xref:disabled[`+disabled+`]
11+
** xref:readonly[`+readonly+`]
1112
** xref:id[`+id+`]
1213
** xref:init[`+init+`]
1314
** xref:initialvalue[`+initialValue+`]
@@ -97,6 +98,7 @@ The editor accepts the following properties:
9798
apiKey="no-api-key"
9899
cloudChannel="{productmajorversion}"
99100
[disabled]="false"
101+
[readonly]="false"
100102
id=""
101103
[init]="{ }"
102104
initialValue=""
@@ -193,6 +195,24 @@ The `+disabled+` property can dynamically switch the editor between a "disabled"
193195
<editor [disabled]="true" />
194196
----
195197

198+
[[readonly]]
199+
=== `+readonly+`
200+
201+
The `+readonly+` property can dynamically switch the editor between a "read-only" mode (`+true+`) and the standard editable mode (`+false+`).
202+
203+
*Type:* `+Boolean+`
204+
205+
*Default value:* `+false+`
206+
207+
*Possible values:* `+true+`, `+false+`
208+
209+
==== Example: using `+readonly+`
210+
211+
[source,html]
212+
----
213+
<editor [readonly]="true" />
214+
----
215+
196216
[[id]]
197217
=== `+id+`
198218

modules/ROOT/partials/integrations/react-tech-ref.adoc

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:licenseKey[`+licenseKey+`]
99
** xref:cloudchannel[`+cloudChannel+`]
1010
** xref:disabled[`+disabled+`]
11+
** xref:readonly[`+readonly+`]
1112
** xref:id[`+id+`]
1213
** xref:init[`+init+`]
1314
** xref:initialvalue[`+initialValue+`]
@@ -143,7 +144,8 @@ xref:toolbar[`+toolbar+`]:: Specify the editor toolbar. This will *override* the
143144

144145
These props can be updated after the editor is initialized. Note that there are xref:event-binding[other events] not mentioned here.
145146

146-
xref:disabled[`+disabled+`]:: Should the editor be in read-only mode.
147+
xref:disabled[`+disabled+`]:: Should the editor be disabled.
148+
xref:readonly[`+readonly+`]:: Should the editor be in read-only mode.
147149

148150
xref:initialvalue[`+initialValue+`]:: The starting value of the editor. Changing this value after the editor has loaded will reset the editor (including the editor content).
149151

@@ -240,7 +242,7 @@ For information {productname} development channels, see: xref:editor-plugin-vers
240242
[[disabled]]
241243
=== `+disabled+`
242244

243-
The `+disabled+` prop can dynamically switch the editor between a "disabled" (read-only) mode (`+true+`) and the standard editable mode (`+false+`).
245+
The `+disabled+` prop can dynamically toggle the editor's disabled state.
244246

245247
*Type:* `Boolean`
246248

@@ -257,6 +259,26 @@ The `+disabled+` prop can dynamically switch the editor between a "disabled" (re
257259
/>
258260
----
259261

262+
[[readonly]]
263+
=== `+readonly+`
264+
265+
The `+readonly+` prop can dynamically switch the editor between a read-only mode (`+true+`) and the standard editable mode (`+false+`).
266+
267+
*Type:* `Boolean`
268+
269+
*Default value:* `+false+`
270+
271+
*Possible values:* `+true+`, `+false+`
272+
273+
==== Example: using `+readonly+`
274+
275+
[source,jsx]
276+
----
277+
<Editor
278+
readonly={true}
279+
/>
280+
----
281+
260282
[[id]]
261283
=== `+id+`
262284

0 commit comments

Comments
 (0)