Skip to content

Commit e697bf2

Browse files
committed
TINY-11906: Add readonly prop to React tech ref
1 parent 2f68e23 commit e697bf2

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

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)