react-to-print
- Version 2.15.1
- Published
- 55.6 kB
- No dependencies
- MIT license
Install
npm i react-to-print
yarn add react-to-print
pnpm add react-to-print
Overview
Print React components in the browser
Index
Variables
Functions
Classes
Interfaces
Variables
variable PrintContextConsumer
const PrintContextConsumer: any;
Functions
function useReactToPrint
useReactToPrint: (props: IReactToPrintProps) => UseReactToPrintHookReturn;
Classes
class ReactToPrint
class ReactToPrint extends React.Component<IReactToPrintProps> {}
property defaultProps
static defaultProps: { copyStyles: boolean; pageStyle: string; removeAfterPrint: boolean; suppressErrors: boolean;};
property handlePrint
handlePrint: (optionalContent?: () => React.ReactInstance | null) => void;
property handleRemoveIframe
handleRemoveIframe: (force?: boolean) => void;
property logMessages
logMessages: ( messages: unknown[], level?: 'error' | 'warning' | 'debug') => void;
property startPrint
startPrint: (target: HTMLIFrameElement) => void;
property triggerPrint
triggerPrint: (target: HTMLIFrameElement) => void;
method handleClick
handleClick: ( _event?: unknown, content?: () => React.ReactInstance | null) => void;
method render
render: () => React.JSX.Element | null;
Interfaces
interface IPrintContextProps
interface IPrintContextProps {}
property handlePrint
handlePrint: ( event?: unknown, content?: () => React.ReactInstance | null) => void;
interface IReactToPrintProps
interface IReactToPrintProps {}
property bodyClass
bodyClass?: string;
property children
children?: React.ReactNode;
property content
content?: () => React.ReactInstance | null;
property copyStyles
copyStyles?: boolean;
property documentTitle
documentTitle?: string;
property fonts
fonts?: Font[];
property nonce
nonce?: string;
property onAfterPrint
onAfterPrint?: () => void;
property onBeforeGetContent
onBeforeGetContent?: () => void | Promise<any>;
property onBeforePrint
onBeforePrint?: () => void | Promise<any>;
property onPrintError
onPrintError?: ( errorLocation: 'onBeforeGetContent' | 'onBeforePrint' | 'print', error: Error) => void;
property pageStyle
pageStyle?: string | (() => string);
property print
print?: (target: HTMLIFrameElement) => Promise<any>;
property removeAfterPrint
removeAfterPrint?: boolean;
property suppressErrors
suppressErrors?: boolean;
property trigger
trigger?: <T>() => React.ReactElement<ITriggerProps<T>>;
interface ITriggerProps
interface ITriggerProps<T> {}
Package Files (5)
Dependencies (0)
No dependencies.
Dev Dependencies (23)
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-to-print
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-to-print)
- HTML<a href="https://www.jsdocs.io/package/react-to-print"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3470 ms. - Missing or incorrect documentation? Open an issue for this package.