Update alpine.md with better info about proxy limitations #4678
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
The issue described in ueberdosis#1515 is now mentioned in the Alpine documentation so that readers understand why the example does not store the editor as component data and why they should not do so either.
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bdbch
approved these changes
Dec 14, 2023
bdbch
pushed a commit
that referenced
this pull request
Dec 14, 2023
The issue described in #1515 is now mentioned in the Alpine documentation so that readers understand why the example does not store the editor as component data and why they should not do so either.
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.
The issue described in #1515 is now mentioned in the Alpine documentation so that readers understand why the example does not store the editor as component data and why they should not do so either.
Please describe your changes
I struggled for days trying to get Alpine to work with TipTap before finding #1515
The current documentation makes no mention of the limitations with storing the editor as an Alpine component property. The proposed changes attempt to concisely convey all of the necessary information for readers to understand why the Alpine example is the way that it is and warns them of the incompatibility which would very likely be unexpected.
How did you accomplish your changes
The proposed changes adds a comment to the code example at the point where the editor reference is created, explaining why it is not simply made a component property, and even mentions the exact error that the reader can expect to see if they've done so. This will surely help people like myself who were encountering this error during integration.
Related issues
#1515