PortableTextEditor

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:112

The main Portable Text Editor component.

Deprecated

Use EditorProvider instead

Extends

• Component<PortableTextEditorProps<InternalEditor | undefined>>

Constructors

Constructor

new PortableTextEditor(props): PortableTextEditor

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:143

Parameters

props

PortableTextEditorProps

Returns

PortableTextEditor

Overrides

Component< PortableTextEditorProps<InternalEditor | 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.1.11/node_modules/@types/react/index.d.ts:946

If using React 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

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

Inherited from

Component.context

---

props

readonly props: Readonly<PortableTextEditorProps<undefined | InternalEditor>>

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:970

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<S>

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:971

Inherited from

Component.state

---

contextType?

static optional contextType: Context<any>

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:922

If set, this.context will be set at runtime to the current value of the given Context.

Example

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}

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.1.11/node_modules/@types/react/index.d.ts:928

Ignored by React.

Deprecated

Only kept in types for backwards compatibility. Will be removed in a future major release.

Inherited from

Component.propTypes

Methods

componentDidCatch()?

optional componentDidCatch(error, errorInfo): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1210

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()

componentDidMount(): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:175

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns

void

Overrides

Component.componentDidMount

---

componentDidUpdate()

componentDidUpdate(prevProps): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:206

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

Returns

void

Overrides

Component.componentDidUpdate

---

componentWillMount()?

optional componentWillMount(): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1268

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.

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17

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, nextContext): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1299

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.

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17

Parameters

nextProps

Readonly<PortableTextEditorProps<undefined | InternalEditor>>

nextContext

any

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()

componentWillUnmount(): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:250

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

Overrides

Component.componentWillUnmount

---

componentWillUpdate()?

optional componentWillUpdate(nextProps, nextState, nextContext): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1331

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.

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

Parameters

nextProps

Readonly<PortableTextEditorProps<undefined | InternalEditor>>

nextState

Readonly<S>

nextContext

any

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.1.11/node_modules/@types/react/index.d.ts:967

Parameters

callback?

() => void

Returns

void

Inherited from

Component.forceUpdate

---

getSnapshotBeforeUpdate()?

optional getSnapshotBeforeUpdate(prevProps, prevState): any

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1246

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 | InternalEditor>>

prevState

Readonly<S>

Returns

any

Inherited from

Component.getSnapshotBeforeUpdate

---

render()

render(): Element

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:270

Returns

Element

Overrides

Component.render

---

setEditable()

setEditable(editable): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:263

Parameters

editable

EditableAPI

Returns

void

---

setState()

setState<K>(state, callback?): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:962

Type Parameters

K

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, nextContext): boolean

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1200

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 | InternalEditor>>

nextState

Readonly<S>

nextContext

any

Returns

boolean

Inherited from

Component.shouldComponentUpdate

---

UNSAFE_componentWillMount()?

optional UNSAFE_componentWillMount(): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1283

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.

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead

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, nextContext): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1317

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.

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

Parameters

nextProps

Readonly<PortableTextEditorProps<undefined | InternalEditor>>

nextContext

any

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, nextContext): void

Defined in: node_modules/.pnpm/@types+react@19.1.11/node_modules/@types/react/index.d.ts:1347

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.

Deprecated

16.3, use getSnapshotBeforeUpdate instead

Parameters

nextProps

Readonly<PortableTextEditorProps<undefined | InternalEditor>>

nextState

Readonly<S>

nextContext

any

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:309

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isActive = useEditorSelector(editor, selectors.getActiveAnnotations)

Parameters

editor

PortableTextEditor

Returns

PortableTextObject[]

---

addAnnotation()

static addAnnotation<TSchemaType>(editor, type, value?): undefined | AddedAnnotationPaths

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:349

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'annotation.add',
 annotation: {
   name: '...',
   value: {...},
 }
})

Type Parameters

TSchemaType

TSchemaType extends object

Parameters

editor

PortableTextEditor

type

TSchemaType

value?

Returns

undefined | AddedAnnotationPaths

---

blur()

static blur(editor): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:367

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'blur',
})

Parameters

editor

PortableTextEditor

Returns

void

---

delete()

static delete(editor, selection, options?): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:372

Parameters

editor

PortableTextEditor

selection

EditorSelection

options?

EditableAPIDeleteOptions

Returns

void

---

findByPath()

static findByPath(editor, path): [undefined | PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>, undefined | Path]

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:385

Parameters

editor

PortableTextEditor

path

Path

Returns

[undefined | PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>, undefined | Path]

---

findDOMNode()

static findDOMNode(editor, element): undefined | Node

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:378

Parameters

editor

PortableTextEditor

element

PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>

Returns

undefined | Node

---

focus()

static focus(editor): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:400

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'focus',
})

Parameters

editor

PortableTextEditor

Returns

void

---

focusBlock()

static focusBlock(editor): undefined | PortableTextBlock

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:415

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const focusBlock = useEditorSelector(editor, selectors.getFocusBlock)

Parameters

editor

PortableTextEditor

Returns

undefined | PortableTextBlock

---

focusChild()

static focusChild(editor): undefined | PortableTextChild

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:429

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const focusChild = useEditorSelector(editor, selectors.getFocusChild)

Parameters

editor

PortableTextEditor

Returns

undefined | PortableTextChild

---

getFragment()

static getFragment(editor): undefined | PortableTextBlock[]

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:719

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const selectedSlice = useEditorSelector(editor, selectors.getSelectedSlice)

