Add a JS lib to support trame-client API through an iframe #2
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
similar to trame-client js-api, trame-iframe js-api provides an agnostic library that can be installed in a regular JS project. trame-iframe js-api could be installed in a host application (could be react/streamlit/vue/... based) to proxy the trame API calls through the iframe to the Communicator and the trame application. The goal is to replicate the trame-client js-api features to make it transparent to the consumer code. API: - trame.state.set - trame.state.update - trame.state.watch - trame.trigger This is still possible to directly interact with the Communicator from an host application by manually sending/listening to events.
jourdain
reviewed
Nov 18, 2024
| { | ||
| "name": "@kitware/trame-iframe-client", | ||
| "version": "0.0.5", | ||
| "license": "MIT", |
There was a problem hiding this comment.
Why MIT instead of Apache?
jourdain
reviewed
Nov 18, 2024
| @@ -0,0 +1,21 @@ | |||
| The MIT License (MIT) | |||
There was a problem hiding this comment.
Why MIT instead of Apache?
jourdain
reviewed
Nov 18, 2024
| /** | ||
| * @returns promise function with a "resolve" attribute, so it can be resolved from outside the promise executor | ||
| */ | ||
| function promiseCreator() { |
There was a problem hiding this comment.
maybe want to provide resolve and reject?
jourdain
reviewed
Nov 18, 2024
| self._attributes["ref"] = f'ref="{self.__ref}"' | ||
| self._attributes["parent_origin"] = f'parentOrigin="{self._parent_origin}"' |
There was a problem hiding this comment.
no need to set _attributes if you add it to self._attr_names
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.
uses: Kitware/trame-client#29 for state watchers API