https://github.com/soulsam480/shoyify

A Vue 3 component Library implementing shoyo (WIP)
https://github.com/soulsam480/shoyify

Last synced: about 2 months ago
JSON representation

A Vue 3 component Library implementing shoyo (WIP)

• Host: GitHub
• URL: https://github.com/soulsam480/shoyify
• Owner: soulsam480
• License: mit
• Created: 2020-11-25T17:31:32.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-14T18:49:05.000Z (almost 4 years ago)
• Last Synced: 2024-04-26T12:42:06.618Z (8 months ago)
• Language: TypeScript
• Homepage: https://shoyify.sambitsahoo.com
• Size: 1.37 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## shoyify

A `vue 3 component library` implementing [`shoyo`](https://shoyo.sambitsahoo.com).

Not  a serious project. Learning How component libraries work and how to create one.

### Usage

shoyify will be released on npm after basic components are added. To test right now

```

git clone https://github.com/soulsam480/shoyify

```

In your Vue 3 Project

- Import whole library as a Vue 3 plugin without tree shaking

```javascript

import shoyify from "../../shoyify";

const app = createApp()

// Tell Vue to use shoyify as a plugin

app.use(shoyify);

app.mount('#app)

```

- Import Individual components a Vue 3 plugin with `tree shaking `

```javascript

import {ShoyoButton} from "../../shoyify";

const app = createApp()

// Tell Vue to use the component as a plugin

app.use(ShoyoButton);

app.mount('#app)

```

- Import individual components directly inside`.vue` files

```javascript

import { ShoyoButton } from "../../shoyify";

import { defineComponent, ref } from "vue";

export default defineComponent({

  components: {

    ShoyoButton,

  },

  setup() {

    const main = ref<string>("Button");

    return { main };

  },

});

```

### Roadmap

- [X] Export Global Plugin

- [X] Add tree Shaking to  Individual components

- [X] Add typescript types

- [X] Add props typings `see issue #1`

- [ ] Add basic components

- [ ] More todos......

Inspired from [Shubhadip/vue3-component-library](https://github.com/shubhadip/vue3-component-library) and [Vue Tailwind](vue-tailwind.com)