starter-vue-webcomponent-uno - GitLite

KO | EN

gitlite — search

#javascript #python #golang #android #machine-learning #rust #deep-learning #linux #nodejs #windows #awesome #kubernetes #pytorch #mcp

starter-vue-webcomponent-uno

(★ 113)

Starter for creating agnostic WebComponents using Vue and UnoCSS

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
  - release.yml
- FUNDING.yml
- extensions.json
- settings.json
- - main.ts
  - override-style.css
- index.html
- package.json
- vite.config.ts
- build-css.ts
- - css.ts
- - MyCounter.ts
  - MyCounter.vue
- index.ts
- shims.d.ts
- style.css
- exports.test.ts
- index.test.ts
.gitignore
CONTRIBUTING.md
eslint.config.js
LICENSE.md
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
tsconfig.json
tsdown.config.ts
uno.config.ts
vitest.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/antfu/starter-vue-webcomponent-uno

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd starter-vue-webcomponent-uno

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# starter-vue-webcomponent-uno

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

Starter for creating agnostic WebComponents using Vue and UnoCSS

## Motivations

Sometimes when you want to build some embed UI for websites/apps you might not have control with.

For example, injected UI in web browser extensions, or dev tool UI etc. In those cases, styling can be a headache, because the CSS selectors are applying to the whole page and inferrance might occur.

We have nice tools like Vue's Scoped CSS, or native Nested CSS, but they only prevent the styles from leaking out, but can't prevent users styles from sneaking in. Some workarounds like rasing the specificity by using more selectors, or applying `!important` to every rules. However, those workarounds make it a lot harder to work with but still no guarantee to always work.

Shadow DOM is the only solution for the true style isolation, while the bare API is not very friendly work with.

We as developers, surely we want to use the stack that works the best to us. In my case, it's Vue for logic and UnoCSS for style. Unlike plain JavaScript you can directly bundle into a library, using Vue SFC and UnoCSS to build an agnostic library can be a bit tricky to set up.

That's why I created this starter, to help you quickly build an agnostic library using the tools with the best developer experience.

## Target Scenarios

- Embed/Injected UI
- A single or a few root components
- Could be shipped as a module entry or a library

### Non-targets

- Full-page UI
- SSR
- UI libraries

## How it works

- Custom script [`scripts/build-css.ts`](./scripts/build-css.ts) to generate the CSS tokens with UnoCSS.
- [`unplugin-vue`](https://github.com/unplugin/unplugin-vue) to bundle the Vue components into JavaScript.
- [`tsdown`](https://github.com/unjs/tsdown) to build the library (can be any build tool that supported by unplugin).
- Use [`defineCustomElement`](https://vuejs.org/api/custom-elements.html#definecustomelement) to define the WebComponents.

## Sponsors

<p align="center">
  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
  </a>
</p>

## License

[MIT](./LICENSE) License © [Anthony Fu](https://github.com/antfu)

[npm-version-src]: https://img.shields.io/npm/v/starter-vue-webcomponent-uno?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/starter-vue-webcomponent-uno
[npm-downloads-src]: https://img.shields.io/npm/dm/starter-vue-webcomponent-uno?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/starter-vue-webcomponent-uno
[bundle-src]: https://img.shields.io/bundlephobia/minzip/starter-vue-webcomponent-uno?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=starter-vue-webcomponent-uno
[license-src]: https://img.shields.io/github/license/antfu/starter-vue-webcomponent-uno.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/antfu/starter-vue-webcomponent-uno/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/starter-vue-webcomponent-uno