forked from baidu/amis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request baidu#9652 from nwind/feat-print-element
feat: 增加打印事件, 支持打印容器组件 Closes baidu#9475
- Loading branch information
Showing
16 changed files
with
267 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import {printElements} from '../utils/printElement'; | ||
| import {RendererEvent} from '../utils/renderer-event'; | ||
| import { | ||
| RendererAction, | ||
| ListenerAction, | ||
| ListenerContext, | ||
| registerAction | ||
| } from './Action'; | ||
|
|
||
| export interface IPrintAction extends ListenerAction { | ||
| actionType: 'copy'; | ||
| args: { | ||
| testid?: string; | ||
| testids?: string[]; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * 打印动作 | ||
| * | ||
| * @export | ||
| * @class PrintAction | ||
| * @implements {Action} | ||
| */ | ||
| export class PrintAction implements RendererAction { | ||
| async run( | ||
| action: IPrintAction, | ||
| renderer: ListenerContext, | ||
| event: RendererEvent<any> | ||
| ) { | ||
| if (action.args?.testid) { | ||
| const element = document.querySelector( | ||
| `[data-testid='${action.args.testid}']` | ||
| ); | ||
| if (element) { | ||
| printElements([element]); | ||
| } | ||
| } else if (action.args?.testids) { | ||
| const elements: Element[] = []; | ||
| action.args.testids.forEach(testid => { | ||
| const element = document.querySelector(`[data-testid='${testid}']`); | ||
| if (element) { | ||
| elements.push(element); | ||
| } | ||
| }); | ||
| printElements(elements); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| registerAction('print', new PrintAction()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /** | ||
| * 打印元素，参考 https://github.com/szepeshazi/print-elements 里的实现 | ||
| * 原理就是遍历节点加上打印样式，然后打印完了再清理掉 | ||
| * 对代码做了改造和优化 | ||
| */ | ||
|
|
||
| const hideFromPrintClass = 'pe-no-print'; | ||
| const preservePrintClass = 'pe-preserve-print'; | ||
| const preserveAncestorClass = 'pe-preserve-ancestor'; | ||
| const bodyElementName = 'BODY'; | ||
|
|
||
| function hide(element: Element) { | ||
| if (!element.classList.contains(preservePrintClass)) { | ||
| element.classList.add(hideFromPrintClass); | ||
| } | ||
| } | ||
|
|
||
| function preserve(element: Element, isStartingElement: boolean) { | ||
| element.classList.remove(hideFromPrintClass); | ||
| element.classList.add(preservePrintClass); | ||
| if (!isStartingElement) { | ||
| element.classList.add(preserveAncestorClass); | ||
| } | ||
| } | ||
|
|
||
| function clean(element: Element) { | ||
| element.classList.remove(hideFromPrintClass); | ||
| element.classList.remove(preservePrintClass); | ||
| element.classList.remove(preserveAncestorClass); | ||
| } | ||
|
|
||
| function walkSiblings(element: Element, callback: (element: Element) => void) { | ||
| let sibling = element.previousElementSibling; | ||
| while (sibling) { | ||
| callback(sibling); | ||
| sibling = sibling.previousElementSibling; | ||
| } | ||
| sibling = element.nextElementSibling; | ||
| while (sibling) { | ||
| callback(sibling); | ||
| sibling = sibling.nextElementSibling; | ||
| } | ||
| } | ||
|
|
||
| function attachPrintClasses(element: Element, isStartingElement: boolean) { | ||
| preserve(element, isStartingElement); | ||
| walkSiblings(element, hide); | ||
| } | ||
|
|
||
| function cleanup(element: Element, isStartingElement: boolean) { | ||
| clean(element); | ||
| walkSiblings(element, clean); | ||
| } | ||
|
|
||
| function walkTree( | ||
| element: Element, | ||
| callback: (element: Element, isStartingElement: boolean) => void | ||
| ) { | ||
| let currentElement: Element | null = element; | ||
| callback(currentElement, true); | ||
| currentElement = currentElement.parentElement; | ||
| while (currentElement && currentElement.nodeName !== bodyElementName) { | ||
| callback(currentElement, false); | ||
| currentElement = currentElement.parentElement; | ||
| } | ||
| } | ||
|
|
||
| export function printElements(elements: Element[]) { | ||
| for (let i = 0; i < elements.length; i++) { | ||
| walkTree(elements[i], attachPrintClasses); | ||
| } | ||
| window.print(); | ||
| for (let i = 0; i < elements.length; i++) { | ||
| walkTree(elements[i], cleanup); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| @media print { | ||
| .pe-no-print { | ||
| display: none !important; | ||
| } | ||
|
|
||
| .pe-preserve-ancestor { | ||
| display: block !important; | ||
| margin: 0 !important; | ||
| padding: 0 !important; | ||
| border: none !important; | ||
| box-shadow: none !important; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.