如何在TypeScript中通过按钮点击实现React组件打印
React+TypeScript 实现组件打印的可落地方案
方案1:零依赖原生实现(无额外包安装)
核心逻辑
通过ref获取需要打印的组件DOM节点,将节点内容注入到页面上隐藏的隔离iframe中,调用iframe的打印API触发打印,从根源避免打印整个页面内容、丢样式的问题,全程适配TS类型检查。
完整可运行代码
import { useRef } from 'react' const PrintDemo = () => { // TS标注:ref绑定div元素时,泛型写HTMLDivElement,初始值为null const printableRef = useRef<HTMLDivElement>(null) // 打印触发函数,TS标注按钮事件类型 const handleClickPrint = () => { // 先做空值判断,避免TS报“可能为null”的类型错误 if (!printableRef.current) return // 创建隐藏的打印iframe,TS类型为HTMLIFrameElement const printFrame = document.createElement('iframe') // iframe完全隐藏,不干扰当前页面操作 Object.assign(printFrame.style, { position: 'fixed', right: '0', bottom: '0', width: '0', height: '0', border: 'none' }) document.body.appendChild(printFrame) // 获取iframe的文档对象,做空值兼容判断 const frameDoc = printFrame.contentWindow?.document if (!frameDoc) return // 把需要打印的DOM内容写入iframe,此处可按需注入组件依赖的全局样式 frameDoc.open() frameDoc.write(` <html> <head> <title>组件打印</title> <!-- 比如用了Ant Design等UI库,可在此处引入对应的样式link,避免打印丢样式 --> </head> <body> ${printableRef.current.innerHTML} </body> </html> `) frameDoc.close() // 等iframe内容完全加载后再触发打印,避免内容为空就弹打印框 printFrame.onload = () => { printFrame.contentWindow?.focus() printFrame.contentWindow?.print() // 打印完成后移除iframe,避免内存泄漏 printFrame.remove() } } return ( <div className="page-wrapper"> {/* 普通页面内容,不会被打印 */} <div>页面上的导航、侧边栏等无关内容</div> {/* 需要打印的组件块,绑定刚才声明的ref */} <div ref={printableRef}> <h1>需要打印的报表内容</h1> <p>包含文本、表格、图片的组件都会完整输出</p> </div> {/* 触发打印的按钮 */} <button onClick={handleClickPrint}>打印目标组件</button> </div> ) } export default PrintDemo
新手必看TS适配注意点
- ref的泛型必须和绑定的真实DOM元素类型匹配:绑div就写
HTMLDivElement,绑table就写HTMLTableElement,不要笼统写HTMLElement,否则TS会提示不存在对应DOM属性 - 所有DOM节点、iframe对象的读取必须做空值判断,不要图省事加非空断言
!,养成判空习惯能减少很多线上bug - 如果自定义组件要绑定ref,必须用
forwardRef把ref透传到内部的真实DOM节点,否则TS识别不到DOM类型,ref会一直为null
方案2:轻量库快速实现(适合复杂打印场景)
如果不想自己处理iframe的兼容、样式注入逻辑,可以使用专门适配TS的打印类库,库本身自带完整类型声明,不需要自己写类型定义。
实现步骤
- 安装依赖包:
npm install react-to-print - 参考示例代码接入:
import { useRef, forwardRef } from 'react' import ReactToPrint from 'react-to-print' // 把需要打印的内容抽成独立组件,用forwardRef接收父组件透传的ref const PrintableBlock = forwardRef<HTMLDivElement>((_, ref) => { return ( <div ref={ref}> <h2>打印的核心内容</h2> <p>支持复杂表格、自定义样式的内容输出</p> </div> ) }) const PrintPage = () => { const blockRef = useRef<HTMLDivElement>(null) return ( <div> <div>页面非打印区域的内容</div> <PrintableBlock ref={blockRef} /> {/* 配置打印触发按钮、内容来源 */} <ReactToPrint trigger={() => <button>一键打印</button>} content={() => blockRef.current} // 可自定义打印页的样式 pageStyle="font-size: 14px; padding: 20px;" /> </div> ) } export default PrintPage
方案优势
- 全流程TS类型校验,不需要手动处理iframe的创建、销毁、浏览器兼容问题
- 支持打印前后的回调钩子,比如打印前弹出加载提示,打印完成后关闭弹窗
- 自动处理UI库的样式注入,减少手动排查样式丢失的工作量
常见踩坑说明
- 打印内容丢失样式:因为打印用的是隔离iframe环境,全局CSS、第三方UI库的样式不会自动注入,需要手动把对应样式写入iframe的head部分,或通过库的配置项传入
- 打印时输出了整个页面:不要直接调用
window.print(),这个API会打印整个浏览器视口的内容,必须用隔离iframe的方式指定打印范围 - TS报ref类型不匹配:检查是不是把ref直接绑在了自定义组件上,没有用
forwardRef透传到真实DOM节点
内容的提问来源于stack exchange,提问作者Shivam Prakash
相关产品推荐
相关产品推荐

