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

truncate-markup-string

v1.0.2

Published

Truncates a string to a charLimit, ignoring specified markup tags, with an optional "pretty" ellipsis ending.

Downloads

49

Readme

truncate-markup-string

Truncates a string given a charLimit param. Provides following features:

  • If truncation is necessary, ends with ellipsis (...) which is counted in the charLimit.
  • Does not count chars inside supplied openTag and closeTag markup params.
  • Does not break the last word.
  • Does not break in the middle of an openTag and closeTag. This is especially useful when wanting to not break in the middle of a bolded statement.
  • Based on boolean param prettyEllipsis, will remove punctuation at the end of the truncated text. This avoids weird endings like "?..."

Usage

import truncate from 'truncate-markup-string';

const fullString = 'This is <b class="highlight">super</b> cool? Gotta love truncation!';
const charLimit = 30;
const openTag = '<b class="highlight">';
const closeTag = '</b>';
const prettyEllipsis = true;
const result = truncate(fullString, charLimit, openTag, closeTag, prettyEllipsis);

The above code will result in the truncated string: This is <b class="highlight">super</b> cool.... Notice how the char limit ignored the supplied HTML tags, and the prettyEllipsis removes the question mark at the end.

Future options

Although version 1.0.2 is published and works great, there's still a lot of options and improvements that will be added to this in the future. Currently, this supports a very specific case of ignoring only one set of HTML markup tags, like bold tags. However, future support for multiple tags, a custom ellipsis, and truncation on words instead of chars will come soon.