Skip to content

Instantly share code, notes, and snippets.

@joepie91

joepie91/glossary.md

Created January 6, 2021 18:20
Show Gist options
  • Save joepie91/46241ef1ce89c74958da0fdd7d04eb55 to your computer and use it in GitHub Desktop.
Save joepie91/46241ef1ce89c74958da0fdd7d04eb55 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. joepie91 created this gist Jan 6, 2021.
    21 changes: 21 additions & 0 deletions glossary.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,21 @@
    Since Quill.js doesn't seem to document its strange jargon-y terms anywhere, here's a glossary that I've put together for it. No guarantees that it's correct! But I've done my best.

    __Quill__ - The WYSIWYG editor library

    __Parchment__ - The internal model used in Quill to implement the document tree

    __Scroll__ - A document, expressed as a tree, technically also a Blot (node) itself, specifically the root node

    __Blot__ - A node in the document tree

    __Block (Blot)__ - A block-level node

    __Inline (Blot)__ - An inline (formatting) node

    __Text (Blot)__ - A node that contains only(!) raw text contents

    __Break (Blot)__ - A node that contains nothing, used as a placeholder where there is no actual content

    __"a format"__ - A specific formatting attribute (width, height, is bold, ...)

    __`.format(...)`__ - The API method that is used to set a formatting attribute on some selection