Prerequisites
Before starting the project make sure to install the following utilities:
Creating a new Solid application
Let's create a fresh Solid application so that we can go through all the steps together. We are going to do this through Vite - very popular and extremely light module bundler.
Step 1
Create new project.
npx degit solidjs/templates/js my-project
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/
├── src/
│ ├── assets/
│ ├── App.jsx
│ ├── App.module.css
│ ├── index.css
│ ├── index.jsx
│ └── ...
├── ...
├── index.html
├── jsconfig.json
├── 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: [
"./src/**/*.{js,jsx,ts,tsx}",
"./node_modules/tw-elements/js/**/*.js"
],
theme: {
extend: {},
},
darkMode: "class",
plugins: [require("tw-elements/plugin.cjs")]
}
Step 3
Include the @tailwind directives in your index.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.
import { onMount } from "solid-js";
import { Tooltip, initTWE } from "tw-elements";
const App = () => {
onMount(() => {
initTWE({ Tooltip });
});
return (
<>
<div className="mt-16 flex justify-center">
<p className="text-lg">
Hover the link to see the
<a
href="#"
className="text-primary ps-1 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>
</>
);
};
export default App;
Step 6
Start the app and see if everything's fine. Awesome! You're all set to dive into using TW Elements for your Solid 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.
import { onMount } from "solid-js";
import { Tooltip } from "tw-elements";
const App = () => {
onMount(() => {
const myTooltip = new Tooltip(document.getElementById("my-tooltip"));
});
return (
<>
<div className="mt-16 flex justify-center">
<p className="text-lg">
Hover the link to see the
<a
id="my-tooltip"
href="#"
className="text-primary ps-1 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>
</>
);
};
export default App;