> For the complete documentation index, see [llms.txt](/llms.txt).
> The full corpus is at [llms-full.txt](/llms-full.txt).

# @portabletext/editor

## Classes

- [~~PortableTextEditor~~](/api/editor/classes/portabletexteditor/)

## Interfaces

- [BlockAnnotationRenderProps](/api/editor/interfaces/blockannotationrenderprops/)
- [BlockChildRenderProps](/api/editor/interfaces/blockchildrenderprops/)
- [BlockDecoratorRenderProps](/api/editor/interfaces/blockdecoratorrenderprops/)
- [BlockListItemRenderProps](/api/editor/interfaces/blocklistitemrenderprops/)
- [BlockRenderProps](/api/editor/interfaces/blockrenderprops/)
- [BlockStyleRenderProps](/api/editor/interfaces/blockstylerenderprops/)
- [EditableAPIDeleteOptions](/api/editor/interfaces/editableapideleteoptions/)
- [PasteData](/api/editor/interfaces/pastedata/)
- [PortableTextObject](/api/editor/interfaces/portabletextobject/)
- [PortableTextSpan](/api/editor/interfaces/portabletextspan/)
- [PortableTextTextBlock](/api/editor/interfaces/portabletexttextblock/)
- [RangeDecoration](/api/editor/interfaces/rangedecoration/)
- [RangeDecorationOnMovedDetails](/api/editor/interfaces/rangedecorationonmoveddetails/)

## Type Aliases

