README.md

Svelte 4.2 + Storybook 8 + TailwindCSS 3

Visit the website to see the outcome: Svelte + Storybook + TailwindCSS

// Quickstart

npx degit jerriclynsjohn/svelte-storybook-tailwind my-svelte-project
cd my-svelte-project

pnpm install
pnpm run dev
pnpm run storybook

This has improved a lot since I started this repo, but I feel that there is still a need to just clone the repo and kickstart the project, so here I am again updating this and I'll keep this repo updated. I also feel that there is a need for a repo which shows some best practices.

You can easily start your project with this template, instead of wasting time figuring out configurations for each integration.

Storybook is an open source tool for developing JavaScript UI components in isolation

Svelte is a component framework that allows you to write highly-efficient, imperative code, that surgically updates the DOM to maintain performance.

TailwindCSS is a highly customizable, low-level CSS framework that gives you all of the building blocks you need to build bespoke designs without any annoying opinionated styles you have to fight to override.

Steps to build

Instantiate Svelte + Vite app

• Initiate the project using pnpm create vite@latest
• Select Svelte + Javascript from the CLI
• You have a basic Svelte + Vite app ready

Add Tailwind to the project

• Install dependencies pnpm install -D tailwindcss postcss autoprefixer
• Instantiate the tailwind and postcss config files using npx tailwindcss init -p
• Update the tailwind config as shown below to accomodate for Svelte components

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: ['./index.html', './src/**/*.{svelte,js,ts}'],
  theme: {
    extend: {}
  },
  plugins: []
};
``;

• Add Tailwind directive to your CSS at ./src/app.css

@tailwind base;
@tailwind components;
@tailwind utilities;

• Import CSS into ./src/main.ts

import './app.css';
import App from './App.svelte';

const app = new App({
  target: document.getElementById('app')
});

export default app;

• With this we have tailwind setup in the project

Add storybook and native story format into the project

• Instantiate by running pnpm dlx storybook@latest init
• Hook up TailwindCSS by importing the CSS into ./.storybook/preview.ts

import type { Preview } from '@storybook/svelte';
import '../src/app.css';

const preview: Preview = {
  parameters: {
    controls: {
      matchers: {
        color: /(background|color)$/i,
        date: /Date$/i
      }
    }
  }
};

export default preview;

• This completes the setup required for the project

Best Practices for UI Component Library

• Watchout for this space for more, will be updatin with some good best practises till then do feel free to explore the example UI components used for this website.