Skip to content

Proposal: More Information for Vue 3 Component Library Authors #1748

Open
@tderflinger

Description

@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. :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions