Giter Club home page Giter Club logo

charming's Introduction

charming npm Version Build Status Coverage Status

Lettering.js in vanilla JavaScript.

  • Supports changing the inserted DOM element (defaults to span), or changing or removing the class prefix (defaults to char)
  • Supports passing in a regular expression to control how the contents of the element are wrapped
  • 414 bytes gzipped

Usage

Editable demo (CodePen)

HTML:

<h1>foo</h1>

JavaScript:

const charming = require('charming')

const element = document.querySelector('h1')
charming(element)

Boom:

<h1 aria-label="foo">
  <span class="char1" aria-hidden="true">f</span>
  <span class="char2" aria-hidden="true">o</span>
  <span class="char3" aria-hidden="true">o</span>
</h1>
  • Charming also works when the given element contains other (possibly nested) DOM elements; any character that is inside a text node in the given element will be wrapped.
  • For accessibility, Charming adds an aria-label attribute on the given element and aria-hidden attributes on each of the inserted DOM elements.

API

const charming = require('charming')

charming(element [, options])

Pass in an options object to change the tagName or classPrefix:

charming(element, {
  tagName: 'b',
  classPrefix: 'letter'
})

Set classPrefix to false if you don’t need a class on each wrapper element:

charming(element, {
  classPrefix: false
})

Pass in a regular expression on the splitRegex key to control how the contents of the element are wrapped:

charming(element, {
  splitRegex: /(\s+)/,
  classPrefix: 'word'
})

Installation

Install via yarn:

$ yarn add charming

Or npm:

$ npm install --save charming

License

MIT

charming's People

Contributors

yuanqing avatar uroybd avatar mburakerman avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.