Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplefocus/FlowType.JS
Web typography at its finest: font-size and line-height based on element width.
https://github.com/simplefocus/FlowType.JS
Last synced: 10 days ago
JSON representation
Web typography at its finest: font-size and line-height based on element width.
- Host: GitHub
- URL: https://github.com/simplefocus/FlowType.JS
- Owner: simplefocus
- License: mit
- Created: 2013-08-13T21:10:16.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2021-07-28T17:32:29.000Z (over 3 years ago)
- Last Synced: 2024-04-27T18:03:04.808Z (6 months ago)
- Language: JavaScript
- Homepage: http://simplefocus.com/flowtype/
- Size: 23.4 KB
- Stars: 4,608
- Watchers: 142
- Forks: 458
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome - simplefocus/FlowType.JS - Web typography at its finest: font-size and line-height based on element width. (JavaScript)
- awesome-javascript - FlowType.JS - Web typography at its finest: font-size and line-height based on element width. - ★ 4551 (Typography)
README
> # Update: 07/28/2021 #
>
> The functionality of the plugin can be implemented using plain css these days.
>
> [https://css-tricks.com/snippets/css/fluid-typography/](https://css-tricks.com/snippets/css/fluid-typography/)
# FlowType.JS #
Responsive web typography at its finest: font-size ~~and line-height~~ based on element width.
Check out the [demo site](http://simplefocus.com/flowtype).
## What does FlowType.JS do? ##
Ideally, the most legible typography contains [between 45 and 75 characters per line](http://webtypography.net/2.1.2). This is difficult to accomplish for all screen widths with only CSS media-queries. FlowType.JS eases this difficulty by changing the font-size ~~and line-height~~ based on a specific element's width. This allows for a perfect character count per line at any screen width.
## Options ##
### Thresholds ###
Set minimum and maximum width thresholds to control the FlowType.JS magic within specific element widths.
In this example, FlowType.JS will stop resizing text once the element width becomes smaller than 500px or larger than 1200px.
```javascript
$('body').flowtype({
minimum : 500,
maximum : 1200
});
```
Set minimum and maximum font-size thresholds to control the FlowType.JS magic within specific font sizes.
In this example, FlowType.JS will stop resizing text once the font-size becomes smaller than 12px or larger than 40px.
```javascript
$('body').flowtype({
minFont : 12,
maxFont : 40
});
```
### Font-size ###
Set your own font-size using the `fontRatio` variable. When using `fontRatio`, increase the value to make the font smaller (and vice versa).
_Note:_ Because each font is different, you will need to "tweak" `fontSize` and "eye ball" your final product to make sure that your character count is within the recommended range.
~~Line-height (`lineRatio`) is set based on the `fontRatio` size, and defaults to 1.45 (the recommended line-height for maximum legibility).~~ See *line-height* below.
```javascript
$('body').flowtype({
fontRatio : 30
});
```
### Line-height ###
In v1.0 of FlowType, we made the plugin set a specific line-height in pixels. We received many statements that setting a specific line-height is very dangerous. So, what did we do? We removed support for line-height in v1.1.
What do I do now? It's quite simple: use unitless line-height in your CSS. It will automatically make changes based on the `font size`. Here's an example of what we suggest for `line-height`:
```css
line-height: 1.45;
```
## Getting Started ##
### Step 1: Install FlowType.JS ###
To use FlowType, you'll need to make sure both the jQuery and FlowType.JS scripts are included.
#####Download FlowType.JS#####
- [Download the latest release](https://github.com/simplefocus/FlowType.JS/archive/v1.1.0.zip).
- Clone the repo: `git clone https://github.com/simplefocus/FlowType.JS.git`.
- Install with [Bower](http://bower.io): `bower install Flowtype.js`.
#####Include jQuery and FlowType.JS scripts#####
```html
```
### Step 2: Set Typography Base ###
Prepare for FlowType.JS by making sure that the typography is flexible. Start with this CSS and make changes as necessary:
```css
body {
font-size: 18px;
}
h1,h2,h3,h4,h5,h6,p {
line-height: 1.45;
}
h1 { font-size: 4em; }
h2 { font-size: 3em; }
h3 { etc...
```
_Note:_ Setting a specific font-size in your CSS file will make sure that your website remains accessible in case your viewer has JavaScript disabled. These numbers will be overridden as FlowType.JS updates the `font-size` number inline.
### Step 3: Call FlowType.JS ###
To begin the magic, simply call FlowType.JS before the close of your `body` tag:
```javascript
$('body').flowtype();
```
### Step 4: Make Changes ###
You will most likely want to change the default settings. To do so, simply include these options in your code and tweak away:
```javascript
$('body').flowtype({
minimum : 500,
maximum : 1200,
minFont : 12,
maxFont : 40,
fontRatio : 30
});
```
_Note:_ When using FlowType.JS, it will only perform it's magic on the element and child elements that are specified in the closing document's call. For example, if you have `
` inside of an `` and you apply FlowType.JS to `
`, it will only update `
` and not ``. But, if you apply FlowType.JS to ``, the entire contents including `
` will be updated. We believe that this can be used to your advantage. So, tweak and change as you feel necessary:
```javascript
$('body').flowtype({
minimum : 500,
maximum : 1200,
minFont : 12,
maxFont : 40,
fontRatio : 30
}),
$('article').flowtype({
fontRatio : 36
}),
$('.featured-article').flowtype({
minFont : 12,
fontRatio : 20
}),
$('.side-stories').flowtype({
minFont : 16,
fontRatio : 30
});
```
## Brought to you by... ##
This wonderful piece of magic has been brought to you by the team at [Simple Focus](http://simplefocus.com). Follow Simple Focus on Twitter: [@simplefocus](http://twitter.com/simplefocus).
FlowType.JS is licensed under the MIT License. See the LICENSE.txt file for copy permission.