Does not support marks on non-TextNodes

ascott18 commented 3 years ago

Checklist

[x] Are you reporting a bug? Use github issues for bug reports and feature requests. For general questions, please use https://discuss.yjs.dev/
[x] Try to report your issue in the correct repository. Yjs consists of many modules. When in doubt, report it to https://github.com/yjs/yjs/issues/

Describe the bug

This plugin fundamentally does not support marks on nodes that are not text nodes. For example, Tiptap's image node, which is an inline, non-text node: https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/nodes/Image.js.

To Reproduce

Apply a mark to an inline node. For example, apply a hyperlink (https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Link.js) to an image (https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/nodes/Image.js)
Be the editor of the document. Observe that the JSON version of the prosemirror doc does contain the expected mark, and that the HTML is rendered with the correct <a></a> wrapping the image node.
Be a realtime collaborator on the same document, OR reload the document using the serialized ydoc. Observe that the hyperlink on the image is missing because the mark is not serialized into the ydoc.

Expected behavior

Marks on custom nodes are handled just as attributes on custom nodes are handled.

BrianHung commented 2 years ago

If anyone wants to tackle this in a PR, two main functions to address are createTypeFromElementNode and createNodeFromYElement.

Particularly, serialize the marks of a node as Y.XmlElement attributes using setAttribute while differentiating them somehow from node.attrs, then deserializing them and passing Mark[] as argument to schema.node.

alexharri commented 2 years ago

The lack of support for marks on custom nodes is currently causing issues in an editor that I'm building. Would love to see this feature.

Judging from the title, #63 sounds like it should resolve the issue. Is there something preventing us from taking #63 in @dmonad? I would love to help if I can.