fix(aio): preserve newlines when copying code

Before 4f37f8643, we were using `innerText` to retrieved the code content for
copying. This preserved the text layout (including newlines), but suffered from
other issues (browser support, performance). With 4f37f8643 we switched to
`textContent`, which works well except in the following case:
When `prettify` formats the code to have line numbers, it removes the newlines
and uses `<li>` elements instead. This affects `textContent`.

This commit fixes this by keeping a reference of the code as text and using that
for copying.

Fixes #17659
This commit is contained in:
Georgios Kalpakas 2017-06-22 00:56:11 +03:00 committed by Matias Niemelä
parent 414c7e956b
commit 87206e1986
2 changed files with 37 additions and 3 deletions

View File

@ -218,7 +218,29 @@ describe('CodeComponent', () => {
const copierService: CopierService = TestBed.get(CopierService);
const spy = spyOn(copierService, 'copyText');
getButton().click();
expect(spy.calls.argsFor(0)[0]).toEqual(oneLineCode, 'after click');
expect(spy.calls.argsFor(0)[0]).toBe(oneLineCode, 'after click');
});
it('should preserve newlines in the copied code', () => {
const copierService: CopierService = TestBed.get(CopierService);
const spy = spyOn(copierService, 'copyText');
const expectedCode = smallMultiLineCode.trim().replace(/&lt;/g, '<').replace(/&gt;/g, '>');
let actualCode;
hostComponent.code = smallMultiLineCode;
[false, true, 42].forEach(linenums => {
hostComponent.linenums = linenums;
fixture.detectChanges();
codeComponent.ngOnChanges();
getButton().click();
actualCode = spy.calls.mostRecent().args[0];
expect(actualCode).toBe(expectedCode, `when linenums=${linenums}`);
expect(actualCode.match(/\r?\n/g).length).toBe(5);
spy.calls.reset();
});
});
it('should display a message when copy succeeds', () => {

View File

@ -51,6 +51,11 @@ export class CodeComponent implements OnChanges {
@Input()
code: string;
/**
* The code to be copied when clicking the copy button, this should not be HTML encoded
*/
private codeText: string;
/**
* set to true if the copy button is not to be shown
*/
@ -116,6 +121,7 @@ export class CodeComponent implements OnChanges {
const linenums = this.getLinenums();
this.setCodeHtml(this.code); // start with unformatted code
this.codeText = this.getCodeText(); // store the unformatted code as text (for copying)
this.pretty.formatCode(this.code, this.language, linenums).subscribe(
formattedCode => this.setCodeHtml(formattedCode),
err => { /* ignore failure to format */ }
@ -128,9 +134,15 @@ export class CodeComponent implements OnChanges {
this.codeContainer.nativeElement.innerHTML = formattedCode;
}
private getCodeText() {
// `prettify` may remove newlines, e.g. when `linenums` are on. Retrieve the content of the
// container as text, before prettifying it.
// We take the textContent because we don't want it to be HTML encoded.
return this.codeContainer.nativeElement.textContent;
}
doCopy() {
// We take the textContent because we don't want it to be HTML encoded
const code = this.codeContainer.nativeElement.textContent.trim();
const code = this.codeText;
if (this.copier.copyText(code)) {
this.logger.log('Copied code to clipboard:', code);
// success snackbar alert