Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stormwarning/tailwindcss-capsize
✂️ Tailwind CSS utility classes for trimming whitespace above & below capital letters.
https://github.com/stormwarning/tailwindcss-capsize
capsize hacktoberfest leading-trim tailwindcss-plugin typography
Last synced: about 2 months ago
JSON representation
✂️ Tailwind CSS utility classes for trimming whitespace above & below capital letters.
- Host: GitHub
- URL: https://github.com/stormwarning/tailwindcss-capsize
- Owner: stormwarning
- License: isc
- Created: 2020-08-10T21:19:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T08:49:15.000Z (2 months ago)
- Last Synced: 2024-07-27T09:50:02.143Z (2 months ago)
- Topics: capsize, hacktoberfest, leading-trim, tailwindcss-plugin, typography
- Language: TypeScript
- Homepage:
- Size: 771 KB
- Stars: 91
- Watchers: 3
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-tailwindcss - Leading Trim - Adds utilities to trim text whitespace, using [Capsize](https://github.com/seek-oss/capsize). (Plugins)
README
# tailwindcss-capsize
[![npm version][npm-img]][npm-url]
> A TailwindCSS plugin that generates leading-trim utility classes using [Capsize](https://github.com/seek-oss/capsize).
```bash
npm install --save-dev tailwindcss-capsize
```
## leading-trim?
A [proposed CSS property](https://www.w3.org/TR/css-inline-3/#leading-trim) to remove the extra space from text bounding boxes, which affects optical alignment. This [article from Microsoft Design][] outlines the problem and how the proposed solution works.
## Configuration
This plugin requires a `fontMetrics` key added to your Tailwind theme. It should be an object with keys matching those in your `fontFamily` definitions, and each key should have an object of the following shape:
```ts
{
ascent: number
descent: number
lineGap: number
unitsPerEm: number
capHeight: number
}
```
These values can be determined by using the [Capsize website](https://seek-oss.github.io/capsize/), [fontkit](https://github.com/foliojs/fontkit), [FontDrop!](https://fontdrop.info), or some other means.
### A full example
```js
// tailwind.config.js
module.exports = {
theme: {
fontFamily: {
sans: ['Inter', 'sans-serif'],
},
fontMetrics: {
sans: {
capHeight: 2048,
ascent: 2728,
descent: -680,
lineGap: 0,
unitsPerEm: 2816,
},
},
fontSize: { ... },
lineHeight: { ... },
...
},
plugins: [require('tailwindcss-capsize')],
}
```
## Usage
The new `.capsize` utility class should be applied to the _direct parent_ element surrounding a text node. This class requires `font-family`, `font-size`, and `line-height` utilities to be applied at some point above it in the cascade in order for the required custom properties to be available.
```html
Lorem ipsum dolor
```
## Options
### rootSize
#### type: `number` (optional, default: `16`)
The plugin assumes a root font-size of `16px` when converting from rem values. To use a different value, pass it in (without units) to the plugin options.
```js
require('tailwindcss-capsize')({ rootSize: 12 })
```
### className
#### type: `string` (optional, default: `'capsize'`)
The default `.capsize` utility class can be replaced with a custom class name if preferred.
```js
require('tailwindcss-capsize')({ className: 'leading-trim' })
```
### mode
#### type: `'modern' | 'classic'` (optional, default: `'modern'`)
By default the plugin replaces the `fontFamily`, `fontSize`, and `lineHeight` core plugins, adding custom properties to the output of each which are used in the `calc()` expressions in the utility class.
```diff
.font-sans {
+ --ascent-scale: 0.9688;
+ --descent-scale: 0.2415;
+ --cap-height-scale: 0.7273;
+ --line-gap-scale: 0;
+ --line-height-scale: 1.2102;
font-family: Inter, sans-serif;
}
```
If you need to support browsers that don’t support custom properties, setting `mode` to `'classic'` will handle all the calculation at build-time before the CSS is output. This will require that the markup matches a specific selector format.
```js
require('tailwindcss-capsize')({ mode: 'classic' })
```
## Tips and tricks
### Text truncation and line clamping
Sometimes an interface calls for truncating text to a single line or clamping text to a specified number of lines. Applying these methods to the same element that the default `.capsize` class is applied to will cause issues since the class assigns pseudo `::before` and `::after` elements to that element.
```html
Text to be truncated to a single line
```
To solve this, a child element to the element with the `.capsize` class should wrap the text. This element should receive the styling to truncate or line clamp.
```html
Text to be truncated to a single line
```
## Related
[🔡 tailwindcss-opentype](https://github.com/stormwarning/tailwindcss-opentype) — Utility classes for advanced typographic features.
[npm-url]: https://www.npmjs.com/package/tailwindcss-capsize
[npm-img]: https://img.shields.io/npm/v/tailwindcss-capsize.svg?style=flat-square
[article from microsoft design]: https://medium.com/microsoft-design/leading-trim-the-future-of-digital-typesetting-d082d84b202