Installation
Setting up Preline UI in a Solid.js project using Tailwind CSS.
Please note that the plugin has been tested with the 1.9.5
version of the framework. The framework was installed using the standard npx degit solidjs/templates/ts <project-name>
command.
If you are using your own project structure or a different version, pay attention to the file paths and features of your version!
Simple and performant reactivity for building user interfaces. If you haven't set up Tailwind CSS yet, check out Solid.js Tailwind CSS installation guides.
Some components require third-party libraries. The settings below assume full use of Preline UI
, including preloaded dependencies. If you do not intend to use those components that rely on third-party libraries, you may exclude them from your configuration.
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
Include Preline in your index.css
file, e.g. projects_root_directory/src/index.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"; */
Create the global.d.ts
file in the project root directory, e.g.
projects_root_directory/src/global.d.ts
import type noUiSlider from "nouislider";
import type { IStaticMethods } from "preline/dist";
declare global {
interface Window {
// Optional third-party libraries
_: typeof import("lodash");
$: typeof import("jquery");
jQuery: typeof import("jquery");
DataTable: typeof $.fn.dataTable;
Dropzone: typeof import("dropzone");
noUiSlider: typeof noUiSlider;
VanillaCalendarPro: typeof import("vanilla-calendar-pro");
// Preline UI
HSStaticMethods: IStaticMethods;
}
}
export {};
Add the Preline UI JavaScript in your app entry point projects_root_directory/src/index.tsx
...
// 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;
const root = document.getElementById('root');
...
// Preline UI
import("preline/dist").then(() => {
render(() => <App />, root!);
});
Add code that reinitializes the components every time when app is mounted or page was changed projects_root_directory/src/App.tsx
import { createSignal, createEffect } from 'solid-js';
import type { Component } from 'solid-js';
import { useLocation } from '@solidjs/router';
...
const App: Component = () => {
const location = useLocation();
const [_, setLoc] = createSignal(location.pathname);
createEffect(() => {
setLoc(location.pathname);
window.HSStaticMethods.autoInit();
});
return (
...
);
};
export default App;
Please note, Preline UI comes with some opinionated styles that are applied to components by default. If you want these styles in your project, you may include them into your CSS file. These styles used to come by default in Tailwind v3, so we decided to keep them in Preline UI.
/* 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);