vuejs / vuejs/docs

Proposal: More Information for Vue 3 Component Library Authors

Open
#1,748 3 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Web Components guide at https://vuejs.org/guide/extras/web-components.html#web-components-vs-vue-components and review the request for component-library guidance. Done means deciding and documenting recommendations for Vite settings, ES Modules versus CommonJS, component documentation, and publishing options.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, vite
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.