[FRE-1668] Update web-component to allow passing props in the same format as the react component (camelCase) #1055
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
toddkao
requested review from
codingki,
NotJeremyLiu,
ericHgorski and
daps94
as code owners
🦋 Changeset detectedLatest commit: acf8420 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 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 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…and manually pass the type of prop it is
toddkao
changed the title
toddkao
commented
Apr 14, 2025
toddkao
changed the title
toddkao
changed the title
toddkao
commented
Apr 14, 2025
Comment on lines
+73
to
+74
| interface HTMLElementTagNameMap { | ||
| [WEB_COMPONENT_NAME]: WidgetProps; |
There was a problem hiding this comment.
super simple, now the element type is equivalent to WidgetProps, so the ide will only show widgetProps in the autocomplete:
|
can add this to the documentation, I'm not sure there is a doc for web component. |
toddkao
commented
Apr 15, 2025
Comment on lines
33
to
+53
|
|
||
| ## Usage | ||
|
|
||
| Props are the same as [`WidgetProps`](./configuration), but passed as attributes in kebab-case. Use strings or stringified objects for complex props. | ||
| Props are the exact same as [`WidgetProps`](./configuration) but you are required to pass them to the element via javascript/typescript. | ||
|
|
||
| ```tsx | ||
| <div style="width:100%; max-width:500px; padding:0 10px;"> | ||
| <skip-widget | ||
| theme='{ | ||
| "brandColor": "#FF4FFF", | ||
| }' | ||
| default-route='{ | ||
| "srcChainId": "osmosis-1", | ||
| "srcAssetDenom": "ibc/1480b8fd20ad5fcae81ea87584d269547dd4d436843c1d20f15e00eb64743ef4" | ||
| }' | ||
| ></skip-widget> | ||
| <skip-widget></skip-widget> | ||
| </div> | ||
| <script> | ||
| const skipWidget = document.querySelector("skip-widget"); | ||
| if (skipWidget) { | ||
| skipWidget.theme = { | ||
| brandColor: "#FF4FFF", | ||
| }; | ||
| skipWidget.defaultRoute = { | ||
| srcChainId: "osmosis-1", | ||
| srcAssetDenom: "ibc/1480b8fd20ad5fcae81ea87584d269547dd4d436843c1d20f15e00eb64743ef4", | ||
| } | ||
| } | ||
| </script> |
There was a problem hiding this comment.
can add this to the documentation, I'm not sure there is a doc for web component.
@codingki docs are here and this is where it shows up https://docs.skip.build/go/widget/web-component
codingki
approved these changes
Apr 15, 2025
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.
No description provided.