WIP: Decorations API

[bdbch]

• Decorations API
  • Positions
    • Attach Decorations to specific Nodes
    • Attach Decorations to the cursor
    • Manually set positions of a decoration
  • We should use a DecorationManager that
    • Handles the state for decorations
    • Communicates with a DecorationPlugin to handle creation and rendering of Prosemirror Decorations
  • Decoration Plugin
    • Syncs it’s state with the decoration manager state
    • uses the attached positions of decorations to determine what type of decoration is needed
  • DecorationManager.create => editor.decorations.create
    • The create api is similar to how we create extensions
      • render: handles rendering and allows return of html or react / vue components
      • binding events, f.e. onUpdate, onTransaction, etc.
  • TiptapDecoration
    • attachTo(x)
      • Can take a position, a range or a node
      • The type of decoration is inferred from this attachTo value

[changeset-bot]

⚠️ No Changeset found

Latest commit: 36489ba

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[netlify]

❌ Deploy Preview for tiptap-embed failed. Why did it fail? →

Name	Link
🔨 Latest commit	36489ba
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/6734a19ba83ad7000838dce1

[nperez0111]

Some ideas for how we might wanna structure this:

const editor = new Editor()

editor.on('transaction', () => {

  const removeDecoration = editor.addDecorationWidget({ ...options })

  removeDecoration()

  editor.getDecorationSet('myDecoration').forEach(({ from, to }) => {
    editor.removeDecoration(from, to, 'myDecoration')
  })

})

DecorationSet.create({
  onTransaction,
  shouldShow,
  onCreate,
  onRemove,
  onUpdate,
  name: 'myDecoration',
  onEvent: (eventName, meta)=>{
    if (eventName === 'eventName') {
      // I want this decoration active
      editor.addDecorationSet('myDecoration', decorationSet)
      return;
    }
  }
  onTransaction: tr => {
    if (!tr.isOneIWant) {
      editor.clearDecorationSet('myDecoration')
      return
    }

    this.editor.addDecorationWidget()
  },
})

class DecorationManager {

  allDecorationSets: Record<string, DecorationSet> = {}

  addDecorationSet(key: string, decorationSet: DecorationSet) {
    this.allDecorationSets[key] = decorationSet
  }

  removeDecorationSet(key: string) {
    this.allDecorationSets[key].destroy()
    this.allDecorationSets[key] = undefined
  }

  listDecorationSets() {
    return ['myDecoration', 'anotherDecorationSet']
  }

  getDecorationSet(key: string) {

  }

  triggerEvent(eventName: string) {
    // re-run decoration sets
  }

  getProsemirrorPlugin() {
    return new Plugin({
      key: new PluginKey('decorationManager'),
      state: {
        init: () => this,
        apply: (tr, plugin) => {
          const decorationManager = plugin.getState(tr)

          // map through transactions for all decorations that still exist

          decorationManager.allDecorationSets.forEach(decorationSet => {
            decorationSet.onTransaction(tr)
          })
        },
      },
    })
  }
}

editor.triggerDecoration('eventName', meta)
editor.addDecorationSet('myDecoration', decorationSet)
editor.removeDecorationSet('myDecoration')