MatthewHerbst/react-to-print
React To Print
This project is a React print component and utility for rendering specific components or DOM elements into a browser print dialog. It functions as a print layout controller and lifecycle manager, using a hidden iframe to isolate content so that printing does not alter the main page layout.
The tool specializes in copying DOM and Shadow DOM content into a printable window while preserving encapsulated styles. It allows for the injection of custom fonts and CSS to manage page breaks, margins, and orientations for consistent physical paper or PDF output.
The library includes asynchronous lifecycle hooks for updating application state before and after printing, as well as configuration for print iframe attributes and document metadata. It also supports non-browser environments by allowing the standard print method to be replaced with a custom implementation.
Features
- Targeted Element Printing - Enables sending specific DOM content from a component directly to the browser print dialog without affecting the main page.
- Print Pagination Controls - Implements precise control over page breaks, margins, and orientations to ensure correct rendering on physical paper.
- DOM Node Manipulators - Copies target element nodes and styles from the active page into the print window for visual consistency.
- React Components - Provides a React component that renders specific elements into a hidden iframe to trigger the browser print dialog.
- Printable - Sends specific React components to the browser print dialog without affecting the main page layout or visibility.
- Print Isolation Frames - Renders targeted components into a hidden iframe to trigger the browser print dialog without altering the main page layout.
- Print-Optimized Layouts - Generates HTML views specifically styled for physical printing by injecting custom fonts and CSS page styles.
- Print Process Managers - Provides a set of hooks for executing asynchronous logic and updating state immediately before and after the printing process.
- Web Component Print Support - Extracts and renders elements from the Shadow DOM to ensure encapsulated styles are preserved in the printed output.
- Shadow DOM Flattening - Extracts elements from shadow roots and merges them into the print window to render encapsulated web component styles.
- Shadow DOM Printing - Copies elements from Shadow Roots into the print window to ensure encapsulated web component styles are rendered.
- DOM-to-Print Utilities - Copies DOM elements and Shadow DOM content into a printable window with custom styling.
- Print Lifecycle Hooks - Provides asynchronous hooks to execute custom logic and update application state before and after the print process.
- Programmatic PDF Layout Tools - Controls page breaks, margins, and CSS styles to ensure web content renders correctly on physical paper or PDF exports.
- CSS Style Injections - Injects custom stylesheets and font families into the print document head to control margins and page breaks.
- Pluggable Print Implementations - Allows replacing the standard browser print method with a custom function to execute printing tasks in desktop or non-browser environments.
