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

fix(core): editor.commands.setContent setting document attributes #5814

Conversation

StephanMeijer
Copy link

@StephanMeijer StephanMeijer commented Nov 7, 2024

Related to #5813. Fixes editor.command.setContent not setting attribute on document.

Changes Overview

Related to #5813. Fixes editor.command.setContent not setting attribute on document.

Implementation Approach

As ProseMirror doesn't seem to be replacing the document attributes, we now do that manually.

Testing Done

Manually, but feel free to recommend me. Also see #5813

Verification Steps

import { Editor } from '../tiptap/packages/core'
import Document from '../tiptap/packages/extension-document'
import Paragraph from '../tiptap/packages/extension-paragraph'
import Text from '../tiptap/packages/extension-text'


const editor = new Editor({
    element: document.querySelector('.element'),
    extensions: [
        Document.extend({
            addAttributes() {
                return {
                    ...this?.parent?.(),
                    testAttr1: { default: 'DEFAULT' }
                }
            }
        }),
        Paragraph.extend({
            addAttributes() {
                return {
                    ...this?.parent?.(),
                    testAttr2: { default: 'DEFAULT' }
                }
            }
        }),,
        Text
    ],
    content: '<p>Default content</p>',
})

editor.commands.setContent({ 
    type: "doc", 
    attrs: { testAttr1: "Not default" },
    content: [
        {
            type: "paragraph",
            attrs: { testAttr2: "Not default" },
            content: [
                { type: "text", text: "Updated content" }
            ]
        }
    ]
})

console.log(editor.state.doc.attrs); // { testAttr1: "Not default" }
console.log(editor.state.doc.content.firstChild.attrs); // { testAttr2: "Not default" }

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

#5813

Copy link

changeset-bot bot commented Nov 7, 2024

🦋 Changeset detected

Latest commit: 25a4fb2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 54 packages
Name Type
@tiptap/core Patch
@tiptap/extension-blockquote Patch
@tiptap/extension-bold Patch
@tiptap/extension-bubble-menu Patch
@tiptap/extension-bullet-list Patch
@tiptap/extension-character-count Patch
@tiptap/extension-code-block-lowlight Patch
@tiptap/extension-code-block Patch
@tiptap/extension-code Patch
@tiptap/extension-collaboration-cursor Patch
@tiptap/extension-collaboration Patch
@tiptap/extension-color Patch
@tiptap/extension-document Patch
@tiptap/extension-dropcursor Patch
@tiptap/extension-floating-menu Patch
@tiptap/extension-focus Patch
@tiptap/extension-font-family Patch
@tiptap/extension-gapcursor Patch
@tiptap/extension-hard-break Patch
@tiptap/extension-heading Patch
@tiptap/extension-highlight Patch
@tiptap/extension-history Patch
@tiptap/extension-horizontal-rule Patch
@tiptap/extension-image Patch
@tiptap/extension-italic Patch
@tiptap/extension-link Patch
@tiptap/extension-list-item Patch
@tiptap/extension-list-keymap Patch
@tiptap/extension-mention Patch
@tiptap/extension-ordered-list Patch
@tiptap/extension-paragraph Patch
@tiptap/extension-placeholder Patch
@tiptap/extension-strike Patch
@tiptap/extension-subscript Patch
@tiptap/extension-superscript Patch
@tiptap/extension-table-cell Patch
@tiptap/extension-table-header Patch
@tiptap/extension-table-row Patch
@tiptap/extension-table Patch
@tiptap/extension-task-item Patch
@tiptap/extension-task-list Patch
@tiptap/extension-text-align Patch
@tiptap/extension-text-style Patch
@tiptap/extension-text Patch
@tiptap/extension-typography Patch
@tiptap/extension-underline Patch
@tiptap/extension-youtube Patch
@tiptap/html Patch
@tiptap/pm Patch
@tiptap/react Patch
@tiptap/starter-kit Patch
@tiptap/suggestion Patch
@tiptap/vue-2 Patch
@tiptap/vue-3 Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

netlify bot commented Nov 7, 2024

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 25a4fb2
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/672d18e23682410008e0bf16
😎 Deploy Preview https://deploy-preview-5814--tiptap-embed.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Related to ueberdosis#5813. Fixes editor.command.setContent not setting attribute
on document.
Comment on lines +61 to +64

Object.entries(document.attrs).forEach(([key, value]) => {
tr.setDocAttribute(key, value)
})
Copy link
Contributor

Choose a reason for hiding this comment

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

We are planning to remove this branch in the next version (and already have).

So, I don't think that this is the right place for it.

I'm not sure that a method named setContent should update the doc's attributes. I think you may want to implement this in your application instead. I don't think it belongs in this command

Copy link
Contributor

Choose a reason for hiding this comment

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

We tend not to promote doc attributes because they are not synchronized in collaboration with y-prosemirror because of a long standing bug.

So, we don't want to promote something that would not work in the Tiptap ecosystem

Copy link
Author

Choose a reason for hiding this comment

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

Alright, I do understand.

@nperez0111
Copy link
Contributor

Appreciate the contribution though & your understanding. Will close this as a won't do for now

@nperez0111 nperez0111 closed this Nov 8, 2024
@nperez0111 nperez0111 added the Info: Wont Fix The issue or pullrequest will not be fixed label Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Info: Wont Fix The issue or pullrequest will not be fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants