add ComponentMapper to allow plugging in custom compoment implementations #119
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
| * limitations under the License. | ||
| */ | ||
|
|
||
| type ElementType = |
There was a problem hiding this comment.
this is copied from the .proto file since I couldn't figure out how to import it
There was a problem hiding this comment.
import {Element as ElementProto } from 'path/to/proto'
type ElementType = Exclude<ElementProto["type"], undefined>
| toast: MappingNotYetDefined | ||
| vegaLiteChart: MappingNotYetDefined | ||
| video: MappingNotYetDefined | ||
| heading: (props: { value: string }) => React.ReactElement |
There was a problem hiding this comment.
this is an example of how to type the plumbed properties
| switch (node.element.type) { | ||
| case "heading": | ||
| return componentFunc({ | ||
| value: node.element.heading?.body, |
There was a problem hiding this comment.
here's the transform from protobuf element to the properties to pass to the custom "heading" component
| @@ -1241,7 +1241,17 @@ export class Dashboard extends Component { | |||
| <div className="col-md-8 grid-margin stretch-card"> | |||
| <div className="card"> | |||
| <div className="card-body"> | |||
| <StreamlitView /> | |||
| <StreamlitView | |||
| componentMapper={{ | |||
There was a problem hiding this comment.
example of using the componentMapper to modify how "heading" gets rendered
There was a problem hiding this comment.
You should make it red or something to prove that it's really doing something :)
There was a problem hiding this comment.
I made it really big 🙃
kmcgrady
approved these changes
Dec 12, 2023
| * limitations under the License. | ||
| */ | ||
|
|
||
| type ElementType = |
There was a problem hiding this comment.
import {Element as ElementProto } from 'path/to/proto'
type ElementType = Exclude<ElementProto["type"], undefined>
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.
Describe your changes
Add a "ComponentMapper" which allows overriding the default component implementations with custom ones. This allows plugging in custom component implementations (e.g. core-ui, chakra, other component libraries, or custom rolled). There's a mapping from the protobuf element type e.g.
headingto what component should be rendered. This mapping also transforms props from the protobuf. Those are not yet defined (I just implementedvalueforheadingas an example how to do this).GitHub Issue Link (if applicable)
Testing Plan
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.