Prerequisites
Before starting the project make sure to install the following utilities:
Creating a new Svelte application
Let's create a fresh Svelte application so that we can go through all the steps together. We are going to do this throughVite - very popular and extremly light module bundler.
Step 1
Create new project.
npm create vite@latest my-project -- --template svelte cd my-project npm installStep 2
Run the development server.
npm run devInstalling and configuring Tailwind CSS and TW Elements
Step 1
Install Tailwind CSS.
npm install -D tailwindcss postcss autoprefixer npx tailwindcss init -pFile structure
If you have followed all instructions mentioned earlier, your file structure should look like this:
my-project/ ├── node_modules/ ├── public/ ├── src/ │ ├── assets/ │ ├── lib/ │ ├── app.css │ ├── App.svelte │ ├── main.js │ └── vite-env.d.ts ├── .gitignore ├── index.html ├── jsconfig.json ├── package-lock.json ├── package.json ├── postcss.config.js ├── README.md ├── svelte.config.js └── tailwind.config.jsStep 2
Add the paths to all of your template files in yourtailwind.config.js file.
/** @type {import('tailwindcss').Config} */ module.exports = { content: [ "./src/**/*.{html,js,svelte,ts}", "./node_modules/tw-elements/js/**/*.js", ], theme: { extend: {}, }, darkMode: "class", plugins: [require("tw-elements/plugin.cjs")], };Step 3
Add the@tailwind directives toapp.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-elementsStep 5
Import components which are you intend to use and necessary functioninitTWE. InitializeinitTWE in a lifecycle method.
<script> import { onMount } from "svelte"; import { Tooltip, initTWE } from "tw-elements"; onMount(() => { initTWE({ Tooltip }); }); </script> <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>Step 6
Start the app and see if everything's fine. Awesome! You're all set to dive into using TW Elements for your Svelte project. Have fun!
npm run devInitializing 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 library and initialize components in lifecycle method.
<script> import { onMount } from "svelte"; import { Tooltip } from "tw-elements"; onMount(() => { const myTooltip = new Tooltip(document.getElementById("my-tooltip")); }); </script> <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>Troubleshooting
Problem overview:
Users might face difficulties with improper functioning of components in some frameworks for TW Elements. This is due to the fact that some of them aren't initializing properly.
Suggested solution:
Consider importingtw-elements package dynamically. By doing it, you can enhance the initialization process, potentially resolving any issues related to component functionality. Additionally, ensure that theinitTWE() method is called in the correct sequence and with the appropriate parameters, facilitating a smoother experience with TWE components.
onMount(async () => { const { Tooltip, initTWE } = await import("tw-elements");; initTWE({ Tooltip }); });