tailwindcss-vertical-rhythm

v0.0.3

Published

3 years ago

A typography tailwind plugin

Downloads

272

0High
0Medium
0Low

terrysmith

tailwindcss typography

Tailwindcss-vertical-rhythm

A tailwind plugin that helps create scaling typography. It does the CSS math so you don't have to.

The term vertical rhythm is an old typography practice designers have been using for years, it controls the flow of a piece of media's content improving the readability of content and creating a cohesive looking design. This has become an increasingly difficult problem in the digital age with the variation of screen sizes, pixel density ratios and changing containers give designers less control over the final output and why it's usually best to leverage existing base kits like Tailwind's defaults, Bootstrap, etc. Unless you want to be a font/type nerd; then this is the plugin for you. 💖

Features:

Modular Scaling
Vertical Rhythm (of course)
Dynamic Font Scaling
Keeps Fonts Accessible
Does Not Modify Default Tailwind (caveat: it does set a font size on the <body> tag)
Highly Customizable
100% CSS

This plugin started as a side project focusing on typography on the web, particularly with scaling font size to the screen size. I was annoyed with how tiny are on fonts most websites use for ultra wide screens with high resolutions. I usually end up zooming in on pages to make it nice. Basically the higher the resolution the smaller the text renders. Refusing to admit I'm old I started looking into the topic and here we are.

Site with examples (WIP)

Looking for help! Particularly in getting some hosted examples, typography is very visual! Checkout the Issues in GitHub or let me know if you end up using this plugin! 👀

Installation

You can install the library using your prefered package manager

NPM

npm install -D tailwindcss-vertical-rhythm

Yarn

yarn add --save-dev tailwindcss-vertical-rhythm

PNPM

pnpm add --save-dev tailwindcss-vertical-rhythm

Configuration

Add tailwindcss-vertical-rhythm as a plugin in tailwind.config.js

module.exports = {
  ...
  verticalRhythm: {}, // Optional: High level plugin settings
  plugins: [require("tailwindcss-vertical-rhythm")]
  ...
}

Basic use

The plugin by default generates the following classes, you do not need to set any configs if you want to just have some easy base type styles.

Add factor classes to text blocks, they apply font-size, line-height, padding-top, and margin-bottom.

factor-xs
factor-sm
factor-base
factor-lg
factor-xl
factor-2xl
factor-3xl
factor-4xl

Example HTML:

<h1 class="factor-xl">very useful text</h1>
<h2 class="factor-lg">subheading</h2>
<p class="factor-base">Some great content</p>

How it works

Thinking in factors

When dealing with digital screens it's best to think of font sizes as being relative vs pixel perfect. Most designs nowadays use a predefined scale and stick to that to be consistent, but the problem is as we get more varied resolutions on devices the designs start looking different. There can also become a disjoin in the whitespace around those scales if you are setting them manually. Not all designs need to be using vertical rhythm, for years more of the web has been based on "feel" vs math. Usually these simple pre-set sizes are considered "good enough" because it's not worth the development effort to tune the translation from a designers vision into practice across all these devices.

Tailwind's text sizing classes are great but also have the problem of the rem based font sizes are rendered at a different ratio of screen space depending on the device.

The most basic lego block of a website using vertical rhythm is starting with a base font size and scaling up or down from there using a modular scale.

Let's say the base size of a html document is 16px per 1rem, this is the base factor. The next factor up would be your base (1rem) times a modular scale, let's use a major third.

1rem * 1.25 = 1.25rem

Ok we have a base factor and a factor one size up. The next factor up would be calculated on the previous value times the modular scale.

| Factor Name | Calculation | Final Size (rem) | | ----------- | ------------------- | ---------------- | | base | 1rem | 1rem | | lg | 1rem * 1.25 | 1.25rem | | xl | 1.25rem * 1.25 | 1.5625rem | | 2xl | 1.5625rem * 1.25 | 1.95325rem | | 3xl | 1.953125rem * 1.25 | 2.4415625rem |

