docs: note x-modelable JSON clone limitation - #4880
Open
pooridev wants to merge 1 commit into
Open
Conversation
x-modelable syncs via JSON.parse(JSON.stringify()), which silently
drops File, Map, Set, and other non-JSON values. Point users at
$dispatch('input') for those cases. Fixes alpinejs#4873.
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
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.
What
Document that
x-modelableclones values withJSON.parse(JSON.stringify()), so non-JSON types (File,Map,Set, class instances, DOM nodes, …) are silently dropped. Point to$dispatch('input', value)as the existing escape hatch thatx-modelalready understands.Fixes #4873
Why
Anyone exposing a file picker (or other non-plain-object state) through
x-modelablegets an outer value that looks populated but has empty{}elements. The docs currently read as a general-purpose two-way binding with no serializability caveat.Test plan
$dispatchlink to the x-model section is correctMade with Cursor