Parameters

editor

PortableTextEditor

Returns

undefined | PortableTextBlock[]

---

getSelection()

static getSelection(editor): EditorSelection

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:445

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const selection = useEditorSelector(editor, selectors.getSelection)

Parameters

editor

PortableTextEditor

Returns

EditorSelection

---

getValue()

static getValue(editor): undefined | PortableTextBlock[]

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:459

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const value = useEditorSelector(editor, selectors.getValue)

Parameters

editor

PortableTextEditor

Returns

undefined | PortableTextBlock[]

---

hasBlockStyle()

static hasBlockStyle(editor, blockStyle): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:473

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isActive = useEditorSelector(editor, selectors.isActiveStyle(...))

Parameters

editor

PortableTextEditor

blockStyle

string

Returns

boolean

---

hasListStyle()

static hasListStyle(editor, listStyle): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:487

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isActive = useEditorSelector(editor, selectors.isActiveListItem(...))

Parameters

editor

PortableTextEditor

listStyle

string

Returns

boolean

---

insertBlock()

static insertBlock<TSchemaType>(editor, type, value?): undefined | Path

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:576

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'insert.block object',
 blockObject: {
   name: '...',
   value: {...},
 },
 placement: 'auto' | 'after' | 'before',
})

Type Parameters

TSchemaType

TSchemaType extends object

Parameters

editor

PortableTextEditor

type

TSchemaType

value?

Returns

undefined | Path

---

insertBreak()

static insertBreak(editor): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:595

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'insert.break',
})

Parameters

editor

PortableTextEditor

Returns

void

---

insertChild()

static insertChild<TSchemaType>(editor, type, value?): undefined | Path

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:551

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'insert.span',
 text: '...',
 annotations: [{name: '...', value: {...}}],
 decorators: ['...'],
})
editor.send({
 type: 'insert.inline object',
 inlineObject: {
   name: '...',
   value: {...},
 },
})

Type Parameters

TSchemaType

TSchemaType extends object

Parameters

editor

PortableTextEditor

type

TSchemaType

value?

Returns

undefined | Path

---

isAnnotationActive()

static isAnnotationActive(editor, annotationType): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:325

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isActive = useEditorSelector(editor, selectors.isActiveAnnotation(...))

Parameters

editor

PortableTextEditor

annotationType

string

Returns

boolean

---

isCollapsedSelection()

static isCollapsedSelection(editor): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:501

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isSelectionCollapsed = useEditorSelector(editor, selectors.isSelectionCollapsed)

Parameters

editor

PortableTextEditor

Returns

boolean

---

isExpandedSelection()

static isExpandedSelection(editor): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:514

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isSelectionExpanded = useEditorSelector(editor, selectors.isSelectionExpanded)

Parameters

editor

PortableTextEditor

Returns

boolean

---

isMarkActive()

static isMarkActive(editor, mark): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:527

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isActive = useEditorSelector(editor, selectors.isActiveDecorator(...))

Parameters

editor

PortableTextEditor

mark

string

Returns

boolean

---

isObjectPath()

static isObjectPath(_editor, path): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:606

Parameters

_editor

PortableTextEditor

path

Path

Returns

boolean

---

isSelectionsOverlapping()

static isSelectionsOverlapping(editor, selectionA, selectionB): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:767

Deprecated

Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/

import * as selectors from '@portabletext/editor/selectors'
const editor = useEditor()
const isOverlapping = useEditorSelector(editor, selectors.isOverlappingSelection(selectionB))

Parameters

editor

PortableTextEditor

selectionA

EditorSelection

selectionB

EditorSelection

Returns

boolean

---

isVoid()

static isVoid(editor, element): boolean

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:599

Parameters

editor

PortableTextEditor

element

PortableTextSpan | PortableTextObject | PortableTextTextBlock<PortableTextSpan | PortableTextObject>

Returns

boolean

---

marks()

static marks(editor): string[]

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:613

Parameters

editor

PortableTextEditor

Returns

string[]

---

redo()

static redo(editor): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:752

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
  type: 'history.redo',
})

Parameters

editor

PortableTextEditor

Returns

void

---

removeAnnotation()

static removeAnnotation<TSchemaType>(editor, type): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:651

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'annotation.remove',
 annotation: {
   name: '...',
 },
})

Type Parameters

TSchemaType

TSchemaType extends object

Parameters

editor

PortableTextEditor

type

TSchemaType

Returns

void

---

select()

static select(editor, selection): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:629

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'select',
 selection: {...},
})

Parameters

editor

PortableTextEditor

selection

EditorSelection

Returns

void

---

toggleBlockStyle()

static toggleBlockStyle(editor, blockStyle): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:668

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'style.toggle',
 style: '...',
})

Parameters

editor

PortableTextEditor

blockStyle

string

Returns

void

---

toggleList()

static toggleList(editor, listStyle): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:688

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'list item.toggle',
 listItem: '...',
})

Parameters

editor

PortableTextEditor

listStyle

string

Returns

void

---

toggleMark()

static toggleMark(editor, mark): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:704

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
 type: 'decorator.toggle',
 decorator: '...',
})

Parameters

editor

PortableTextEditor

mark

string

Returns

void

---

undo()

static undo(editor): void

Defined in: packages/editor/src/editor/PortableTextEditor.tsx:736

Deprecated

Use editor.send(...) instead

const editor = useEditor()
editor.send({
  type: 'history.undo',
})

Parameters

editor

PortableTextEditor

Returns

void