Skip to main content

extension-mention

Home > @remirror/extension-mention

extension-mention package

Classes

ClassDescription
MentionExtensionThe mention extension wraps mentions as a prosemirror mark. It allows for fluid social experiences to be built. The implementation was inspired by the way twitter and similar social sites allows mentions to be edited after they've been created.

Interfaces

InterfaceDescription
MentionExtensionMatcherThe options for the matchers which can be created by this extension.
MentionOptionsThe static settings passed into a mention
OptionalMentionExtensionProps

Type Aliases

Type AliasDescription
MentionChangeHandlerA handler that will be called whenever the the active matchers are updated or exited. The second argument which is the exit command is a function which is only available when the matching suggester has been exited.
MentionChangeHandlerCommand
MentionChangeHandlerCommandAttributesThe dynamic properties used to change the behavior of the mentions created.
MentionExtensionAttributesThe attrs that will be added to the node. ID and label are plucked and used while attributes like href and role can be assigned as desired.
NamedMentionExtensionAttributes