Clarify change: callback signature as () => void in AFM spec - #938
Merged
Conversation
🦋 Changeset detectedLatest commit: 5224a76 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 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 |
Closes #931 See marimo-team/marimo#7989. The AFM docs and types previously used `Function` / `ChangeEventHandler<Payload>` for the `on("change:...")` callback, which implied (or in the types case, required) arguments like the model instance and new value. These extra arguments are a Backbone.js implementation detail leaked from ipywidgets' internals — they are not part of the AFM contract and are not provided by other host platforms like marimo. This updates the spec, types, and type tests to make the `() => void` signature explicit. Widget authors should use `model.get()` inside the callback to read the current value. The docs now include an example and a note explaining the portability concern.
Collaborator
|
Thank you! |
Merged
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
2 participants
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.
Closes #931
See marimo-team/marimo#7989.
The AFM docs and types previously used
Function/ChangeEventHandler<Payload>for theon("change:...")callback, which implied (or in the types case, required) arguments like the model instance and new value. These extra arguments are a Backbone.js implementation detail leaked from ipywidgets' internals — they are not part of the AFM contract and are not provided by other host platforms like marimo.This updates the spec, types, and type tests to make the
() => voidsignature explicit. Widget authors should usemodel.get()inside the callback to read the current value. The docs now include an example and a note explaining the portability concern.