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

@threespot/unorphanize

v2.0.1

Published

Wrap the last X words in an HTML tag to prevent them from wrapping

Downloads

173

Readme

Unorphanize

npm Build Status Coverage Status

Helper function to wrap the last X words in an HTML tag to prevent them from wrapping.

Caveats

  • This script doesn’t check if text is visible (possible future enhancement)
  • Using this inside of links or headings could cause issues in VoiceOver on iOS
    • See http://axesslab.com/text-splitting/ for solutions

Install

yarn add @threespot/unorphanize

Usage

// ES6 module
import Unorphanize from "@threespot/unorphanize";

// For transpiled ES5 code, import this file:
// import Unorphanize from "@threespot/unorphanize/dist/unorphanize.m";

const nodes = document.querySelectorAll("[data-orphans]");

nodes.forEach(function(el) {
  var u = new Unorphanize(el, {
    wordCount: 2, // number of words to prevent wrapping [default: 2]
    wrapEl: "span", // wrapper element tag [default: "span"]
    inlineStyles: true, // Add “white-space: nowrap;” to elements as inline style [default: true]
    className: "custom-class", // Custom class to add to wrapper [default: ""]
    append: "" // HTML to append to wrapper [default: ""]
  });
});

Example:

<p data-orphans>First second third fourth <b>fifth</b> <i>sixth</i>.</p>

Becomes:

<p data-orphans>First second third fourth <span class="custom-class" style="white-space: nowrap !important;"><b>fifth</b> <i>sixth</i>.</span></p>

To support setting wordCount in the HTML, you could do something like this:

import Unorphanize from "@threespot/unorphanize";

const nodes = document.querySelectorAll("[data-orphans]");

nodes.forEach(function(el) {
  const options = {};

  // Check for custom word count
  const wordCount = el.getAttribute("data-orphans");

  // Set custom word count if defined (defaults to 2)
  if (wordCount) {
    options.wordCount = wordCount;
  }

  var u = new Unorphanize(el, options);
});

Example:

<p data-orphans="3">First second third fourth fifth sixth.</p>

Becomes:

<p data-orphans="3">First second third <span style="white-space: nowrap !important;">fourth fifth sixth.</span></p>

We recommend using a custom class instead of inline styles to allow wrapping in small viewports.

const nodes = document.querySelectorAll("[data-orphans]");

nodes.forEach(function(el) {
  var u = new Unorphanize(el, {
    inlineStyles: false,
    className: "nowrap"
  });
});

Example CSS

@media all and (min-width: 320px) {
  .nowrap {
    white-space: nowrap !important;
  }
}

Example HTML:

<p data-orphans>First second third fourth.</p>

Becomes:

<p data-orphans>First second <span class="nowrap">third fourth.</span></p>

License

Unorphanize is free software and may be redistributed under the terms of the MIT license.

About Threespot

Threespot is an independent digital agency hell-bent on helping those, and only those, who are committed to helping others. Find out more at https://www.threespot.com.

Threespot