Readme: o-ft-typography

#FT Typography

This module is now deprecated, please use o-typography instead.

Typographical styles for FT branded sites - fonts, weight, colors, sizes and vertical rhythm.

Overview

This module provides styles for Headings, Titles, Leads, Metadata, and body content.

Body content styles come in two categories:

Usage

There are two main ways to use these typographic styles:

1. Using the predefined CSS classes
2. Extending Sass placeholders to your own CSS classes

If you are using the Origami Build Service to add this module's CSS to your page, then only option 1 is available to you.

1. Using the predefined CSS classes

If you're not using the build service, turn off 'silent mode'.

Pre-defined CSS classes are provided and can be used directly in your HTML. All classes are prefixed with 'o-ft-typography-', for example o-ft-typography-heading-large.

The classes do not depend on any specific HTML element, but appropriate semantic elements should be chosen.

<h2 class="o-ft-typography-heading-medium">Heading medium</h2>

See docs/demo.html for a full list of the classes provided and their effects.

In addition to applying classes individual to elements, body styles can be applied to an HTML element and descendent h2, h3, p, a, strong, em, small, sup, sub, ul, ol, li elements will have styling applied.

General body styles:

<div class="o-ft-typography-body-wrapper">
    <h2>Heading medium</h2>
    <p>Body block with <strong>styled inline text</strong>.</p>
    <h3>Heading small</h2>
    <p>Body block with <em>styled inline text</em>.</p>
</div>

Article body styles:

<div class="o-ft-typography-article-body-wrapper">
    <h2>Article subheading 1</h2>
    <p>Article body block with <strong>styled inline text</strong>.</p>
    <h3>Article subheading 2</h2>
    <p>Article body block with <em>styled inline text</em>.</p>
</div>

Pre-defined classes are not available to module developers. Module developers are required to use the mixins.

2. Using the mixins

If you don't want to include the pre-defined classes in your HTML (or are a module developer) you may instead use the mixins provided:

.article {
    p,
    blockquote {
        @include oFtTypographyBodyBlock;
    }
}

For wrappers:

.article {
    @include oFtTypographyArticleBodyWrapper;
}

Mixins exist for all the same styles as pre-defined classes, named with a camelCased version of the class name.

Silent mode (docs)

When you're not consuming this module via the build service, by default this module is set to 'silent' - meaning its Sass will not output any CSS classes, only Sass mixins.

This can be turned off by setting a variable before you import the Sass:

@o-ft-typography-is-silent: false;

@import "o-ft-typography/main";

If you're not turning off silent mode, you will need to to load the fonts required by the typography you are using (due to the limitations of Sass' mixins, this cannot at present be done automatically):

@include oFtTypographyIncludeFont(heading); // downloads BentonSans-bold font given the current FT styles
@include oFtTypographyIncludeFont(metadata); // downloads BentonSans-normal font given the current FT styles

If a typography use case doesn't require a @fontface declaration in current FT branding nothing will be output by oFtTypographyIncludeFont(), but it's still a good idea to call it for each use case you use as it will mean your module will cope seamlessly with updates to FT's typography.

Font-face declarations

By default, this module will output font-face declarations for the required font-families. The next major version will not.

To remove font-face declarations from the output, set:

$o-ft-typography-output-font-face-declarations: false;