- [AddedAnnotationPaths](/api/editor/type-aliases/addedannotationpaths/)
- [AnnotationDefinition](/api/editor/type-aliases/annotationdefinition/)
- [AnnotationPath](/api/editor/type-aliases/annotationpath/)
- [AnnotationSchemaType](/api/editor/type-aliases/annotationschematype/)
- [BaseDefinition](/api/editor/type-aliases/basedefinition/)
- [BlockObject](/api/editor/type-aliases/blockobject/)
- [BlockObjectDefinition](/api/editor/type-aliases/blockobjectdefinition/)
- [BlockObjectRender](/api/editor/type-aliases/blockobjectrender/)
- [BlockObjectRenderProps](/api/editor/type-aliases/blockobjectrenderprops/)
- [BlockObjectSchemaType](/api/editor/type-aliases/blockobjectschematype/)
- [BlockOffset](/api/editor/type-aliases/blockoffset/)
- [BlockPath](/api/editor/type-aliases/blockpath/)
- [ChildPath](/api/editor/type-aliases/childpath/)
- [Container](/api/editor/type-aliases/container/)
- [ContainerRender](/api/editor/type-aliases/containerrender/)
- [ContainerRenderProps](/api/editor/type-aliases/containerrenderprops/)
- [Containers](/api/editor/type-aliases/containers/)
- [DecoratorDefinition](/api/editor/type-aliases/decoratordefinition/)
- [DecoratorSchemaType](/api/editor/type-aliases/decoratorschematype/)
- [Editor](/api/editor/type-aliases/editor/)
- [EditorConfig](/api/editor/type-aliases/editorconfig/)
- [EditorContext](/api/editor/type-aliases/editorcontext/)
- [EditorEmittedEvent](/api/editor/type-aliases/editoremittedevent/)
- [EditorEvent](/api/editor/type-aliases/editorevent/)
- [EditorProviderProps](/api/editor/type-aliases/editorproviderprops/)
- [EditorSchema](/api/editor/type-aliases/editorschema/)
- [EditorSelection](/api/editor/type-aliases/editorselection/)
- [EditorSelectionPoint](/api/editor/type-aliases/editorselectionpoint/)
- [EditorSelector](/api/editor/type-aliases/editorselector/)
- [EditorSnapshot](/api/editor/type-aliases/editorsnapshot/)
- [FieldDefinition](/api/editor/type-aliases/fielddefinition/)
- [HotkeyOptions](/api/editor/type-aliases/hotkeyoptions/)
- [InlineObject](/api/editor/type-aliases/inlineobject/)
- [InlineObjectDefinition](/api/editor/type-aliases/inlineobjectdefinition/)
- [InlineObjectRender](/api/editor/type-aliases/inlineobjectrender/)
- [InlineObjectRenderProps](/api/editor/type-aliases/inlineobjectrenderprops/)
- [InlineObjectSchemaType](/api/editor/type-aliases/inlineobjectschematype/)
- [InvalidValueResolution](/api/editor/type-aliases/invalidvalueresolution/)
- [ListDefinition](/api/editor/type-aliases/listdefinition/)
- [ListSchemaType](/api/editor/type-aliases/listschematype/)
- [MutationEvent](/api/editor/type-aliases/mutationevent/)
- [OnCopyFn](/api/editor/type-aliases/oncopyfn/)
- [OnPasteFn](/api/editor/type-aliases/onpastefn/)
- [OnPasteResult](/api/editor/type-aliases/onpasteresult/)
- [OnPasteResultOrPromise](/api/editor/type-aliases/onpasteresultorpromise/)
- [Operation](/api/editor/type-aliases/operation/)
- [Patch](/api/editor/type-aliases/patch/)
- [PatchesEvent](/api/editor/type-aliases/patchesevent/)
- [Path](/api/editor/type-aliases/path/)
- [PortableTextBlock](/api/editor/type-aliases/portabletextblock/)
- [PortableTextChild](/api/editor/type-aliases/portabletextchild/)
- [PortableTextEditableProps](/api/editor/type-aliases/portabletexteditableprops/)
- [RegisteredBlockObject](/api/editor/type-aliases/registeredblockobject/)
- [RegisteredContainer](/api/editor/type-aliases/registeredcontainer/)
- [RegisteredInlineObject](/api/editor/type-aliases/registeredinlineobject/)
- [RegisteredPositional](/api/editor/type-aliases/registeredpositional/)
- [RegisteredSpan](/api/editor/type-aliases/registeredspan/)
- [RegistrableNode](/api/editor/type-aliases/registrablenode/)
- [RenderAnnotationFunction](/api/editor/type-aliases/renderannotationfunction/)
- [RenderBlockFunction](/api/editor/type-aliases/renderblockfunction/)
- [RenderChildFunction](/api/editor/type-aliases/renderchildfunction/)
- [RenderDecoratorFunction](/api/editor/type-aliases/renderdecoratorfunction/)
- [RenderEditableFunction](/api/editor/type-aliases/rendereditablefunction/)
- [RenderListItemFunction](/api/editor/type-aliases/renderlistitemfunction/)
- [RenderPlaceholderFunction](/api/editor/type-aliases/renderplaceholderfunction/)
- [RenderStyleFunction](/api/editor/type-aliases/renderstylefunction/)
- [SchemaDefinition](/api/editor/type-aliases/schemadefinition/)
- [ScrollSelectionIntoViewFunction](/api/editor/type-aliases/scrollselectionintoviewfunction/)
- [Span](/api/editor/type-aliases/span/)
- [SpanRender](/api/editor/type-aliases/spanrender/)
- [SpanRenderProps](/api/editor/type-aliases/spanrenderprops/)
- [StyleDefinition](/api/editor/type-aliases/styledefinition/)
- [StyleSchemaType](/api/editor/type-aliases/styleschematype/)
- [TextBlock](/api/editor/type-aliases/textblock/)
- [TextBlockRender](/api/editor/type-aliases/textblockrender/)
- [TextBlockRenderProps](/api/editor/type-aliases/textblockrenderprops/)

## Functions

- [defineBlockObject](/api/editor/functions/defineblockobject/)
- [defineContainer](/api/editor/functions/definecontainer/)
- [defineInlineObject](/api/editor/functions/defineinlineobject/)
- [defineSchema](/api/editor/functions/defineschema/)
- [defineSpan](/api/editor/functions/definespan/)
- [defineTextBlock](/api/editor/functions/definetextblock/)
- [keyGenerator](/api/editor/functions/keygenerator/)
- [resolveContainerAt](/api/editor/functions/resolvecontainerat/)
- [~~usePortableTextEditor~~](/api/editor/functions/useportabletexteditor/)
- [~~usePortableTextEditorSelection~~](/api/editor/functions/useportabletexteditorselection/)

## Components

- [PortableTextEditable](/api/editor/variables/portabletexteditable/)
- [EditorProvider](/api/editor/functions/editorprovider/)

## Hooks

- [useEditor](/api/editor/functions/useeditor/)
- [useEditorSelector](/api/editor/functions/useeditorselector/)