@portabletext/editor 1.16.0 → 1.16.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "1.16.0",
+  "version": "1.16.1",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",

package/src/editor/PortableTextEditor.tsx

@@ -173,7 +173,8 @@ export class PortableTextEditor extends Component<
     if (!this.props.editor && !prevProps.editor) {
       if (this.props.readOnly !== prevProps.readOnly) {
         this.editor._internal.editorActor.send({
-          type: 'toggle readOnly',
+          type: 'update readOnly',
+          readOnly: this.props.readOnly ?? false,
         })
       }
 

package/src/editor/components/Synchronizer.tsx

@@ -71,7 +71,7 @@ export function Synchronizer(props: SynchronizerProps) {
   }, [props.editorActor, syncActorRef])
 
   useEffect(() => {
-    syncActorRef.send({type: 'toggle readOnly'})
+    syncActorRef.send({type: 'update readOnly', readOnly})
   }, [syncActorRef, readOnly])
 
   useEffect(() => {

package/src/editor/create-editor.ts

@@ -33,6 +33,9 @@ import {createEditableAPI} from './plugins/createWithEditableAPI'
 export type EditorConfig = {
   behaviors?: Array<Behavior>
   keyGenerator?: () => string
+  /**
+   * @deprecated Will be removed in the next major version
+   */
   maxBlocks?: number
   readOnly?: boolean
   initialValue?: Array<PortableTextBlock>
@@ -64,8 +67,8 @@ export type EditorEvent = PickFromUnion<
   | 'list item.toggle'
   | 'style.toggle'
   | 'patches'
-  | 'toggle readOnly'
   | 'update behaviors'
+  | 'update readOnly'
   | 'update value'
 >
 

package/src/editor/editor-machine.ts

@@ -81,6 +81,10 @@ export type InternalEditorEvent =
       editor: PortableTextSlateEditor
       actionIntends: Array<BehaviorActionIntend>
     }
+  | {
+      type: 'update readOnly'
+      readOnly: boolean
+    }
   | {
       type: 'update schema'
       schema: EditorSchema
@@ -93,9 +97,6 @@ export type InternalEditorEvent =
       type: 'update value'
       value: Array<PortableTextBlock> | undefined
     }
-  | {
-      type: 'toggle readOnly'
-    }
   | {
       type: 'update maxBlocks'
       maxBlocks: number | undefined
@@ -439,7 +440,8 @@ export const editorMachine = setup({
             },
             'read only': {
               on: {
-                'toggle readOnly': {
+                'update readOnly': {
+                  guard: ({event}) => !event.readOnly,
                   target: '#editor.edit mode.editable',
                   actions: ['emit editable'],
                 },
@@ -449,7 +451,8 @@ export const editorMachine = setup({
         },
         'editable': {
           on: {
-            'toggle readOnly': {
+            'update readOnly': {
+              guard: ({event}) => event.readOnly,
               target: '#editor.edit mode.read only.read only',
               actions: ['emit read only'],
             },

package/src/editor/sync-machine.ts

@@ -111,7 +111,8 @@ export const syncMachine = setup({
           value: Array<PortableTextBlock> | undefined
         }
       | {
-          type: 'toggle readOnly'
+          type: 'update readOnly'
+          readOnly: boolean
         }
       | SyncValueEvent,
     emitted: {} as PickFromUnion<
@@ -122,7 +123,10 @@ export const syncMachine = setup({
   },
   actions: {
     'assign readOnly': assign({
-      readOnly: ({context}) => !context.readOnly,
+      readOnly: ({event}) => {
+        assertEvent(event, 'update readOnly')
+        return event.readOnly
+      },
     }),
     'assign pending value': assign({
       pendingValue: ({event}) => {
@@ -190,7 +194,7 @@ export const syncMachine = setup({
         isProcessingLocalChanges: false,
       }),
     },
-    'toggle readOnly': {
+    'update readOnly': {
       actions: ['assign readOnly'],
     },
   },