Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): add support for markviews #5759

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

feat(core): add support for markviews #5759

wants to merge 2 commits into from

Conversation

nperez0111
Copy link
Contributor

@nperez0111 nperez0111 commented Oct 23, 2024

Changes Overview

This adds basic support for Prosemirror markviews to Marks.

For this to actually become supported we will need to:

  • Have a MarkView class that can manage the markview element instead of having to create your own elements
  • Have a way to render React / Vue components like node views does

From there, we'd pretty much just support them!

Here is what the API looks like right now, but we will probably add a class to make these elements for you:

  addMarkView() {
    return ({ mark, HTMLAttributes }) => {
      const dom = document.createElement('b')
      const contentDOM = document.createElement('span')

      dom.appendChild(contentDOM)

      return {
        dom,
        contentDOM,
      }
    }
  },

Implementation Approach

Pretty much following the same sort of implementation as node views, I was able to add support for markviews.

Testing Done

Verification Steps

I added a temporary markview to a mark and it worked just fine

Additional Notes

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

Copy link

changeset-bot bot commented Oct 23, 2024

⚠️ No Changeset found

Latest commit: 9fe048d

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

Copy link

netlify bot commented Oct 23, 2024

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

Name Link
🔨 Latest commit 9fe048d
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/672de24770d3590008b5e29a

Copy link
Member

@bdbch bdbch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome idea, LGTM!

@bdbch
Copy link
Member

bdbch commented Nov 30, 2024

Tests failed and we'd need to merge with develop again as we got a few merge conflicts.

Looking forward to get this merged.

@nperez0111
Copy link
Contributor Author

I want to do this for v3, & I need to make a react markview impl

Types have also changed in prosemirror view since

@bdbch
Copy link
Member

bdbch commented Dec 2, 2024

Should we change the target branch to next then?

@nperez0111 nperez0111 changed the base branch from develop to next December 2, 2024 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants