https://github.com/fumeapp/tailvue

Vue components built for Nuxt3|Vue3 powered by Windi CSS|tailwindcss
https://github.com/fumeapp/tailvue

nuxt3 tailwindcss vite vitejs vue3 windicss

Last synced: about 23 hours ago
JSON representation

Vue components built for Nuxt3|Vue3 powered by Windi CSS|tailwindcss

• Host: GitHub
• URL: https://github.com/fumeapp/tailvue
• Owner: fumeapp
• Created: 2021-11-12T02:56:45.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T13:01:51.000Z (9 months ago)
• Last Synced: 2024-12-15T01:07:04.725Z (8 days ago)
• Topics: nuxt3, tailwindcss, vite, vitejs, vue3, windicss
• Language: Vue
• Homepage:
• Size: 1.69 MB
• Stars: 157
• Watchers: 4
• Forks: 14
• Open Issues: 17
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        


  

  


  Vue components built for Vue3 powered by Uno CSS or tailwindcss



## 🚀 Features

- 🌔 All components and classes include dark-mode support

- 🔌 Programmatic toasts



  



```ts

$toast.show('this is a test');

```



  



```ts

$toast.show({

  type: 'danger',

  message: 'single action toast',

  timeout: 6,

  primary: {

    label: 'UNDO',

    action: () => $toast.show('you clicked UNDO')

  }

})

```

- 🔌 Programmatic modals



  



```ts

$modal.show({

  type: 'danger',

  title: 'This is the title property',

  body: 'This is the body property.',

  primary: {

    label: 'Primary Action',

    theme: 'red',

    action: () => $toast.show('Primary Button clicked'),

  },

  secondary: {

    label: 'Secondary Action',

    theme: 'white',

    action: () => $toast.show('Clicked Secondary'),

  },

})

```

- 🎪 Interactive playground! - just run `yarn; yarn dev`



  



- ✨ Tons of other components that will be documented shortly!

## Installation

### NuxtJS v3

```bash

yarn add --dev @tailvue/nuxt

```

* Add this to your `nuxt.config.ts`

```ts

modules: [

    // ...

    '@tailvue/nuxt',

],

```

> **Note**

> If you are using Nuxt 2 you may need to put this in of the `buildModules` array

### Vue3

```bash

yarn add tailvue

```

```ts

import { useToast, useModal } from 'tailvue'

const $toast = useToast()

const $modal = useModal()

```

### Icons

* All Icons are brought in via the [Iconify Vue Component](https://docs.iconify.design/icon-components/vue/)

```bash

yarn add --dev @iconify/vue

```

### UnoCSS

* Install [UnoCSS](https://unocss.dev/)

* No include is needed for uno, we have added @unocss/include to our generated files

### tailwindcss

* Install [tailwindcss](https://tailwindcss.com/)

* Add the following to your `tailwind.config.js`

```js

module.exports = {

  content: [

    ...

      "node_modules/tailvue/dist/tailvue.es.js",

  ],

}

```