https://github.com/rpdasilva/print-html-element

Prints the HTML of a provided element.
https://github.com/rpdasilva/print-html-element

Last synced: 2 months ago
JSON representation

Prints the HTML of a provided element.

• Host: GitHub
• URL: https://github.com/rpdasilva/print-html-element
• Owner: rpdasilva
• License: mit
• Created: 2015-06-15T16:04:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-16T08:57:47.000Z (over 5 years ago)
• Last Synced: 2024-03-24T14:01:19.295Z (3 months ago)
• Language: JavaScript
• Size: 41 KB
• Stars: 24
• Watchers: 4
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Lists

• awesome - print-html-element - Prints the HTML of a provided element. (JavaScript)

README

        
# Print HTML Element

Prints the HTML of a provided element.

Originally forked from [jQuery.printElement](https://github.com/erikzaadi/jQueryPlugins/tree/master/jQuery.printElement) to remove jQuery dependency.

This fork removes some features while adding others (IE8 support is also removed for now). More features will be added as needed or requested.

PR's welcome.

View examples [here](https://rpdasilva.github.io/print-html-element/)

## Installation

Print HTML Element is available on both NPM and Bower.

`npm install print-html-element`

`bower install print-html-element`

## Usage

### Include

In a CommonJS module system via Browserify or Webpack

```js

    var PHE = require("print-html-element");

```

Good old-fashioned way

```html

    

```

```js

    // Alias global variable printHtmlElement for purposes of example

    var PHE = printHtmlElement;

```

### Examples

View examples [here](https://rpdasilva.github.io/print-html-element/)

```js

    PHE.printElement( document.getElementById('toPrint') );

    PHE.printHtml('
Let\'s print this h1
');


    PHE.printHtml('
Let\'s print this h1
', {templateString: 'I\'m part of the template header{{printBody}}I\'m part of the template footer'});

```


An HTML class `pe-body` is also added to the body of the print area which can be used as an additional style hook (on top of the regular print media query/stylesheet)

### Options and methods supported

```js

    opts = {

        printMode: string;

        pageTitle: string;

        templateString: string;

        popupProperties: string;

        stylesheets: string | string[];

        styles: string | string[];

    };

    PHE.printElement( elem, opts ); // Prints a DOM Element

    PHE.printHtml( str, opts ); // Prints an HTML string

```

- printMode determines which method is used to print. As a hidden `iframe` (default), or `popup` window

- pageTitle sets the printed page title (defaults to blank)

- templateString allows you to define a template that the html will be printed within.

    - Use `{{printBody}}` within the template to signify where the HTML should be injected

- popupProperties set the window features (such as `menubar`, `scrollbars`, etc. in `popup` mode

- stylesheets overrides parsed `link` tags and instead injects `link` tags with hrefs specified as either a single string or array of strings

- styles overrides parsed `style` tags and instead injects `style` blocks specified as either a single string or array of strings

## Possible future features

- Integrate a template system (such as handlebars)

- Support multiple and/or custom template variables

- Support for multiple elements/HTML strings

- Promise/callback support

## License

`print-html-element` is [MIT licensed](LICENSE.txt)