Skip to content
Portable Text
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Introduction
Rendering
Overview
React
HTML
Vue
Svelte
Astro
Markdown
Editor
Overview
Getting started
Custom blocks and inline objects
Concepts
Schema and concepts
Behaviors
Guides
Customize editor rendering
Customize the toolbar
Create a custom behavior
Behavior recipes
Testing behaviors
Reference
Editor
Overview
API
Generated
Classes
PortableTextEditor
Interfaces
BlockAnnotationRenderProps
BlockChildRenderProps
BlockDecoratorRenderProps
BlockListItemRenderProps
BlockRenderProps
BlockStyleRenderProps
EditableAPIDeleteOptions
PasteData
PortableTextObject
PortableTextSpan
PortableTextTextBlock
RangeDecoration
RangeDecorationOnMovedDetails
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
defineBlockObject
defineContainer
defineInlineObject
defineSchema
defineSpan
defineTextBlock
EditorProvider
keyGenerator
resolveContainerAt
useEditor
useEditorSelector
usePortableTextEditor
usePortableTextEditorSelection
Behaviors
Overview
API
Generated
Type Aliases
Behavior
BehaviorAction
BehaviorActionSet
BehaviorEvent
BehaviorGuard
CustomBehaviorEvent
InsertPlacement
NativeBehaviorEvent
SyntheticBehaviorEvent
Functions
defineBehavior
effect
execute
forward
raise
Plugins
Overview
API
Generated
Variables
EditorRefPlugin
Functions
BehaviorPlugin
EventListenerPlugin
NodePlugin
Selectors
Overview
API
Generated
Type Aliases
ApplicableSchema
MarkState
Variables
getActiveAnnotations
getActiveListItem
getActiveStyle
getAnchorBlock
getAnchorChild
getAnchorSpan
getAnchorTextBlock
getApplicableSchema
getBlockOffsets
getBlockTextAfter
getBlockTextBefore
getCaretWordSelection
getFirstBlock
getFocusBlock
getFocusBlockObject
getFocusChild
getFocusInlineObject
getFocusListBlock
getFocusSpan
getFocusTextBlock
getFragment
getLastBlock
getMarkState
getNextBlock
getNextInlineObject
getNextInlineObjects
getNextSpan
getPreviousBlock
getPreviousInlineObject
getPreviousInlineObjects
getPreviousSpan
getSelectedBlocks
getSelectedSpans
getSelectedTextBlocks
getSelectedValue
getSelection
getSelectionEndBlock
getSelectionEndChild
getSelectionEndPoint
getSelectionStartBlock
getSelectionStartChild
getSelectionStartPoint
getSelectionText
getValue
isSelectingEntireBlocks
isSelectionCollapsed
isSelectionExpanded
Functions
compareApplicableSchema
isActiveAnnotation
isActiveDecorator
isActiveListItem
isActiveStyle
isAtTheEndOfBlock
isAtTheStartOfBlock
isOverlappingSelection
isPointAfterSelection
isPointBeforeSelection
Toolbar
Overview
API
Generated
Type Aliases
AnnotationButton
AnnotationButtonEvent
AnnotationPopover
AnnotationPopoverEvent
ApplicableSchema
BlockObjectButton
BlockObjectButtonEvent
BlockObjectPopover
BlockObjectPopoverEvent
DecoratorButton
DecoratorButtonEvent
ExtendAnnotationSchemaType
ExtendBlockObjectSchemaType
ExtendDecoratorSchemaType
ExtendInlineObjectSchemaType
ExtendListSchemaType
ExtendStyleSchemaType
HistoryButtons
HistoryButtonsEvent
InlineObjectButton
InlineObjectButtonEvent
InlineObjectPopover
InlineObjectPopoverEvent
ListButton
ListButtonEvent
StyleSelector
StyleSelectorEvent
ToolbarAnnotationSchemaType
ToolbarBlockObjectSchemaType
ToolbarDecoratorSchemaType
ToolbarInlineObjectSchemaType
ToolbarListSchemaType
ToolbarSchema
ToolbarStyleSchemaType
Functions
useAnnotationButton
useAnnotationPopover
useApplicableSchema
useBlockObjectButton
useBlockObjectPopover
useDecoratorButton
useHistoryButtons
useInlineObjectButton
useInlineObjectPopover
useListButton
useStyleSelector
useToolbarSchema
Keyboard Shortcuts
Overview
API
Generated
Type Aliases
KeyboardEventDefinition
KeyboardShortcut
KeyboardShortcutDefinition
Variables
blockquote
bold
code
h1
h2
h3
h4
h5
h6
italic
link
normal
redo
strikeThrough
underline
undo
Functions
createKeyboardShortcut
Conversion
HTML to Portable Text
Markdown to Portable Text
Why Portable Text?
Specification
Ecosystem
All packages
Playground
GitHub
Select theme
Dark
Light
Auto
useHistoryButtons
useHistoryButtons
():
HistoryButtons
Defined in: toolbar/src/use-history-buttons.ts:83
Returns
Section titled “Returns”
HistoryButtons