Nth Permutation Mathematics
Have ideas to improve npm?Join in the discussion! »

eleventy-plugin-dropcap

1.0.0 • Public • Published

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;
}

Install

npm i eleventy-plugin-dropcap

DownloadsWeekly Downloads

3

Version

1.0.0

License

ISC

Unpacked Size

4.42 kB

Total Files

6

Last publish

Collaborators

  • avatar