Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3.36 KB

readme.md

File metadata and controls

88 lines (63 loc) · 3.36 KB
Raw

jQuery Fancy Letter Plugin

The Fancy Letter Plugin lets you prettify your web page by styling the first letter of any element while keeping the HTML markup clean and readable by both human and machine.

Usage

To use the Fancy Letter Plugin, reference "jquery.fancyletter.js" (or "jquery.fancyletter.min.js") after you reference the jQuery core file and before you reference the script that uses .fancyletter():

<script src="http://code.jquery.com/jquery-latest.min.js"></script>
<script src="/path/to/jquery.fancyletter.min.js"></script>
<script src="/path/to/my-custom-script.js"></script>

Then, in the "my-custom-script.js" file (which you should rename to something more appropriate), you can apply the Fancy Letter to, for example, the first paragraph within <div id="content"> like so:

$('#content').find('p:first').fancyletter();

If that paragraph begins with "Let us go then, you and I," it will be converted to:

<span class="fancy-letter ltr-l">L</span>et us go then, you and I,

You can then style .fancy-letter in your stylesheet to make it stand out. See the demo page for examples.

Options

The following options, shown here with their default values, are available:

$.fn.fancyletter.defaults = {

  // String indicating the class name applied to all fancy letters
  commonClass: 'fancy-letter',

  // String indicating another class name, combined with the actual
  // (lower-cased) fancy letter. for example, if the fancy letter is "T,"
  // the class name would be "ltr-t".
  ltrClassPrefix: 'ltr-',

  // String containing a Regular Expression indicating the set of characters
  // that can be transformed into a fancy letter.
  characters:       '[a-zA-Z0-9]',

  // Punctation grouping (inspired by Matt Wiebe)
  // Boolean indicating whether to include punctuation that immediately precedes or follows first letter
  // See http://www.w3.org/TR/css3-selectors/#first-letter
  groupPunctuation: true,

  // String indicating common class for punctuation <span>s inside the fancyletter <span>
  punctuationClass: 'punct',

  // left and right punctuation to check for, and the corresponding classNames that will be used
  punctuationLeft: {
    '"': 'dquo',
    "'": 'squo',
    '“': 'ldquo',
    '‘': 'lsquo',
    '«': 'laquo',
    '‹': 'lsaquo',
    '(': 'lparen'
  },
  punctuationRight: {
    '"': 'dquo',
    "'": 'squo',
    '”': 'rdquo',
    '’': 'rsquo',
    '»': 'raquo',
    '›': 'rsaquo',
    ')': 'rparen'
  }
};

You can override them globally before calling .fancyletter(). For example, globally change the set of characters that can be transformed into a fancy letter:

$.fn.fancyletter.defaults.characters = '\S';

You can also override them whenever you call .fancyletter:

$('p').first().fancyletter({characters: '[a-zA-Z]'});

Further Information