Support validate options in node and mark attribute definitions.
#5991
+11
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…initions. ProseMirror allows node and mark specs to define a `validate` function or type, which is used when deserializing JSON, parsing from the DOM, etc. See https://prosemirror.net/docs/ref/#model.AttributeSpec.validate Currently, `default` is the only attribute spec option passed through to ProseMirror when resolving the schema. This change updates `getAttributesFromExtensions` and `getSchemaByResolvedExtensions` (and relevant types) to also pass through any defined `validate` attribute option. To use this, add a `validate` type or function option in any extension's `addAttributes` or `addGlobalAttributes` definition, e.g.: ``` export const NodeId = Extension.create({ name: 'nodeId', addGlobalAttributes() { return [ { types: [...], attributes: { nodeId: { default: '__node_id__', validate: 'string', ... } } } ] } }); ``` A more complex validation could ensure that the ID is shaped like a UUID, or allow it to be `null` or `undefined`.
🦋 Changeset detectedLatest commit: f172ddb The changes in this PR will be included in the next version bump. This PR includes changesets to release 57 packages
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 |
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nperez0111
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes Overview
ProseMirror allows node and mark specs to define a
validatefunction or type, which is used when deserializing JSON, parsing from the DOM, etc.See https://prosemirror.net/docs/ref/#model.AttributeSpec.validate
Implementation Approach
Currently,
defaultis the only attribute spec option passed through to ProseMirror when resolving the schema. This change updatesgetAttributesFromExtensionsandgetSchemaByResolvedExtensions(and relevant types) to also pass through any definedvalidateattribute option.Testing Done
Manual testing (plus using the patch in production!)
Verification Steps
To use this, add a
validatetype or function option in any extension'saddAttributesoraddGlobalAttributesdefinition, e.g.:A more complex validation could ensure that the ID is shaped like a UUID, or allow it to be
nullorundefined.Additional Notes
Checklist
Related Issues