Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glyphic-co/textblock
Continuously responsive typesetting — Demo:
https://github.com/glyphic-co/textblock
fluid progressive-enhancement responsive responsive-design typesetting typesetting-system typography
Last synced: about 2 months ago
JSON representation
Continuously responsive typesetting — Demo:
- Host: GitHub
- URL: https://github.com/glyphic-co/textblock
- Owner: glyphic-co
- License: mit
- Created: 2017-04-26T23:30:08.000Z (over 7 years ago)
- Default Branch: development
- Last Pushed: 2022-12-06T15:04:21.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T04:30:20.761Z (5 months ago)
- Topics: fluid, progressive-enhancement, responsive, responsive-design, typesetting, typesetting-system, typography
- Language: JavaScript
- Homepage: https://textblock.io
- Size: 9.22 MB
- Stars: 547
- Watchers: 9
- Forks: 16
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Textblock
A javascript tool for adjusting size, leading, and grades to cast continuously responsive typography. It works over your current CSS as a progressive enhancement.
The script calculates your setting based on minimum and maximum values for font size, line height, variable grades, and container width:
- minimum/maximum font size
- minimum/maximum line height
- minimum/maximum container width
- minimum/maximum grades (variable fonts only)
## To initialize, add the element to be resized (required)
### With Vanilla JS
1. Include the main script and
2. target elements using JS notation:
```HTML
Textblock([{
target: ".some-element"
}]);
```
### As a Node Module (shown here for React)
1. Add to modules with `npm install --save textblock`,
2. include the module, and
3. apply to elements within `componentDidMount()` as needed:
```JS
import Textblock from 'textblock';
componentDidMount() {
Textblock([{
target: ".some-element"
}]);
}
```
## Parameters
- **`target`** (required ): The element that should be resized `".your‑class"`, `"#some-id p"`
- **`minWidth`**: default `320`
- **`maxWidth`**: default `960`
- **`minWidth_FontSize`**: default `1.0`
- **`maxWidth_FontSize`**: default `1.8`
- **`minWidth_LineHeight`**: default `1.33` (unitless values only)
- **`maxWidth_LineHeight`**: default `1.25` (unitless values only)
- **`minWidth_VariableGrade`**: A variable font weight for the small size, for example `450`
- **`maxWidth_VariableGrade`**: A variable font weight for the large size, i.e. `400`
- **`container`**: The container width to measure. Defaults to `"parent"` and can alternately be set to `"self"`.
- **`fontSize_Units`**: default `em`
For a better sense of context, set your root em to `10px` with `html { font-size: 62.5%; }`. This makes your em units base 10 so `2.4em` = `24px`. But any number will do because once you start adjusting the min/max numbers, the experience is more visual than calculated. And if you prefer a more scientific approach, Textblock gives you the control you need for setting systems like modular scales.
If you’re using variable fonts, the `minWidth_VariableGrade` / `maxWidth_VariableGrade` parameters provide a way to simulate grades (micro-variations in weight to set smaller sizes slightly bolder).
## Example Including Extra Parameters
```JS
Textblock([{
target: ".some-class",
minWidth: 280,
maxWidth: 800,
minWidth_FontSize: 1.9,
maxWidth_FontSize: 2.6,
minWidth_LineHeight: 1.33,
maxWidth_LineHeight: 1.25,
minWidth_VariableGrade: 366,
maxWidth_VariableGrade: 300,
container: "self",
fontSize_Units: "rem"
}]);
```
## Multiple Elements with Different Settings
```JS
Textblock([
{
target: ".some-class",
minWidth_FontSize: 1.9,
maxWidth_FontSize: 2.6
},
{
target: ".another-class",
minWidth_FontSize: 2.4,
maxWidth_FontSize: 3.6,
minWidth_VariableGrade: 450,
maxWidth_VariableGrade: 400,
container: "self"
}
]);
```