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

// Type definitions for compass-vertical-rhythm 1.4
// Project: https://github.com/KyleAMathews/compass-vertical-rhythm
// Definitions by: Luis Rodrigues <https://github.com/goblindegook>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

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: Thu, 08 Jul 2021 09:08:05 GMT
Dependencies: none
Global values: none

Credits

These definitions were written by Luis Rodrigues.

Current Tags

3 Versions

1.4.2 ... 5 years ago
1.4.1 ... 6 years ago
1.4.0 ... 7 years ago