diff --git a/README.md b/README.md index dc84c72..4c08361 100644 --- a/README.md +++ b/README.md @@ -7,34 +7,32 @@ We'll start with some really basic markup:

Some Title

After including jQuery, [download and include the minified version of Lettering.js](http://github.com/davatron5000/Lettering.js/downloads), then a script block with the magical `.lettering()` method: - + - + The resulting code will churn your `.fancy_title` and output the following:

- S - o - m - e - - T - i - t - l - e + S + o + m + e + + T + i + t + l + e

Magical. Now the text is easy to manipulate in your CSS using an ordinal `.char#` pattern. This plugin assumes basic counting skills, but it's a pretty fast and easy way to get control over every letter. -You get further control from classes based on the actual letter for character styling. As you can see in the example above `.charS` allows you to style the letter `s`. __Please Note:__ class names are case-insensitive. - As you can imagine, it would be a pain in the ass to have all those `spans` littering your markup and a nightmare to maintain. If the client came by the next day and said that the SEO Expert demands that you have to change the title to "Cool Title", it'd just be a matter of changing the original clean markup to:

Cool Title

@@ -50,17 +48,17 @@ Here's an example of the `.lettering('words')` method: Which will generate:

- Don't - break - my - heart. + Don't + break + my + heart.

You can then style each word using the `.word#` class. @@ -72,16 +70,16 @@ Once word wrapping was complete, we noticed the need for yet another method, one Resulting code:

- Are you - ready to - RUMmMmMMBBLE! + Are you + ready to + RUMmMmMMBBLE!

As expected it uses the `.line#` ordinal pattern. You'll also notice the `
`'s have been destructively ripped out. In your CSS, you'll want to declare something like `.line_split span { display:block; }` if you need them to behave as a `
` element. @@ -102,4 +100,4 @@ As with any kind of Javascript, have a fall back plan in case the user doesn't h Web performance patterns advise that you put Javascripts at the bottom of your page before your `` tag. There is an unfortunate side effect where you may experiences a [FOUT (Flash of Unstyled Text)](http://paulirish.com/2009/fighting-the-font-face-fout/) when you're manipulating your text after the DOM has loaded. Unfortunately, we found the best solution to avoid/minimize the FOUT caused by this plugin is to put your scripts (jQuery, Lettering.js) in the document ``. On the one hand, your page will load slower. On the other hand, a flash/restyling makes your site feel slow. Users might ultimately feel the site is faster if they don't see the FOUT. ## Download, Fork, Commit, Please. -We really want Lettering.js to be a quality helper for web typography. If you have any feedback or suggestions, please leave those over on the Github. We're excited about typography on the web and want to help make it print quality. +We really want Lettering.js to be a quality helper for web typography. If you have any feedback or suggestions, please leave those over on the Github. We're excited about typography on the web and want to help make it print quality. \ No newline at end of file diff --git a/examples/index.html b/examples/index.html index 4c08361..5913ce8 100644 --- a/examples/index.html +++ b/examples/index.html @@ -1,103 +1,135 @@ -# Lettering.js, a jQuery plugin for radical Web Typography -We developed a lightweight, easy to use Javascript `span` injector for radical Web Typography, we're calling it "Lettering Dot JS", and we're releasing it today for free over on Github. Let me demo it for you: `` - -## Individual Letter Control with Lettering.js -We'll start with some really basic markup: - -

Some Title

- -After including jQuery, [download and include the minified version of Lettering.js](http://github.com/davatron5000/Lettering.js/downloads), then a script block with the magical `.lettering()` method: - - - - - -The resulting code will churn your `.fancy_title` and output the following: - -

- S - o - m - e - - T - i - t - l - e -

- -Magical. Now the text is easy to manipulate in your CSS using an ordinal `.char#` pattern. This plugin assumes basic counting skills, but it's a pretty fast and easy way to get control over every letter. - -As you can imagine, it would be a pain in the ass to have all those `spans` littering your markup and a nightmare to maintain. If the client came by the next day and said that the SEO Expert demands that you have to change the title to "Cool Title", it'd just be a matter of changing the original clean markup to: - -

Cool Title

- -It also plays nicely with CMSs like WordPress or Expression Engine and art direction plugins. - -## Wrap Words with Lettering.js -Once we developed this e-solution and played with it, we found it useful enough to broaden the scope so that we could break apart and wrap words in a sentence in a span tag. - -Here's an example of the `.lettering('words')` method: - -

Don't break my heart.

- - + + - -Which will generate: - -

- Don't - break - my - heart. -

- -You can then style each word using the `.word#` class. - -## Wrap Lines with Lettering.js -Once word wrapping was complete, we noticed the need for yet another method, one that would break lines up mid-sentence. We struggled for a semantic way to do this, but then remembered `
` tag which a semantic way to say "break this line". Similar to the above examples where lines of text are broken up by either non-breaking spaces or individual letters, the `lettering('lines')` method will create breakpoints at `
` tags: - -

Are you
ready to
RUMmMmMMBBLE!

- - - -Resulting code: - -

- Are you - ready to - RUMmMmMMBBLE! -

- -As expected it uses the `.line#` ordinal pattern. You'll also notice the `
`'s have been destructively ripped out. In your CSS, you'll want to declare something like `.line_split span { display:block; }` if you need them to behave as a `
` element. - -## Best Practices & Kerning -We've found this to be a pretty quick and elegant solution to create typographical CSS3 posters. It's also a great solution for really custom type headings, while keeping the text selectable. - -### Best Practices -Be smart and use sparingly. You'll probably break your browser if you try to wrap every letter on your page in a `span` tag, so don't do that. Look to use this in your Headings, Blockquotes, Asides, etc. - -### Kern Well -If you're going through the trouble to load a fancy font and that word or phrase is the largest on the site, then it's important for it to be kerned well. With Lettering.js, kerning is a breeze. You can simply use `$("#id-of-what-i-want-to-kern").lettering();` and then on each `.char#`, you can set relative position or left/right margin. Works like a charm. - -### Non-Javascript Fallback -As with any kind of Javascript, have a fall back plan in case the user doesn't have javascript enabled. The bottom line is up to you, my bottom line would be "legible and on the screen". Also, use `lettering.min.js` [Download the Minified Version of Lettering.js here](http://github.com/davatron5000/Lettering.js/downloads) - -### Performance Anti-Pattern -Web performance patterns advise that you put Javascripts at the bottom of your page before your `` tag. There is an unfortunate side effect where you may experiences a [FOUT (Flash of Unstyled Text)](http://paulirish.com/2009/fighting-the-font-face-fout/) when you're manipulating your text after the DOM has loaded. Unfortunately, we found the best solution to avoid/minimize the FOUT caused by this plugin is to put your scripts (jQuery, Lettering.js) in the document ``. On the one hand, your page will load slower. On the other hand, a flash/restyling makes your site feel slow. Users might ultimately feel the site is faster if they don't see the FOUT. - -## Download, Fork, Commit, Please. -We really want Lettering.js to be a quality helper for web typography. If you have any feedback or suggestions, please leave those over on the Github. We're excited about typography on the web and want to help make it print quality. \ No newline at end of file + $("#demo1 h1").lettering(); + $("#demo2 h1").lettering('words'); + $("#demo3 p").lettering('lines'); + $("#demo4 h1").lettering('words').children("span").lettering(); + $("#demo5 h1").lettering().children("span").css({'display':'inline-block', '-webkit-transform':'rotate(-25deg)'}); + }); + + + + + + +
+
+

Lettering.JS

+

The following are some hokey examples of how you can implement LETTERING.JS. +

+ +
+
+

Letters

+

The HTML

+
	<div id="demo1" class="demo">
+  <h1>Rainbow</h1>
+</div>
+
+ +

The jQuery

+
$(document).ready(function() {
+  $("#demo1 h1").lettering();
+});
+
+ +

The Result

+
+

Rainbow

+
+ +
+ +
+

Words

+ 
$("#demo2 h1").lettering('words');
 + +

The Result

+
+

Hi, Multi Color

+
+
+ +
+

Lines

+ 
$("#demo3 p").lettering('lines');
 + +

The Result

+
+

This is an amazing
Revolution in Typography.
The possibilities are endless:
Coloring, Vertical spacing, and Kerning.

+
+
+ +
+

Advanced #1: Chaining 2 Methods

+
$("#demo4 h1").lettering('words').children("span").lettering();
 +

The Result

+
+

Double Rainbow

+
+
+ +
+

Advanced #2: Chaining and Styling

+
$("#demo5 h1").lettering()
+	.children("span").css({'display':'inline-block', '-webkit-transform':'rotate(-25deg)'});
 +

The Result

+
+

WOOOoo!

+
+
+ +
+ + +
+ + + \ No newline at end of file