prosekit/preact
Interfaces
Section titled “Interfaces”ProseKitProps
Section titled “ProseKitProps”Properties
Section titled “Properties”-
children?:
ComponentChildren
PreactMarkViewProps
Section titled “PreactMarkViewProps”Properties
Section titled “Properties”-
contentRef:
MarkViewContentRef
PreactMarkViewOptions
Section titled “PreactMarkViewOptions”Options for definePreactMarkView.
Properties
Section titled “Properties”-
name:
string
-
The name of the mark type.
-
as?:
MarkViewDOMSpec
-
contentAs?:
MarkViewDOMSpec
-
ignoreMutation?: (
mutation
:ViewMutationRecord
) =>boolean
|void
-
destroy?: () =>
void
PreactNodeViewProps
Section titled “PreactNodeViewProps”Properties
Section titled “Properties”-
contentRef:
NodeViewContentRef
-
getPos: () =>
undefined
|number
-
selected:
boolean
-
decorations: readonly
Decoration
[]
PreactNodeViewOptions
Section titled “PreactNodeViewOptions”Options for definePreactNodeView.
Properties
Section titled “Properties”-
name:
string
-
The name of the node type.
-
as?:
NodeViewDOMSpec
-
contentAs?:
NodeViewDOMSpec
-
update?: (
node
:ProseMirrorNode
,decorations
: readonlyDecoration
[],innerDecorations
:DecorationSource
) =>boolean
|void
-
ignoreMutation?: (
mutation
:ViewMutationRecord
) =>boolean
|void
-
selectNode?: () =>
void
-
deselectNode?: () =>
void
-
setSelection?: (
anchor
:number
,head
:number
,root
:Document
|ShadowRoot
) =>void
-
destroy?: () =>
void
-
onUpdate?: () =>
void
UseEditorDerivedOptions
Section titled “UseEditorDerivedOptions”Properties
Section titled “Properties”-
The editor to add the extension to. If not provided, it will use the editor from the nearest
ProseKit
component.
UseExtensionOptions
Section titled “UseExtensionOptions”Properties
Section titled “Properties”-
The editor to add the extension to. If not provided, it will use the editor from the nearest
ProseKit
component.
Type Aliases
Section titled “Type Aliases”PreactMarkViewComponent
Section titled “PreactMarkViewComponent”-
type PreactMarkViewComponent =
ComponentType
<PreactMarkViewProps
>
PreactNodeViewComponent
Section titled “PreactNodeViewComponent”-
type PreactNodeViewComponent =
ComponentType
<PreactNodeViewProps
>
Variables
Section titled “Variables”ProseKit
Section titled “ProseKit”-
const ProseKit:
ComponentType
<ProseKitProps
> -
The root component for a ProseKit editor.
Functions
Section titled “Functions”definePreactMarkView()
Section titled “definePreactMarkView()”-
function definePreactMarkView(
options
:PreactMarkViewOptions
):Extension
-
Defines a mark view using a Preact component.
definePreactNodeView()
Section titled “definePreactNodeView()”-
function definePreactNodeView(
options
:PreactNodeViewOptions
):Extension
-
Defines a node view using a Preact component.
useDocChange()
Section titled “useDocChange()”-
function useDocChange(
handler
: (doc
:ProseMirrorNode
) =>void
,options?
:UseExtensionOptions
):void
-
Calls the given handler whenever the editor document changes.
useEditorDerivedValue()
Section titled “useEditorDerivedValue()”-
function useEditorDerivedValue<E, Derived>(
derive
: (editor
:Editor
<E
>) =>Derived
,options?
:UseEditorDerivedOptions
<E
>):Derived
-
A hook that runs a function to derive a value from the editor instance after editor state changes.
This is useful when you need to render something based on the editor state, for example, whether the selected text is wrapped in an italic mark.
useEditor()
Section titled “useEditor()”-
Retrieves the editor instance from the nearest ProseKit component.
useExtension()
Section titled “useExtension()”-
function useExtension(
extension
:null
|Extension
<ExtensionTyping
<any
,any
,any
>>,options?
:UseExtensionOptions
):void
-
Add an extension to the editor.
useKeymap()
Section titled “useKeymap()”-
function useKeymap(
keymap
:Keymap
,options?
:UseExtensionOptions
):void
useStateUpdate()
Section titled “useStateUpdate()”-
function useStateUpdate(
handler
: (state
:EditorState
) =>void
,options?
:UseExtensionOptions
):void
-
Calls the given handler whenever the editor state changes.