Prerequisites
Before starting the project make sure to install the following utilities:
Vue TW Elements:
Currently we are working on a standalone Vue version of TW elements. If
you want to know when it is going to be released, sign in in our
waiting list available here.
Creating a new Vue application
Let's create a fresh Vue application so that we can go through all the steps together. We are going to do this through Vite - very popular and extremly light module bundler.
Step 1
Create new project
npm create vite@latest my-project -- --template vue
cd my-project
npm install
Step 2
Run the development server.
npm run dev
Installing and configuring Tailwind CSS and TW Elements
Step 1
Install Tailwind CSS.
npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init -p
File structure
If you have followed all instructions mentioned earlier, your file structure should look like this:
my-project/
├── node_modules/
├── public/
├── src/
│ ├── assets/
│ ├── components/
│ ├── App.vue
│ ├── main.js
│ └── style.css
├── .gitignore
├── index.html
├── package-lock.json
├── package.json
├── postcss.config.js
├── README.md
├── tailwind.config.js
└── vite.config.js
Step 2
Add the paths to all of your template files in your
tailwind.config.js file.
/** @type {import('tailwindcss').Config} */
module.exports = {
content: [
"./index.html",
"./src/**/*.{vue,js,ts,jsx,tsx}",
"./node_modules/tw-elements/js/**/*.js"
],
theme: {
extend: {},
},
darkMode: "class",
plugins: [require("tw-elements/plugin.cjs")]
}
Step 3
Add the @tailwind directives to your
style.css file.
@import url("https://fonts.googleapis.com/css?family=Roboto:300,400,500,700,900&display=swap");
@tailwind base;
@layer base {
html {
@apply text-surface;
@apply bg-white;
}
html.dark {
@apply text-neutral-50;
@apply bg-body-dark;
}
}
@tailwind components;
@tailwind utilities;
p {
@apply leading-[1.6];
}
Step 4
Install TW Elements.
npm install tw-elements
Step 5
Import components which are you intend to use and necessary function
initTWE. Initialize initTWE in a lifecycle method.
<script setup>
import { onMounted } from "vue";
import { Tooltip, initTWE } from "tw-elements";
onMounted(() => {
initTWE({ Tooltip });
});
</script>
<template>
<div class="mt-16 flex justify-center">
<p class="text-lg">
Hover the link to see the
<a
href="#"
class="text-primary transition duration-150 ease-in-out hover:text-primary-600 focus:text-primary-600 active:text-primary-700 dark:text-primary-400 dark:hover:text-primary-500 dark:focus:text-primary-500 dark:active:text-primary-600"
data-twe-toggle="tooltip"
title="Hi! I'm tooltip"
>tooltip</a
>
</p>
</div>
</template>
Step 6
Start the app and see if everything's fine. Awesome! You're all set to dive into using TW Elements for your Vue project. Have fun!
npm run dev
Initializing via JS
By default all components have autoinit which means they are initialized by data attributes. But if you want to make init by JavaScript - there is also possibility to do that.
Step 1
Import components which are you intend to use and initialize them in lifecycle hook.
<script setup>
import { onMounted } from "vue";
import { Tooltip } from "tw-elements";
onMounted(() => {
const myTooltip = new Tooltip(document.getElementById("my-tooltip"));
});
</script>
<template>
<div class="mt-16 flex justify-center">
<p class="text-lg">
Hover the link to see the
<a
id="my-tooltip"
href="#"
class="text-primary transition duration-150 ease-in-out hover:text-primary-600 focus:text-primary-600 active:text-primary-700 dark:text-primary-400 dark:hover:text-primary-500 dark:focus:text-primary-500 dark:active:text-primary-600"
title="Hi! I'm tooltip">
tooltip
</a>
</p>
</div>
</template>