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

nuxt3-tailwind-breakpoints

v1.1.1

Published

Show Tailwind CSS Breakpoints in Nuxt 3

Downloads

205

Readme

Nuxt Tailwind Breakpoints

npm version npm downloads License Nuxt

Show Tailwind CSS Breakpoints in your Nuxt 3 app.

Features

This module reads the defined breakpoints within your tailwind config and showing the currently active breakpoint based on your browser window width.

It will only be loaded in development mode and does not interfere with your production build (unless you set enableInProd to true).

Note: This project started as a fork of the nuxt-breaky module and now is compatible with Nuxt 3. It should look and act pretty much the same as the original. Minor changes include removing the node-sass dependency to make the module usable with node.js >= 16 and adding a landmark aria-role attribute to the div.current-breakpoint element.

Quick Setup

  1. Add nuxt3-tailwind-breakpoints dependency to your project

    # Using yarn
    yarn add --dev nuxt3-tailwind-breakpoints
    
    # Using npm
    npm install --save-dev nuxt3-tailwind-breakpoints
    
    # Using pnpm
    pnpm add -D nuxt3-tailwind-breakpoints
  2. Add nuxt3-tailwind-breakpoints to the modules section of nuxt.config.ts

    export default defineNuxtConfig({
      modules: [
        'nuxt3-tailwind-breakpoints'
      ]
    })

Configuration

In nuxt.config.ts, you can pass options to nuxt3-tailwind-breakpoints by adding a top-level tailwindBreakpoints object:

{
  modules: [
    'nuxt3-tailwind-breakpoints',
  ],
  tailwindBreakpoints: {
    /* module options */
  }
}

Or, instead of registering the module as a string value, you can use an array with the first argument the name and the second the options:

{
  modules: [
    ['nuxt3-tailwind-breakpoints', { /* module options */ }]
  ],
}

Options

| Option | Type | Default | Options | Description | | -------------- | --------- | ------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enabled | Boolean | true | true | false | Enable/Disable the module | | enableInProd | Boolean | false | true | false | Enable this module in production (overrides the enabled option; Please be aware this adds ~19.5KB (~3.5KB) to the client bundle size. More Info) | | breakpoints | Object | undefined | | An object representing all the breakpoints you'd like to identify in your configuration. If provided, it is used instead of screens from tailwind config | | configPath | String | '~~/tailwind.config.js' | any valid path pointing to the file | Path to the TailwindCSS config file | | colorScheme | String | auto | 'auto' | 'light' | 'dark' | Switch between different color schemes | | position | String | 'bottomRight' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | The starting position | | offset | Object | {x: 10, y: 10} | | The number of pixels from a corner of the screen (as determined by position) along the x and y axes. Values for x and y must be numeric. | | parseRaw | Boolean | false | true | false | (Experimental) Enable parsing a screen's raw property and use a query's min-width pixel value if it specifies the device type as screen or doesn't specify device type at all. For example, lg: {raw: print, (min-width: 1024px)} would set lg to 1024 |

That's it! You can now use Tailwind Breakpoints in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release