THEOplayer / web-ui

UI component library for the THEOplayer Web SDK
https://www.theoplayer.com/docs/open-video-ui/web/
MIT License
10 stars 0 forks source link

API documentation #3

Closed MattiasBuelens closed 1 year ago

MattiasBuelens commented 1 year ago

Add some initial API documentation to all components. In the future, we'll want to publish these docs along with the package (probably in the type definitions), as well as on a documentation website.

The JSDoc for the custom elements uses extra tags defined by custom elements manifest (such as @attribute and @slot). (In the future, we intend to publish a custom-elements.json file along with the package.)