You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@digital-realty/ix-twlit

Package Overview
Dependencies
Maintainers
5
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@digital-realty/ix-twlit

Wrap tailwindcss in css`` for consumption by Lit


Version published
Weekly downloads
677
decreased by-10.09%
Maintainers
5
Created
Weekly downloads
 

Readme

Source

Overview

This package allows us to utilize TailwindCSS from within LitElement components.

We need to setup the TailwindCSS build process as normal (either via running npx tailwindcss or by configuring it as a PostCSS plugind). See the TailwindCSS site for detils on this.

Once you have tailwind setup to scan the LitElement for classes and produce a CSS file, TWLit then looks for changes to this file and then creates a JS file from it that can be imported to the Static Styles propert of you LitElement. This gives us a nice DX in that Tailwind classes added to your LitElement are automatically generated and can be used with no manual build step required.

This approach also means we use the constructable style sheets functionality that LitElement provides and as such the style sheet will not be duplicated if more than one of our LitElement components are present in the application.

This package has been customised to output to comma seperated paths and also have an optional watch. This is so you can easily hand it a TypeScript location as well as an out-tsc (typescript compiled) location.

The original package and a full working example of this in use can be found here: https://github.com/MarkJamesHoward/TWLitExampleUse

Usage

Run from the command line

npx twlit --input ./tw.css --output ./twlit.js

npx twlit --input ./tw.css --output ./twlit.ts,./out-tsc/twlit.js

Or add to your tooling chain in package.json

"scripts": { "dev" : "twlit --input ./tw.css --output ./twlit.js --watch" }

The process will constantly watch the input file and output a new JS file on each change.

Parameters

--input

Specify the location of your tailwind generated CSS file. In the above example this is the 'tw.css' file. This is the file spit out from running either npx tailwindcss or from your PostCSS setup of tailwind. Either way it contains all the class definitions that we need inside of our LitElement

--output

The output is a JS file that contains all the Tailwind classes within a tagged template literal. This can now be imported into your LitElement

--watch

Specify if you want to watch the input for changes and automatically recompile.

LitElement configuration:

We need to import the JS file that is spit out (from --output above)

import { TWStyles } from "./tailwind/twlit.js";

And then include this in the static Styles property of our LitElement:

static styles = [css``, TWStyles];

FAQs

Package last updated on 05 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc