You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our React wrappers (Build/react wrapper #85) can generate typescript types. This is honestly necessary for React-friendly components. Typescript tooling will be able to auto-complete prop names, surface errors in the developers workflow, and all the nice things like that 😄
Sidenote (this one is a little more minor): we can make the generator code for our React wrappers a little smarter by using the manifest as the canonical source of truth for the attributes, events, etc. Example here how shoelace does it
The custom-elements.json file would be a great source of truth for generating documentation. Similar to how docs.mux.com generates API reference docs based on the Open API spec.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
There is a convention to create a
custom-elements.json
file for web components projects. It's a community standard:The immediate benefits I see:
custom-elements.json
file would be a great source of truth for generating documentation. Similar to how docs.mux.com generates API reference docs based on the Open API spec.Not sure how much of a time suck it would be to do this, but may worth doing a 1 or 2 day spike on it to see how large of a task it is.
Beta Was this translation helpful? Give feedback.
All reactions