Skip to content

curiositry/diaeresis

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
img
 
 
 
 
 
 
 
 
 
 

Diaeresis.js

A lightweight JavaScript library that lets you wield diæreses like Chuck Mary Norris.

→ Check out the Demo ←

Usage:

All you need to do is include the script in your page and initialize it (in this example, using the RawGit CDN so you don’t even have to download it):

<script src="https://cdn.rawgit.com/curiositry/diaeresis/master/diaeresis.min.js"></script>

<script>
  var d = new Diaeresis();
</script>

By default, it will run on the contents of #diaeresis, and use the small built-in dictionary. But you can change all that when you initialize it:

var d = new Diaeresis({
  selector: "myCustomId",
  dictionary: {
    "bronte": "brontë",
    "find": "replace"
  }
});

In the above example, diaeresis will run on the element with the ID #myCustomId, which is handy if you don't want to change your markup to include the Diaeresis ID. And in the above example, we define additional dictionary entries. The dictionary object you give Diaeresis when you initialize it gets merged into the default dictionary, but it takes priority. So you can add new items, or overwrite existing items. (For example: if you think that reëlect should be spelled with a hyphen, you could add a rule like this: "reelect": "re-elect", which would override the default rule that changes reelect to reëlect.)

You’ll probably want to run Diaeresis asynchronously, like this:

<script src="diaeresis.min.js" defer></script>
<script>
  document.addEventListener("DOMContentLoaded", function(event) {
    var d = new Diaeresis();
  }
</script>

Going wild

While the small, built-in dictionary only adds diaereses, the script itself is much more flexible. Here a few examples of other uses you could put it to:

  • Converting "dumb" quotes to “smart” quotes, fake (--) em-dashes to real em-dases (—), and other ersatz punctuation marks to their respective Unicode characters.

  • Adding other diacritical marks — such as acute (´ ) and grave (`) accents — to words that ought to have them but rarely do, such as “élite” and “résumé”.

  • Converting ASCII smiley faces to Unicode emoticons, and other symbols to their official Unicode character.

  • Adding fancy ligatures (diaeresis → diæresis, for example).

You can use diaeresis.js for any of the above just by adding custom rules to the “dictionary”:

var d = new Diaeresis({
  dictionary: {
    "--": "—",
    "elite": " élite",
    "<3": "❤",
    "diaeres": "diæres"
  }
});

(And Diaeresis supports regular expressions, if you want to get fancy.)

About

A lightweight (<1kb minified + gzipped) JavaScript library that lets you wield diæreses like C̶h̶u̶c̶k̶ Mary Norris:

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published