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

eleventy-plugin-dropcap

v1.1.0

Published

Adds an Eleventy filter for adding accessible, stylable dropcap markup to the content of a page.

Downloads

28

Readme

Eleventy Plugin: Drop Cap

Purpose

Creates a dropcap filter for Eleventy templates.

The filter works when the following is true:

  • First element in rendered markup is <p>
  • First element begins with a word (not punctuation)

The filter does two things:

  • Wraps the first letter of the first word in a span with class first-letter (or a class you specify)
  • Wraps the entire first word (which has now been split and will be read poorly by screen readers) in a span with an aria-label that allows screen readers to read the first word "normally"

For more information on the pattern used here, watch Ethan Marcotte's short video, "Creating Beautiful and Accessible Drop Caps" or read the transcript included at that page.

Installation

Node Module

npm i --save eleventy-plugin-dropcap

Eleventy Config

In .eleventy.js

const pluginDropcap = require('eleventy-plugin-dropcap')

module.exports = eleventyConfig => {
  eleventyConfig.addPlugin(pluginDropcap)
  // Other code
}

Options

You can change the classes used by passing in an options object with dropCapClass and hiddenTextClass values.

eleventyConfig.addPlugin(pluginDropcap, {
  dropCapClass: 'first-letter',
  hiddenTextClass: 'sr-only'
})

Either class value can be a string or an array of strings.

The default values are:

| Key | Value | |---|---| | dropCapClass | drop-cap | | hiddenTextClass | screen-reader-only |

Template Usage

In Nunjucks:

{{ content | dropcap | safe }}

In Liquid:

{{ content | dropcap }}

Styles

You'll need to have your own CSS to style the dropcap as you like.

You'll need to have CSS to correctly style the visually hidden (screen-reader-only) text as well. I recommend this CSS pattern for visually hidden text:

.screen-reader-only {
  clip: rect(0 0 0 0);
  clip-path: inset(50%);
  height: 1px;
  overflow: hidden;
  position: absolute;
  white-space: nowrap;
  width: 1px;
}