Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zetareticoli/typesmith
Responsive typography library
https://github.com/zetareticoli/typesmith
fonts sass scss typography
Last synced: 8 days ago
JSON representation
Responsive typography library
- Host: GitHub
- URL: https://github.com/zetareticoli/typesmith
- Owner: zetareticoli
- Created: 2020-01-10T13:46:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T18:26:05.000Z (almost 2 years ago)
- Last Synced: 2024-11-20T06:52:03.183Z (about 1 month ago)
- Topics: fonts, sass, scss, typography
- Language: SCSS
- Homepage:
- Size: 79.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
  
## What is Typesmith
Typesmith is a **typography library** designed for the responsive web. It provides **a set of type sizes** defined in `px` to better align with your design tools (Figma, Sketc, etc.).
The **type sizes names** come from traditional English speaking world:
- Canon *32/36*
- Double Pica *28/32*
- Paragon *26/28*
- Columbian *24*
- Primer *20*
- English *18*
- Pica *16*
- Brevier *14*
- Minion *12*
It uses a custom **Type Scale** starting from the Major Second scale (1.125) rounding up numbers to work well with a 4px baseline.
Canon, Double Pica and Paragon have responsive sizes only.
This is because only the first three sizes used for headlines need to change.
A demo of the "baseline version" is available on [CodePen](https://codepen.io/zetareticoli/pen/vYgxBYG?editors=1100)
## Installation
Install via NPM
```bash
npm i --save typesmith-lib`
```
Import Typesmith in your project:
```scss
// style.scss
@import 'node_modules/typesmith-lib/_typesmith-lib';
```
## Usage
You can use typesmith in two different ways:
1. Using `@type-size` mixin in a selector:
```scss
.foo {
@mixin type-size(canon, medium, ratio)
}
```
2. Use default typesmith classes in HTML:
```html
This is a Headline
```
## Customizations
### 1. Vertical Rhythm
There are two option for vertical rhythm:
- baseline - 4px
- ratio - 1.25
You can customize the vertical rhythm **setting your own custom properties**:
```css
@import '_typesmith.scss'
:root {
--baseline: foo; /* Use size values in px or rem */
--ratio: bar; /* Use a number value, like 1 or 1.5 */
}
```
### 2. Breakpoints
You can control the media-query for three type sizes: Canon, Double Pica, Paragon.
Set the `$bp` variable before the `@import` statement like following:
```scss
// Accepted values: small, medium , large, xlarge
$bp: large;
@import '../_typesmith-lib.scss';
```
See [typesmit.scss](src/typesmith.scss) file as example.
Breakpoints values are defined in [mq](/node_modules/sass-mq-lib/_mq.scss).
## Dependencies
I order to use the libary you will need following tools:
- [mq](https://github.com/zetareticoli/mq)
## Author
[Francesco Improta](https://www.francescoimprota.com)
## License
MIT License
Copyright (c) [2020] [Francesco Improta]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.