Class: QuillMentions

mentions~ QuillMentions

new QuillMentions(quill, options)

Parameters:
Name Type Argument Description
quill Object An instance of `Quill`.
options Object <optional>
User configuration passed to the mentions module. It's mixed in with defaults.
Properties:
Name Type Description
quill Quill
container HTMLElement Container for the popover (a.k.a. the View)
matcher RegExp Used to scan contents of editor for mentions.
Source:

Methods

<private> addFormat()

Waiting on new custom formats in Quill to beef this up.
Source:

addMention(node)

Needs to be refactored! QuillMention should be responsible for this action.
Parameters:
Name Type Description
node HTMLElement
Source:

findMention() → {Match}

Looks for a string in the editor (up to the cursor's current position) for a match to QuillMentions~matcher
Source:
Returns:
Type
Match

hasSelection()

Refactor.
Source:

listenClick(elt)

Listens for a click or touchend event on the View.
Parameters:
Name Type Description
elt HTMLElement
Source:

listenHotKeys(quill)

Sets a listener for keyboard events on the given container. Events are dispatched through the KEYS object.
Parameters:
Name Type Description
quill Quill An instance of Quill
Source:

listenSelectionChange(quill)

Sets a listener for selection-change events on the given Quill instance
Parameters:
Name Type Description
quill Quill An instance of Quill
Source:

listenTextChange(quill)

Sets a listener for text-change events on the given Quill instance
Parameters:
Name Type Description
quill Quill An instance of Quill
Source:

<private> setController(options)

Sets QuillMentions.controller to a Controller or AJAXController object (depending on options).
Parameters:
Name Type Description
options Object Configuration for the controller.
Source:

<private> setView(container, options)

Sets QuillMentions.view to a View object
Parameters:
Name Type Description
container HTMLElement
options Object Configuration for the view
Source: