This page is available as Markdown at /api/editor/readme.md.
For the full documentation index, see /llms.txt, or
the complete corpus at /llms-full.txt.
@portabletext/editor
Classes
Section titled “Classes”Interfaces
Section titled “Interfaces”- BlockAnnotationRenderProps
- BlockChildRenderProps
- BlockDecoratorRenderProps
- BlockListItemRenderProps
- BlockRenderProps
- BlockStyleRenderProps
- EditableAPIDeleteOptions
- PasteData
- PortableTextObject
- PortableTextSpan
- PortableTextTextBlock
- RangeDecoration
- RangeDecorationOnMovedDetails
Type Aliases
Section titled “Type Aliases”- AddedAnnotationPaths
- AnnotationDefinition
- AnnotationPath
- AnnotationSchemaType
- BaseDefinition
- BlockObject
- BlockObjectDefinition
- BlockObjectRender
- BlockObjectRenderProps
- BlockObjectSchemaType
- BlockOffset
- BlockPath
- ChildPath
- Container
- ContainerRender
- ContainerRenderProps
- Containers
- DecoratorDefinition
- DecoratorSchemaType
- Editor
- EditorConfig
- EditorContext
- EditorEmittedEvent
- EditorEvent
- EditorProviderProps
- EditorSchema
- EditorSelection
- EditorSelectionPoint
- EditorSelector
- EditorSnapshot
- FieldDefinition
- HotkeyOptions
- InlineObject
- InlineObjectDefinition
- InlineObjectRender
- InlineObjectRenderProps
- InlineObjectSchemaType
- InvalidValueResolution
- ListDefinition
- ListSchemaType
- MutationEvent
- OnCopyFn
- OnPasteFn
- OnPasteResult
- OnPasteResultOrPromise
- Operation
- Patch
- PatchesEvent
- Path
- PortableTextBlock
- PortableTextChild
- PortableTextEditableProps
- RegisteredBlockObject
- RegisteredContainer
- RegisteredInlineObject
- RegisteredPositional
- RegisteredSpan
- RegistrableNode
- RenderAnnotationFunction
- RenderBlockFunction
- RenderChildFunction
- RenderDecoratorFunction
- RenderEditableFunction
- RenderListItemFunction
- RenderPlaceholderFunction
- RenderStyleFunction
- SchemaDefinition
- ScrollSelectionIntoViewFunction
- Span
- SpanRender
- SpanRenderProps
- StyleDefinition
- StyleSchemaType
- TextBlock
- TextBlockRender
- TextBlockRenderProps
Functions
Section titled “Functions”- defineBlockObject
- defineContainer
- defineInlineObject
- defineSchema
- defineSpan
- defineTextBlock
- keyGenerator
- resolveContainerAt
usePortableTextEditorusePortableTextEditorSelection