Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added remark about component libraries #154

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: added remark about component libraries #154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce5e7df
docs: added remark about component libraries
jclaessens97 Apr 19, 2022
0657075
docs: clarify remark
jclaessens97 Apr 19, 2022
da0083f
docs: fix spelling
jclaessens97 Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ Publish your plugin and all is done!
> })
> ```

### Remark

`Vue Demi` is mainly supposed to work with libraries/plugins that use the `@vue/composition-api` that are **not** components (e.g. `VueUse`, `Pinia`, ...). In other words, you need to be cautious to work with `Vue SFC` because the SFC compilation process and the results are different across `Vue 2` and `Vue 3`.

In order to build a component library/plugin for both `Vue2` and `Vue3` you could either publish plain `Vue` files or build your library separately for `Vue2` and `Vue3`. Both options can be tricky because there are a few differences in their runtime APIs.

### Extra APIs

`Vue Demi` provides extra APIs to help distinguish users' environments and to do some version-specific logic.
Expand Down