This concept of scaling font sizes has been around for a while, and it often talked about along with grid systems (and maybe the golden ratio) back when you'd need a library to do it instead of using flexbox or grid. There's even calculators out there so you can set up your own modular scale online, however these either require you to manually manage hard coded values, use css calc() which can be expensive, or use a post processor like sass.

Ok now that we know how modular scales work, what can be applied to it? Quite a bit really, however now that we have font-size on a modular scale there's a few more things to worry about. As fonts get larger in CSS we also need to worry about line height (covered in tailwinds font sizes as of 2.0), white spacing before and after while also matching the modular scale to maintain the vertical rhythm as the eye skims a page.

Base, second, third, fifth factors don't feel very in the spirit of Tailwind so factor classes follow a similar naming convention of xs, sm, base, lg, xl, 2xl, 3xl, 4xl.

But wait! Things still don't look 100%

We're still dealing with a few variables which will impact the level of tuning needed for your tailwind project. I've tried to provide sensible defaults but there is still room for improvement.

Not all fonts are made equal.
Resolution and pixel density are still affecting the design.

Every font family (and custom font faces you might be using) have different properties and are made with varying qualities. Generally fronts from the largest foundries are good but sometimes you need the ability to fine tune things to better suit the specific font. For example: Often san serif fonts benefit from a little extra line height to increase readability, especially with multiple paragraphs. The Vertical Rhythm plugin allows you to manually tune this instead of using the default in the configs. You can also create your own custom factors to be used with different fonts!

Remember that neg that spawned this whole plugin? Out of the box, this plugin defaults to setting up the vertical rhythm of a site, but we're still suffering from fonts rendering slightly differently depending on the resolution. Using relative units like rem is certainly better than absolute values like px but we're still having accessibility and readability problems with fonts being too small on high resolution phones and super large screens.

Enter dynamic font scaling (AKA the dynamic mode ). A relatively new CSS feature called clamp() addresses this problem, it scales a value up and down between two ranges. Be default factors scale based tailwinds responsive size screens.sm screen size to screens.xl, taking account of the horizontal screen space and scaling the factor up or down depending on the real estate available. At this point we're really leaving the realm of worrying about an absolute size metric for fronts and letting our chosen scale and factor focus on making sure the page is rendering beautifully.

What about the official Tailwind Typography plugin?

I haven't had the chance to test combining the two yet, but that plugin is great! It's meant to be a one stop shop that applies default styles to your entire site. This Vertical Rhythm plugin is less opinionated and injects less styles out of the box. It focuses only on font size, line height, and spacing around with the option to enable scaling type with the screen size. Vertical Rhythm is likely better suited for people who want less out of the box and more control over the rendering of their fonts.

Why In Tailwind?

For one I LOVE building my projects in tailwind so I was already wanting to use it. First problem tailwind provides is it allows easy configuration interface to dial in your typography and it also provides responsive screen sizes I can use to calculate the correct slope when dealing with dynamic front scaling. Because Tailwindcss is a PostCSS plugin it also let's the calculations run on build time and not impact browser performance at all like some calc solutions would. ✨

Tailwind users also are already used to working with utilities and restraining designs based on scales so using factors feels pretty natural integrating into a design.

Further Configuration

The Default Base Factor

This plugin defaults to rems with a base pixels per rem of 16px and a scale of the above example "Major Third" but you can modify this as you wish in the plugin configs, some designers and developers prefer using a base of 10px to make rem math easier, however you likely won't need that with this plugin.

You can configure this behaviour in the tailwind.config.js file:

{
    ...
    verticalRhythm: {
        basePixel: 14, // Change the base unit to 14px. Pass a number not a px value
        unit: "em"
    },
    theme: {},
    ...
}

The Modular Scale

The plugin provides 8 scales out of the box and can accept a custom scale through configs.

| Name | Value | | ------------------------ | ----- | | Minor third | 1.2 | | Major third (default) | 1.25 | | Fourth | 1.333 | | Fifth | 1.5 | | Fibonacci (golden ratio) | 1.618 | | Minor seventh | 1.778 | | Major seventh | 1.875 | | Octave | 2 |

