Giter Club home page Giter Club logo

vue-lib-scaffold's Introduction

Scaffolding for Vue 3 Library

This is a simple scaffold for a Vue 3 library. It uses Vite for building. You can use this as a starting point for your own library.

Usage

yarn
yarn dev

Customize the library name

  1. Change the name in package.json
  2. Change the name in vite.config.js
  3. Change the name in src/lib.ts
  4. Change the import in src/main.ts to match the name in src/lib.ts, used for demo purpose. (src/Demo.vue)
  5. Have fun!

Note

Currently Vue 3 lib mode does not support CSS injection, so the built library will separate the CSS file.

Publishing (Updating...)

This will build the library and place it in the dist folder. You can then publish this folder to npm.

yarn build

Then publish the dist folder to npm.

Using the library

yarn add <your-library-name>
// main.js
// Import library styles
import 'your-library-name/dist/style.css';
// Global import - Contains all components
// main.js
import YourLibraryName from 'your-library-name';
createApp(App).use(YourLibraryName).mount('#app');

// OR Individual component import
// Component.vue
import { YourComponentName } from 'your-library-name';

Testing

Currently I'm not applying any testing. All contributions are welcome.

vue-lib-scaffold's People

Contributors

juzser avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.