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

tailwindcss-text-scale

v0.3.1

Published

<img src="https://raw.githubusercontent.com/matiasngf/tailwindcss-text-scale/main/text-scale-logo.png"/>

Downloads

9,989

Readme

Scale your text between breakpoints to create a better responsive experience.

<h2 className="text-scale-lg/4xl">
  This text will scale between lg on mobile and 4xl on desktop.
</h2>

Demo | NPM | GitHub

Installation

npm i -d tailwindcss-text-scale

Add the pluign on your tailwind.config.js file:

import textScalePlugin from 'tailwindcss-text-scale'

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    "./src/**/*.{js,ts,jsx,tsx}",
  ],
  plugins: [
    textScalePlugin({
      minScreen: 320, // optional, defaults to theme.screens.sm
      maxScreen: 1920, // optional, defaults to theme.screens.2xl
    })
  ],
}

If you dont have a screens.sm or screens.2xl on your theme, you need to set the options minScreen and maxScreen.

Scaling text

text-scale-[min-size]/[max-size] will scale your font-size between the two breakpoints default breakpoints.

<h2 className="text-scale-lg/4xl">
  Scaled text
</h2>

You can use any font-size you want:

<h2 className="text-scale-[13px]/[20px]">
  Scaled text
</h2>

To scale the text correclty you should use pixels or rems only.

Breakpoints

If you need to set a custom breakpoint for a component, you can use the text-screen-[min-size]/[max-size] classes.

<div className="text-screen-[300px]/lg">
  <h2 className="text-scale-xs/[40px]">
    Scale this text between 300px and screen-lg.
  </h2>
</div>

Plugin configurations

Setting custom breakpoints

By default the plugin will use screens.sm and screens.lg as the min and max breakpoint for the text scaling. You can set custom breakpoints on the plugin configuration:

textScalePlugin({
  maxScreen: 1920,
  minScreen: 320,
})

Custom classNames

If you don't like using text-[size]/[size], you can customize the variable name on the plugin configuration. For example, if you want your classes to be scaled-text-[size]/[size], you can set:

textScalePlugin({
  textScalePrefix: 'scaled-text',
})

Now, to scale your text, use:

<h2 className="scaled-text-xs/lg">
  Scaled!
</h2>

Optinally, you can set the screenScalePrefix to change the text-screen-[size]/[size] classes.

textScalePlugin({
  screenScalePrefix: 'scaled-screen',
})
<div className="scaled-screen-sm/xl">
  {...content}
</div>

Clamp

Clamp limits how much your font will scale. By default, the plugin will clamp the font-size to the min and max values. You can disable this behavior by setting clampMin or clampMax to false:

textScalePlugin({
  clampMin: false,
  clampMax: false,
})