# @types/compass-vertical-rhythm

> TypeScript definitions for compass-vertical-rhythm

Latest version **1.4.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/compass-vertical-rhythm
pnpm add @types/compass-vertical-rhythm
yarn add @types/compass-vertical-rhythm
bun add @types/compass-vertical-rhythm
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.5 |
| Published | 2023-11-07 |
| First published | 2019-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/compass-vertical-rhythm
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/compass-vertical-rhythm
- npm.io page: https://npm.io/package/@types/compass-vertical-rhythm

## Recent versions

- 1.4.5 (latest) — 2023-11-07
- 1.4.3 (ts4.3) — 2023-09-04
- 1.4.2 (ts3.6) — 2021-07-08
- 1.4.1 (ts3.0) — 2020-05-14
- 1.4.0 (ts2.1) — 2019-09-27
- 1.4.4 — 2023-10-18

## README

# Installation
> `npm install --save @types/compass-vertical-rhythm`

# Summary
This package contains type definitions for compass-vertical-rhythm (https://github.com/KyleAMathews/compass-vertical-rhythm).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/compass-vertical-rhythm.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/compass-vertical-rhythm/index.d.ts)
````ts
export = compassVerticalRhythm;

declare namespace compassVerticalRhythm {
    interface Options {
        baseFontSize?: string | undefined;
        baseLineHeight?: number | string | undefined;
        rhythmUnit?: "%" | "em" | "ex" | "ch" | "px" | "rem" | "vw" | "vh" | "vmin" | undefined;
        defaultRhythmBorderWidth?: string | undefined;
        defaultRhythmBorderStyle?:
            | "solid"
            | "none"
            | "hidden"
            | "dashed"
            | "dotted"
            | "double"
            | "groove"
            | "ridge"
            | "inset"
            | "outset"
            | undefined;
        roundToNearestHalfLine?: boolean | undefined;
        minLinePadding?: string | undefined;
    }

    interface VerticalRhythmStyles {
        fontSize: string;
        lineHeight: string;
    }

    interface VerticalRhythm {
        rhythm(lines?: number, fontSize?: string, offset?: number): number;
        establishBaseline(): VerticalRhythmStyles;
        linesForFontSize(fontSize: string): number;
        adjustFontSizeTo(toSize: string, lines?: number | "auto" | null, fromSize?: string): VerticalRhythmStyles;
    }
}

declare function compassVerticalRhythm(
    options: compassVerticalRhythm.Options,
): compassVerticalRhythm.VerticalRhythm;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Luis Rodrigues](https://github.com/goblindegook).

---
_Source: https://npm.io/package/@types/compass-vertical-rhythm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._