Revamp custom widget guide #2080
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2080 +/- ##
==========================================
- Coverage 79.17% 79.14% -0.03%
==========================================
Files 631 631
Lines 47531 47536 +5
Branches 754 754
==========================================
- Hits 37631 37621 -10
- Misses 9817 9832 +15
Partials 83 83
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| // If you need to access telemetry data: | ||
| created() { | ||
| // This is provided by the Widget mixin | ||
| this.addSubscription({ item: this.itemName }) |
There was a problem hiding this comment.
I couldn't find addSubscription anywhere. Plus you're not even using this except for console.log. Perhaps this should just go away. You need to import VWidget.js mixin for typical value widgets.
There was a problem hiding this comment.
That's what I get for hurriedly asking Claude to do the example code right before I push 🤦♂️
| }, | ||
| rollupOptions: { | ||
| external: ['vue', 'vuetify'], | ||
| }, |
There was a problem hiding this comment.
Our example widgets (BigWidget, HelloworldWidget) also have these lines:
plugins: [vue(), VitePluginStyleInject()],
resolve: {
extensions: [...DEFAULT_EXTENSIONS, '.vue'], // not recommended but saves us from having to change every SFC import
},
Are these not needed?
There was a problem hiding this comment.
Lol, I think my logic was that those are specific to building a widget with Vue, but they can use any framework (or no framework), so I omitted it. But that doesn't make sense since this guide is for Vue. I'll add it
|
|
||
| If you look at the bottom of the Demo's [plugin.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/plugin.txt) file you'll see we declare the widgets: | ||
| If you have an existing plugin, start in the root directory for that plugin. If you do not yet have a plugin, start by using the [Plugin Generator](../getting-started/generators#plugin-generator) to create one. |
There was a problem hiding this comment.
We should add a note to the effect that you either have widgets or tools in your plugin but not both. I remember having both caused a lot of weird build issues.
|
No description provided.