vuejs / vuejs/docs

Document how to use plugins in the Web Component guide

Open
#3,151 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Guide: https://vuejs.org/guide/extras/web-components.html

In short, it would be great to add information here about how to use Vue plugins when building Web Components.

It was a headache to figure this out and I ended up going with an external dependency vue-web-component-wrapper.

It would be nice if the guide mentioned this dependency or even provided a way to use plugins without a dependency.

I wrote about this and more on my blog: https://blog.rayberger.org/vue-3-web-components-open-library

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

Read the Web Component guide at guide/extras/web-components.html and the linked blog post first. Document how Vue plugins can be used when building Web Components, including the vue-web-component-wrapper dependency or a supported dependency-free approach. Done means the guide explains the available approach clearly enough for readers to follow it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.