ShipBit/svane

Svane - Your flag in the Tailwind

Svane is a simple Svelte component that allows you to see the Tailwind viewport / breakpoint you are currently in and the "distance" to the next viewport (as progress percentage). It is displayed as a fixed bar at the top or bottom of the screen, overlaying your content.

Svane reads the Tailwind config file of your project and automatically displays the breakpoints you have defined there. Note that currently only screen configs in the format tablet: '640px' (using min-width) are supported, see Tailwind docs.

By default, the Svane bar is shown initially after reloading the page and whenever you resize the browser window. It will then vanish after a short delay automatically. Force to show it by pressing "Shift + T" on your keyboard. If you do press the shortcut, Svane will stay open until you press it again.

You can either install Svane as dependecy using the package manager of your choice or just copy&paste the Svane.svelte file into your project. There are no third-party dependencies apart from Tailwind itself, so it's that simple!

Migration v1 -> v2

The old breakpoints property was removed because it's now read from your tailwind.config.js file. See the Installation section below for more details.

Installation

npm install -D @shipbit/svane

Now you have to include the Tailwind config in your vite.config.js file so that Svane can read it:

import path from 'path';
import { sveltekit } from '@sveltejs/kit/vite';
import { defineConfig } from 'vite';

export default defineConfig({
 optimizeDeps: {
  include: ['tailwind-config'],
  force: true // force to refresh the config file on change in DEV mode
 },
 plugins: [sveltekit()],
 resolve: {
  alias: {
   '@': path.resolve(__dirname, './src'),
   'tailwind-config': path.resolve(__dirname, './tailwind.config.js')
  }
 }
});

Important: If you change the screens in your tailwind.config.js file, you have to restart the dev server!

Then in your +layout.svelte or any other page/component:

<script>
 import { Svane } from '@shipbit/svane';
 import { browser } from '$app/environment'; // in case you're using SSR
</script>

{#if import.meta.env.DEV && browser}
 <Svane />
{/if}

Lastly, tell your app to generate Tailwind classes for Svane in tailwind.config.js:

/** @type {import('tailwindcss').Config} */
export default {
 content: [
  './src/**/*.{html,js,svelte,ts}', // your app's files
  './node_modules/@shipbit/svane/**/*.{html,js,svelte}' // add Svane here or it will look unstyled
 ] // ...
};

Parameters (all optional)

<!-- Don't autohide Svane -->
<Svane stayOpen />

<!-- default: 'top' -->
<Svane position="bottom" />

<!-- hide Svane after the given milliseconds have passed (default: 2500) -->
<Svane duration={5000} />

You can mix and match these params, of course.