Install Preline UI with Astro using Tailwind CSS

Install Preline UI with Tailwind CSS in Astro projects, including JavaScript plugin setup, Astro integration, app styles, and optional dependencies.

Installation

Please note that the plugin has been tested with the 6.0.2 version of the framework. The framework was installed using the standard npm create astro@latest command.
If you are using your own project structure or a different version, pay attention to the file paths and features of your version!

Astro quick setup

If Tailwind CSS is not set up yet, start with the official Astro + Tailwind CSS guide first.

Some components rely on third-party libraries. The setup below assumes full Preline UI usage with those dependencies preloaded. If you do not plan to use those components, you can remove the related libraries from your configuration.

Install Preline UI

Install preline with your preferred package manager.

Terminal

                          
                            npm install preline

Preline UI uses the Tailwind CSS Forms plugin across form components. Install it if you have not already: npm install -D @tailwindcss/forms

Include Preline CSS

Import Preline into projects_root_directory/src/styles/global.css.

global.css

                          
                            @import "tailwindcss";

                            @import "preline/variants.css";
                            @source "../../node_modules/preline/dist/*.js";

                            /* Optional Preline UI Datepicker Plugin */
                            /* @import "preline/src/plugins/datepicker/styles.css"; */

                            /* Plugins */
                            /* @plugin "@tailwindcss/forms"; */

                            /* Preline Themes */
                            @import "preline/css/themes/theme.css";

See the Theme docs to learn more about Preline Themes.

Add type definitions for Preline

Create a global.d.ts file for the shared window typings, for example projects_root_directory/global.d.ts.

global.d.ts

                          
                            import type { JQueryStatic } from 'jquery';
                            import type _ from 'lodash';
                            import type Dropzone from 'dropzone';
                            import type noUiSlider from 'nouislider';
                            import type DataTables from 'datatables.net';
                            import type { Calendar } from 'vanilla-calendar-pro';

                            declare global {
                              interface Window {
                                $: JQueryStatic
                                jQuery: JQueryStatic
                                _: typeof _
                                Dropzone: typeof Dropzone
                                noUiSlider: typeof noUiSlider
                                DataTable: typeof DataTables
                                VanillaCalendarPro: typeof Calendar
                                HSStaticMethods?: {
                                  autoInit: (collection?: string[]) => void
                                }
                              }
                            };

                            export {};

Create a Preline UI loader

Create a script that registers the required external libraries and initializes Preline UI in projects_root_directory/src/scripts/preline.ts.

preline.ts

                          
                            import $ from 'jquery';
                            import _ from 'lodash';
                            import Dropzone from 'dropzone';
                            import noUiSlider from 'nouislider';

                            window.$ = $;
                            window.jQuery = $;
                            window._ = _;
                            window.Dropzone = Dropzone;
                            window.noUiSlider = noUiSlider;

                            async function initPreline() {
                              try {
                                const dtModule = await import('datatables.net');
                                window.DataTable = dtModule.default ?? dtModule;

                                const vcModule = await import('vanilla-calendar-pro');
                                window.VanillaCalendarPro = vcModule.Calendar ?? vcModule.default ?? vcModule;

                                await import('preline');
                                window.HSStaticMethods?.autoInit();
                              } catch (e) {
                                console.warn('[preline] initialization error:', e);
                              }
                            }

                            if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', initPreline);
                            else initPreline();

                            document.addEventListener('astro:page-load', initPreline);

Load the Preline UI loader

Import the loader in projects_root_directory/src/layouts/Layout.astro so Preline UI initializes with the layout.
--- import "../styles/global.css"; --- <!doctype html> <html lang="en"> ... <body> ... <slot /> </body>  <script> import '../scripts/preline.ts'; </script> </html>
Layout.astro
```
                          
                        
```

Optional Preline UI styles

Preline UI ships with a small set of opinionated base styles. If you want them in your project, add them to your CSS file. These defaults used to come bundled with Tailwind CSS v3, so they are still available as an optional layer in Preline UI.

CSS

                        
                          /* 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

Explore community-shared fixes, examples, and integration tips for edge cases that come up while using Preline UI.

Build process workaround for Astro projects

Issue #61 by @krankos