Install Preline UI with Vue.js using Tailwind CSS

1. Install Preline UI

   Install Preline using your preferred package manager.

                       
                         npm install preline
                       
                     

   Please note, Preline UI uses Tailwind CSS Forms plugin in all form components. Don't forget to install it, if you haven't done so already: npm install -D @tailwindcss/forms

2. Include Preline CSS

   Include Preline in your projects_root_directory/src/assets/main.css file.

                       
                         @import "tailwindcss";
                         
                         @import "preline/variants.css";
                         @source "../../node_modules/preline/dist/*.js";
   
                         /* Optional Preline UI Datepicker Plugin */
                         /* @import "preline/src/plugins/datepicker/styles.css"; */
   
                         /* Third-party plugins */
                         /* @plugin "@tailwindcss/forms"; */
                       
                     

3. Add type definitions for Preline

   Create the global.d.ts file in the project root directory, e.g. projects_root_directory/src/global.d.ts

                       
                         import type { IStaticMethods } from "preline/dist";
   
                         declare global {
                           interface Window {
                             // Optional third-party libraries
                             _;
                             $: typeof import("jquery");
                             jQuery: typeof import("jquery");
                             DataTable;
                             Dropzone;
                             VanillaCalendarPro;
   
                             // Preline UI
                             HSStaticMethods: IStaticMethods;
                           }
                         }
   
                         export {};
                       
                     

4. Add the Preline UI JavaScript

   Add the Preline UI JavaScript in your app entry point projects_root_directory/src/main.ts

                       
                         ...
   
                         // Optional third-party libraries
                         import $ from "jquery";
                         import _ from "lodash";
                         import noUiSlider from "nouislider";
                         import "datatables.net";
                         import "dropzone/dist/dropzone-min.js";
                         import * as VanillaCalendarPro from "vanilla-calendar-pro";
   
                         window._ = _;
                         window.$ = $;
                         window.jQuery = $;
                         window.DataTable = $.fn.dataTable;
                         window.noUiSlider = noUiSlider;
                         window.VanillaCalendarPro = VanillaCalendarPro;
   
                         ...
   
                         app.mount("#app");
   
                         // Preline UI
                         import("preline/dist/index.js");
                       
                     

5. Add a reinitialization helper (vue-router)

   Add code that reinitializes the components every time the page is refreshed to your "route" projects_root_directory/src/router/index.ts

                         
                           import { createRouter, createWebHistory } from "vue-router";
   
                           import HomeView from "../views/HomeView.vue";
   
                           const router = createRouter({
                             ...
                             routes: [
                               {
                                 path: "/",
                                 name: "home",
                                 component: HomeView,
                               },
                               ...
                             ],
                           });
   
                           router.afterEach(async (to, from, failure) => {
                             if (!failure) setTimeout(() => window.HSStaticMethods.autoInit(), 100);
                           });
   
                           export default router;
                         
                       

6. Add a reinitialization helper (without router)

   Add code that reinitializes the components every time when app is mounted projects_root_directory/src/App.vue

                         
                           onMounted(() => {
                             setTimeout(() => window.HSStaticMethods.autoInit(), 100)
                           });
                         
                       

Optional Preline UI Styles

                  
                    /* Adds pointer cursor to buttons */
                    @layer base {
                      button:not(:disabled),
                      [role="button"]:not(:disabled) {
                        cursor: pointer;
                      }
                    }

                    /* Defaults hover styles on all devices */
                    @custom-variant hover (&:hover);
                  
                

Community Workarounds

Check out this section for community-shared tips and tricks. It's a spot for finding those handy hacks and solutions that enhance your experience with Preline UI.