docs: remove invalid async option from docs (fix #1769) (#1796)

This commit is contained in:
Niklas von Hertzen 2019-04-07 22:16:29 -07:00 committed by GitHub
parent 397595afb5
commit 7775d3c0d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 0 additions and 4 deletions

View File

@ -11,7 +11,6 @@ These are all of the available configuration options.
| Name | Default | Description | | Name | Default | Description |
| ------------- | :------: | ----------- | | ------------- | :------: | ----------- |
| async | `true` | Whether to parse and render the element asynchronously
| allowTaint | `false` | Whether to allow cross-origin images to taint the canvas | allowTaint | `false` | Whether to allow cross-origin images to taint the canvas
| backgroundColor | `#ffffff` | Canvas background color, if none is specified in DOM. Set `null` for transparent | backgroundColor | `#ffffff` | Canvas background color, if none is specified in DOM. Set `null` for transparent
| canvas | `null` | Existing `canvas` element to use as a base for drawing on | canvas | `null` | Existing `canvas` element to use as a base for drawing on

View File

@ -184,7 +184,6 @@ export class DocumentCloner {
return this.renderer( return this.renderer(
documentElement, documentElement,
{ {
async: this.options.async,
allowTaint: this.options.allowTaint, allowTaint: this.options.allowTaint,
backgroundColor: '#ffffff', backgroundColor: '#ffffff',
canvas: null, canvas: null,

View File

@ -8,7 +8,6 @@ import Logger from './Logger';
import {renderElement} from './Window'; import {renderElement} from './Window';
export type Options = { export type Options = {
async: ?boolean,
allowTaint: ?boolean, allowTaint: ?boolean,
backgroundColor: string, backgroundColor: string,
canvas: ?HTMLCanvasElement, canvas: ?HTMLCanvasElement,
@ -50,7 +49,6 @@ const html2canvas = (element: HTMLElement, conf: ?Options): Promise<*> => {
const defaultView = ownerDocument.defaultView; const defaultView = ownerDocument.defaultView;
const defaultOptions = { const defaultOptions = {
async: true,
allowTaint: false, allowTaint: false,
backgroundColor: '#ffffff', backgroundColor: '#ffffff',
imageTimeout: 15000, imageTimeout: 15000,