# print-js

> A tiny javascript library to help printing from the web.

Latest version **1.6.0** (published 2021-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install print-js
pnpm add print-js
yarn add print-js
bun add print-js
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2021-02-17 |
| First published | 2017-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 124.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4545 |
| Author | Rodrigo Vieira |
| Maintainers | crabbly |
| Keywords | printjs, print.js, print-js |

## Links

- npm: https://www.npmjs.com/package/print-js
- Repository: https://github.com/crabbly/Print.js
- Homepage: http://printjs.crabbly.com
- Issues: https://github.com/crabbly/Print.js/issues
- npm.io page: https://npm.io/package/print-js

## Recent versions

- 1.6.0 (latest) — 2021-02-17
- 1.5.0 — 2020-10-10
- 1.4.0 — 2020-09-26
- 1.3.1 — 2020-09-19
- 1.3.0 — 2020-09-17
- 1.2.0 — 2020-09-14
- 1.1.1 — 2020-09-09
- 1.1.0 — 2020-09-04
- 1.0.63 — 2019-11-15
- 1.0.62 — 2019-11-15
- 1.0.61 — 2019-05-26
- 1.0.60 — 2019-05-26
- 1.0.59 — 2019-05-25
- 1.0.58 — 2019-05-24
- 1.0.57 — 2019-05-17
- … 39 more at https://npm.io/package/print-js/versions

## README

# Print.js

[![Build Status](https://travis-ci.org/crabbly/Print.js.svg?branch=master)](https://travis-ci.org/crabbly/Print.js)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE)
[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](http://standardjs.com/)
[![npm](https://img.shields.io/npm/v/print-js.svg)](https://www.npmjs.com/package/print-js)

A tiny javascript library to help printing from the web.

> For documentation and examples please visit: [printjs.crabbly.com](http://printjs.crabbly.com)

## Installation

You can download the latest version of Print.js from the [GitHub releases](https://github.com/crabbly/Print.js/releases/latest) or use the [Print.js CDN](http://printjs.crabbly.com/#cdn) available on the documentation page.

To install via npm:

```bash
npm install print-js --save
```

To install via yarn:

```bash
yarn add print-js
```

Import the library into your project:

```js
import printJS from 'print-js'
```

## Documentation

You can find documentation at [printjs.crabbly.com](http://printjs.crabbly.com/#documentation).

## Contributing to Print.js

[![devDependencies Status](https://david-dm.org/crabbly/print.js/dev-status.svg)](https://david-dm.org/crabbly/print.js?type=dev)
[![dependencies Status](https://david-dm.org/crabbly/print.js/status.svg)](https://david-dm.org/crabbly/print.js)

Contributions to Print.js are greatly welcomed and encouraged.

##### Using issues

The [issue tracker](https://github.com/crabbly/Print.js/issues) is the preferred channel for reporting bugs, requesting new features and submitting pull requests.

Keep in mind that we would like to keep this a lightweight library.

Please do not use the issues channel for support requests. For help with using Print.js, please ask questions on Stack Overflow and use the tag `printjs`.

##### Reporting bugs

Well structured, detailed bug reports are hugely valuable for the project.

* Check the issue search to see if it has already been reported.
* Isolate the problem to a simple test case.
* Create a codepen, fiddle, codesandbox or similar online example replicating the issue.

Please provide any additional details associated with the bug.

##### Pull requests

Clear, concise pull requests are excellent at continuing the project's community driven growth.  

Please make your commits in logical sections with clear commit messages.  

##### Setting up a dev environment

```bash
npm install
npm run watch
```

##### Tests

The library is written following the [Javascript Standard](https://standardjs.com) code style. When running tests, we will also test for any style issues or warnings.

Automated tests are written using the [Jasmine](https://jasmine.github.io) framework and [Karma](https://karma-runner.github.io) runner.

To run the automated tests:

```bash
npm run test
```

To manually test the library features:

```bash
npm start
```

This will serve `test\manual\test.html` and open `http://localhost:8080/test/manual` in your default browser.

## License

Print.js is available under the [MIT license](https://github.com/crabbly/Print.js/blob/master/LICENSE).

---
_Source: https://npm.io/package/print-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._