In the tailwind.config.js configuration:

{
    ...
    verticalRhythm: {
        scale: "fibonacci" // Golden Ratio
    },
    ...
}

{
    ...
    verticalRhythm: {
        scale: 1.234
    },
    ...
}

Dynamic Mode

Dynamic mode switches type rendering over to use dynamic font scaling while using the vertical rhythm values with the use of css clamp. Text will now scale linearly up and down depending on the vw of the device based on this great CSS Tricks article by Pedro Rodriguez.

Linear Scaling Zones

The zones fonts scale be customized by either passing a number value or accessing the tailwind theme function in your tailwind.config.js file. By default the min and max are tailwind responsive theme values screens.md and screens.2xl.

In the tailwind.config.js configuration:

{
    ...
    verticalRhythm: {
        minScreen: theme("screens.md")
        maxScreen: theme("screens.lg")
    },
    ...
}

Size Multiplier

By default the font is set to double in size compared to the smallest possible value. When in dynamic mode the regular factors are the size values used for the smallest screens. The font height, line height and white spacing is then scaled up as there is more screen space available.

This can be modified inside the tailwind.config.js configuration:

{
    ...
    verticalRhythm: {
        clampMultiplier: 1.5
    },
    ...
}

Extracting Classes

You can extract factors along with your other type stylings in a single class in your tailwind.css file to reuse code

@tailwind base;
@tailwind components;
@tailwind utilities;

@layer components {
  /* name of class */
  .content {
    /* css that will be applied */
    @apply factor-base leading-relaxed subpixel-antialiased font-light;
  }
}

Later you can use the class in your code which you applied in the tailwind.css file

<p class="content">very useful text</p>

You can learn more about extracting classes here

Advanced Plugin Options

Values are what the defaults are set to in the tailwind.config.js configuration:

{
    ...
    verticalRhythm: theme => {
        basePixel: 16, // Set on the body in px, also used in the pixels per rem calc.
        baseSize: 1, // Probably never need to change this.
        baseLineHeight: 1,
        unit: 'rem',
        capHeight: 0.68, // Used to calculate whitespace breathing room (multiplier)
        headerSpacing: { // TODO: Untested config.
            before: 0, // Add space before (additive)
            after: 0, // Add space after (additive)
        }
        lineHeightMultiplier: 1, // Used in calculating the line height (multiplier)
        clampMultiplier: 2, // Dynamic mode scaling for max screen size (multiplier)
        clampMin: theme("screens.md"), // Dynamic mode min range
        clampMax: theme("screens.2xl"), // Dynamic mode max range
        mode: 'normal', // technically undefined, it's only looking for string "dynamic" to turn on dynamic scaling.
        scale: "major third", // Sets the scale to calculate factor sizes.
    },
    ...
}

Custom Factors

Still in early development here!

You can also create your own factors via Tailwind's theme functionality. In the event you want to get really into the reeds of tuning font rendering, you can create your own custom set of factors. An individual factor is an array which takes the factor multiplier to use + custom modifiers for the final style calculation. It is still leveraging the overall verticalRhythm configuration including the selected scale.

Breakdown of a custom factor:

"custom": [2 /* Factor multiplier */, {
    lineHeightMod: 1 // Adjusts line height calculation, useful for tuning custom font faces. (Multiplier)
    headerSpacingBefore: 10, // Adjusts whitespace before text block (Additive)
    headerSpacingAfter: 10, // Adjusts whitespace after text block (Additive)
} ]

theme: {
    factor: {
        // creates class "factor-serif-base"
        "serif-base": [ 1,
            {
                lineHeightMod: 0.8,
                headerSpacingBefore: 10
                headerSpacingAfter: 10,
            },
        ],
        ...
        // creates class "factor-serif-8xl"
        "serif-8xl": [ 4,
            {
                lineHeightMod: 0.7,
                headerSpacingBefore: 10
                headerSpacingAfter: 10,
            },
        ],
    },
}