PortableTextEditor
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:112
The main Portable Text Editor component.
Extends
Component
<PortableTextEditorProps
<Editor
|undefined
>>
Constructors
new PortableTextEditor()
new PortableTextEditor(
props
):PortableTextEditor
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:133
Parameters
props
PortableTextEditorProps
<undefined
>
Returns
Overrides
Component< PortableTextEditorProps<Editor | undefined> >.constructor
Properties
change$
change$:
EditorChanges
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:119
An observable of all the editor changes.
context
context:
unknown
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:941
If using the new style context, re-declare this in your class to be the
React.ContextType
of your static contextType
.
Should be used with type annotation or static contextType.
Example
See
Inherited from
Component.context
props
readonly
props:Readonly
<PortableTextEditorProps
<undefined
|Editor
>>
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:957
Inherited from
Component.props
schemaTypes
schemaTypes:
PortableTextMemberSchemaTypes
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:123
A lookup table for all the relevant schema types for this portable text type.
state
state:
Readonly
<{}>
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:958
Inherited from
Component.state
contextType?
static
optional
contextType:Context
<any
>
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:917
If set, this.context
will be set at runtime to the current value of the given Context.
Example
See
https://react.dev/reference/react/Component#static-contexttype
Inherited from
Component.contextType
displayName
static
displayName:string
='PortableTextEditor'
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:115
propTypes?
static
optional
propTypes:any
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:923
Ignored by React.
Inherited from
Component.propTypes
Methods
componentDidCatch()?
optional
componentDidCatch(error
,errorInfo
):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1190
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters
error
Error
errorInfo
ErrorInfo
Returns
void
Inherited from
Component.componentDidCatch
componentDidMount()?
optional
componentDidMount():void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1169
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns
void
Inherited from
Component.componentDidMount
componentDidUpdate()
componentDidUpdate(
prevProps
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:156
Called immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Parameters
prevProps
PortableTextEditorProps
<undefined
>
Returns
void
Overrides
Component.componentDidUpdate
componentWillMount()?
optional
componentWillMount():void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1248
Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.componentWillMount
componentWillReceiveProps()?
optional
componentWillReceiveProps(nextProps
):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1279
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component.setState generally does not trigger this method.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
nextProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.componentWillReceiveProps
componentWillUnmount()?
optional
componentWillUnmount():void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1185
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
cancelled network requests, or cleaning up any DOM elements created in componentDidMount
.
Returns
void
Inherited from
Component.componentWillUnmount
componentWillUpdate()?
optional
componentWillUpdate(nextProps
,nextState
):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1311
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component.setState here.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
nextProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
nextState
Readonly
<{}>
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.componentWillUpdate
forceUpdate()
forceUpdate(
callback
?):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:954
Parameters
callback?
() => void
Returns
void
Inherited from
Component.forceUpdate
getSnapshotBeforeUpdate()?
optional
getSnapshotBeforeUpdate(prevProps
,prevState
):any
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1226
Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.
Note: the presence of this method prevents any of the deprecated lifecycle events from running.
Parameters
prevProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
prevState
Readonly
<{}>
Returns
any
Inherited from
Component.getSnapshotBeforeUpdate
render()
render():
Element
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:216
Returns
Element
Overrides
Component.render
setEditable()
setEditable(
editable
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:209
Parameters
editable
Returns
void
setState()
setState<
K
>(state
,callback
?):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:949
Type Parameters
• K extends never
Parameters
state
null
| {} | (prevState
, props
) => null
| {} | Pick
<{}, K
> | Pick
<{}, K
>
callback?
() => void
Returns
void
Inherited from
Component.setState
shouldComponentUpdate()?
optional
shouldComponentUpdate(nextProps
,nextState
):boolean
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1180
Called to determine whether the change in props and state should trigger a re-render.
Component
always returns true.
PureComponent
implements a shallow comparison on props and state and returns true if any
props or states have changed.
If false is returned, Component.render, componentWillUpdate
and componentDidUpdate
will not be called.
Parameters
nextProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
nextState
Readonly
<{}>
Returns
boolean
Inherited from
Component.shouldComponentUpdate
UNSAFE_componentWillMount()?
optional
UNSAFE_componentWillMount():void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1263
Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.UNSAFE_componentWillMount
UNSAFE_componentWillReceiveProps()?
optional
UNSAFE_componentWillReceiveProps(nextProps
):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1297
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component.setState generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
nextProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.UNSAFE_componentWillReceiveProps
UNSAFE_componentWillUpdate()?
optional
UNSAFE_componentWillUpdate(nextProps
,nextState
):void
Defined in: node_modules/.pnpm/@types+react@19.0.8/node_modules/@types/react/index.d.ts:1327
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component.setState here.
This method will not stop working in React 17.
Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.
Parameters
nextProps
Readonly
<PortableTextEditorProps
<undefined
| Editor
>>
nextState
Readonly
<{}>
Returns
void
See
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
Component.UNSAFE_componentWillUpdate
activeAnnotations()
static
activeAnnotations(editor
):PortableTextObject
[]
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:274
Parameters
editor
Returns
PortableTextObject
[]
addAnnotation()
static
addAnnotation<TSchemaType
>(editor
,type
,value
?):undefined
|AddedAnnotationPaths
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:314
Type Parameters
• TSchemaType extends object
Parameters
editor
type
TSchemaType
value?
Returns
undefined
| AddedAnnotationPaths
blur()
static
blur(editor
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:332
Parameters
editor
Returns
void
delete()
static
delete(editor
,selection
,options
?):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:337
Parameters
editor
selection
options?
Returns
void
findByPath()
static
findByPath(editor
,path
): [undefined
|PortableTextSpan
|PortableTextObject
|PortableTextTextBlock
,undefined
|Path
]
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:350
Parameters
editor
path
Path
Returns
[undefined
| PortableTextSpan
| PortableTextObject
| PortableTextTextBlock
, undefined
| Path
]
findDOMNode()
static
findDOMNode(editor
,element
):undefined
|Node
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:343
Parameters
editor
element
PortableTextSpan
| PortableTextObject
| PortableTextTextBlock
Returns
undefined
| Node
focus()
static
focus(editor
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:365
Parameters
editor
Returns
void
focusBlock()
static
focusBlock(editor
):undefined
|PortableTextBlock
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:380
Parameters
editor
Returns
undefined
| PortableTextBlock
focusChild()
static
focusChild(editor
):undefined
|PortableTextChild
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:394
Parameters
editor
Returns
undefined
| PortableTextChild
getFragment()
static
getFragment(editor
):undefined
|PortableTextBlock
[]
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:684
Parameters
editor
Returns
undefined
| PortableTextBlock
[]
getSelection()
static
getSelection(editor
):EditorSelection
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:410
Parameters
editor
Returns
getValue()
static
getValue(editor
):undefined
|PortableTextBlock
[]
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:424
Parameters
editor
Returns
undefined
| PortableTextBlock
[]
hasBlockStyle()
static
hasBlockStyle(editor
,blockStyle
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:438
Parameters
editor
blockStyle
string
Returns
boolean
hasListStyle()
static
hasListStyle(editor
,listStyle
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:452
Parameters
editor
listStyle
string
Returns
boolean
insertBlock()
static
insertBlock<TSchemaType
>(editor
,type
,value
?):undefined
|Path
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:541
Type Parameters
• TSchemaType extends object
Parameters
editor
type
TSchemaType
value?
Returns
undefined
| Path
insertBreak()
static
insertBreak(editor
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:560
Parameters
editor
Returns
void
insertChild()
static
insertChild<TSchemaType
>(editor
,type
,value
?):undefined
|Path
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:516
Type Parameters
• TSchemaType extends object
Parameters
editor
type
TSchemaType
value?
Returns
undefined
| Path
isAnnotationActive()
static
isAnnotationActive(editor
,annotationType
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:290
Parameters
editor
annotationType
string
Returns
boolean
isCollapsedSelection()
static
isCollapsedSelection(editor
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:466
Parameters
editor
Returns
boolean
isExpandedSelection()
static
isExpandedSelection(editor
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:479
Parameters
editor
Returns
boolean
isMarkActive()
static
isMarkActive(editor
,mark
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:492
Parameters
editor
mark
string
Returns
boolean
isObjectPath()
static
isObjectPath(_editor
,path
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:571
Parameters
_editor
path
Path
Returns
boolean
isSelectionsOverlapping()
static
isSelectionsOverlapping(editor
,selectionA
,selectionB
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:711
Parameters
editor
selectionA
selectionB
Returns
boolean
isVoid()
static
isVoid(editor
,element
):boolean
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:564
Parameters
editor
element
PortableTextSpan
| PortableTextObject
| PortableTextTextBlock
Returns
boolean
marks()
static
marks(editor
):string
[]
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:578
Parameters
editor
Returns
string
[]
redo()
static
redo(editor
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:696
Parameters
editor
Returns
void
removeAnnotation()
static
removeAnnotation<TSchemaType
>(editor
,type
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:616
Type Parameters
• TSchemaType extends object
Parameters
editor
type
TSchemaType
Returns
void
select()
static
select(editor
,selection
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:594
Parameters
editor
selection
Returns
void
toggleBlockStyle()
static
toggleBlockStyle(editor
,blockStyle
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:633
Parameters
editor
blockStyle
string
Returns
void
toggleList()
static
toggleList(editor
,listStyle
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:653
Parameters
editor
listStyle
string
Returns
void
toggleMark()
static
toggleMark(editor
,mark
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:669
Parameters
editor
mark
string
Returns
void
undo()
static
undo(editor
):void
Defined in: packages/editor/src/editor/PortableTextEditor.tsx:691
Parameters
editor
Returns
void