Proposal: More Information for Vue 3 Component Library Authors

[tderflinger]

Hi Vue Docs Team,

I really like your new Vue 3 documentation website, well done :)

As an author of an open source Vue 3 component library I found it a bit hard to find information on the recommended way and best practices to create and publish an open source Vue 3 web component library.

With Vue 3 web component library I mean an encapsulated component that contains a UI and some JS logic and has a well-defined API using props. The component library is meant for consumption by third-party applications that integrate the component in their Vue (or even non-Vue) web application so that they can reuse the functionality.

Some information I found here on Web Components: https://vuejs.org/guide/extras/web-components.html#web-components-vs-vue-components

But then, what is the best practice to create and publish a Vue 3 component library? Should I use Vite, with what settings (ES Modules vs. CommonJS) and what is the recommended way to create documentation of the component (e.g. using VuePress). Also, what are some good ways to publish (only via NPM?) and market Vue component libraries?

Would be nice to see some more information in this regard. :)

[skirtles-code]

Related: #965, #1060.

[Barbapapazes]

Hey, I publish a complete guide on my website: https://soubiran.dev/series/the-complete-guide-to-building-a-vue-js-component-library

[RayBB]

I wrote a blog post about migrating Vue 2 -> 3 with Web Components and Vite.
It was a challenge and there are some suggestions for improvements at the end including updating the docs for such.
We're not exactly library authors but it would still be helpful to have better docs.
https://blog.rayberger.org/vue-3-web-components-open-library