Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 1.21 KB

README.md

File metadata and controls

32 lines (17 loc) · 1.21 KB

typographic-underline-canvas

js-standard-style npm version

Typographically correct underline for the web.

This project was inspired by underline.js and smart-underline.

This library includes the NPM packages detect-zoom and font-baseline.

Note: Experimental code, use at own risk!

Note: Comments, PRs etc. are very welcome.

Usage

Package uses UMD pattern, to include it require('typographic-underline-canvas') or use window.TypographicUnderline.

Instantiate with selector or document element:

var myUnderlineInstance = new TypographicUnderline('.my-underline-selector')

For documentation on available options check out src/index.js (comments may be out of date)

Development

npm start for serving example html file on localhost:3000 and running watch tasks.

npm format to format code base.