npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pinegrow/tailwindcss-plugin

v3.0.32

Published

Pinegrow TailwindCSS Plugin

Downloads

539

Readme

Pinegrow TailwindCSS Plugin

npm version npm downloads License

Tailwind CSS plugin for Pinegrow ⚡️

Pinegrow TailwindCSS Plugin enables intellisense, visual control customization and theming in Pinegrow apps (currently only Pinegrow Web Editor & Vue Designer).

Note:

  • This plugin is generally used in conjunction with the Pinegrow Vite Plugin or with the meta-framework specific Pinegrow modules for Iles, Nuxt and Astro.
  • To use Tailwind CSS in Pinegrow apps, you require an active Tailwind Addon subscription.
  •  Learn more about Vue Designer

Features

  • 🎨  Visually live-design your Vite-powered tailwind apps (Vue, Nuxt, Iles, Astro, etc)
  • ⚙️  Smartly integrates into your Vite workflow in dev-mode only
  • ✨  Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️

Quick Setup

  1. Install: Add @pinegrow/tailwindcss-plugin to your project
# Using npm
npm install -D @pinegrow/tailwindcss-plugin

# Using pnpm
pnpm add -D @pinegrow/tailwindcss-plugin
  1. Configure: Add tailwindcss along with configPath and cssPath as options to liveDesigner in your config.
//vite.config.[js,ts]

export default defineConfig({
	plugins: [
		liveDesigner({
			// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
			//...
			tailwindcss: {
				/* PinegrowTailwindCSSModuleOptions (for more details, refer to Options section below) */
				/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
				configPath: 'tailwind.config.ts',
				cssPath: '@/assets/css/tailwind.css',
				// restartOnConfigUpdate: true,
				// restartOnThemeUpdate: true,
			},
		}),
		//...
	],
	//...
})
//nuxt.config.ts

export default defineNuxtConfig({
	modules: [
		'@pinegrow/nuxt-module',
		//...
	],
	pinegrow: {
		liveDesigner: {
			// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
			//...
			tailwindcss: {
				/* PinegrowTailwindCSSModuleOptions (for more details, refer to Options section below) */
				/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
				configPath: 'tailwind.config.ts',
				cssPath: '@/assets/css/tailwind.css',
				// restartOnConfigUpdate: true,
				// restartOnThemeUpdate: true,
			},
		},
	},
	//...
})
//iles.config.ts

import type { LiveDesignerOptions } from '@pinegrow/vite-plugin'
export default defineConfig({
  modules: [
    [
      '@pinegrow/iles-module',
      {
        liveDesigner: {
          // For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
          //...
          tailwindcss: {
            /* PinegrowTailwindCSSModuleOptions (for more details, refer to Options section below) */
            /* Please ensure that you update the filenames and paths to accurately match those used in your project. */
            configPath: 'tailwind.config.ts',
            cssPath: '@/assets/css/tailwind.css',
            // restartOnConfigUpdate: true,
            // restartOnThemeUpdate: true,
          },
        } as LiveDesignerOptions,
      },
    ],
    //...
  ],
  //...
})
//astro.config.[mjs]

import { defineConfig } from 'astro/config'
import vue from '@astrojs/vue'
import Pinegrow from '@pinegrow/astro-module'

export default defineConfig({
	integrations: [
		vue(),
		Pinegrow({
			liveDesigner: {
				// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
				//...
				tailwindcss: {
					/* PinegrowTailwindCSSModuleOptions (for more details, refer to Options section below) */
					/* Please ensure that you update the filenames and paths to accurately match those used in your project. */
					configPath: 'tailwind.config.ts',
					cssPath: '@/assets/css/tailwind.css',
					// restartOnConfigUpdate: true,
					// restartOnThemeUpdate: true,
				},
			},
		}),
		//...
	],
	//...
})
  1. Now, open your project in your Pinegrow app (currently only Vue Designer). ✨

  2. Theme Customization (optional) - Pinegrow Tailwind CSS addon enables easy theming based on colors, fonts and background images. Theme files are saved at the location specified by the themePath option (default: [src]/themes/pg-tailwindcss/tokens.[cjs,mjs]). To use the theme, follow the instructions in the Config Panel of your Pinegrow app (currently only Vue Designer) under @pinegrow/tailwindcss-plugin package.

Options

interface PinegrowTailwindCSSModuleOptions {
	/**
	 * Absolute or relative path of the tailwind configuration file.
	 */
	configPath: string | any

	/**
	 * Absolute or relative path of the tailwind entry css file.
	 */
	cssPath?: string | any

	/**
	 * Absolute or relative path of the tailwind theme file.
	 * @default 'src/themes/pg-tailwindcss/tokens.[cjs,mjs]'
	 * @default 'themes/pg-tailwindcss/tokens.[cjs,mjs]' // Nuxt
	 * Set to false to turn off theming via Design Panel
	 */
	themePath?: string | boolean

	/**
	 * Restart on tailwind config file updates
	 * @default false
	 */
	restartOnConfigUpdate?: boolean

	/**
	 * Restart on tailwind theme file updates
	 * @default false
	 */
	restartOnThemeUpdate?: boolean
}

interface PinegrowTailwindCSSModule {
	/**
	 * Pinegrow TailwindCSS Module Options, added within liveDesigner in vite/nuxt/iles/astro config files
	 */
	tailwindcss: PinegrowTailwindCSSModuleOptions
}

interface PinegrowTailwindCSSPluginOptions {
	colors?: {
		[key in string]?: any
	}
	fonts?: {
		[key in string]?: string[]
	}
	backgrounds?: {
		'design-image': string
		'design-image-large': string
	}
}

interface PinegrowTailwindCSSPlugin {
	/**
	 * Pinegrow TailwindCSS Plugin Options, added to the plugins array in tailwind config file
	 */
	default: PinegrowTailwindCSSPluginOptions
}

License

MIT License

Copyright (c) Pinegrow